com.google.api.ads.adwords.jaxws.v201809.cm

Class Function

java.lang.Object

com.google.api.ads.adwords.jaxws.v201809.cm.Function

public class Function
extends Object

Represents a function where its operator is applied to its argument operands resulting in a return value. It has the form (Operand... Operator Operand...). The type of the return value depends on the operator being applied and the type of the operands.

Operands per function is limited to 20.

Here is a code example:

             
             // For example "feed_attribute == 30" can be represented as:
             FeedId feedId = (FeedId of Feed associated with feed_attribute)
             FeedAttributeId feedAttributeId = (FeedAttributeId of feed_attribute)
             Function function = new Function();
             function.setLhsOperand(
             Arrays.asList((Operand) new FeedAttributeOperand(feedId, feedAttributeId)));
             function.setOperator(Operator.IN);
             function.setRhsOperand(
             Arrays.asList((Operand) new ConstantOperand(30L)));
             
             // Another example matching on multiple values:
             "feed_item_id IN (10, 20, 30)" can be represented as:
             
             Function function = new Function();
             function.setLhsOperand(
             Arrays.asList((Operand) new RequestContextOperand(ContextType.FEED_ITEM_ID)));
             function.setOperator(Operator.IN);
             function.setRhsOperand(Arrays.asList(
             (Operand) new ConstantOperand(10L), new ConstantOperand(20L), new ConstantOperand(30L)));
             

Java class for Function complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="Function">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="operator" type="{https://adwords.google.com/api/adwords/cm/v201809}Function.Operator" minOccurs="0"/>
         <element name="lhsOperand" type="{https://adwords.google.com/api/adwords/cm/v201809}FunctionArgumentOperand" maxOccurs="unbounded" minOccurs="0"/>
         <element name="rhsOperand" type="{https://adwords.google.com/api/adwords/cm/v201809}FunctionArgumentOperand" maxOccurs="unbounded" minOccurs="0"/>
         <element name="functionString" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected String	functionString
protected List<FunctionArgumentOperand>	lhsOperand
protected FunctionOperator	operator
protected List<FunctionArgumentOperand>	rhsOperand

Constructor Summary

Constructors

Constructor and Description
Function()

Method Summary

Modifier and Type	Method and Description
String	getFunctionString() Gets the value of the functionString property.
List<FunctionArgumentOperand>	getLhsOperand() Gets the value of the lhsOperand property.
FunctionOperator	getOperator() Gets the value of the operator property.
List<FunctionArgumentOperand>	getRhsOperand() Gets the value of the rhsOperand property.
void	setFunctionString(String value) Sets the value of the functionString property.
void	setOperator(FunctionOperator value) Sets the value of the operator property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

operator

protected FunctionOperator operator

lhsOperand

protected List<FunctionArgumentOperand> lhsOperand

rhsOperand

protected List<FunctionArgumentOperand> rhsOperand

functionString

protected String functionString

Constructor Detail

Function

public Function()

Method Detail

getOperator

public FunctionOperator getOperator()

Gets the value of the operator property.

Returns:

possible object is FunctionOperator

setOperator

public void setOperator(FunctionOperator value)

Sets the value of the operator property.

Parameters:

value - allowed object is FunctionOperator

getLhsOperand

public List<FunctionArgumentOperand> getLhsOperand()

Gets the value of the lhsOperand property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the lhsOperand property.

For example, to add a new item, do as follows:

    getLhsOperand().add(newItem);
 

Objects of the following type(s) are allowed in the list FunctionArgumentOperand

getRhsOperand

public List<FunctionArgumentOperand> getRhsOperand()

Gets the value of the rhsOperand property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the rhsOperand property.

For example, to add a new item, do as follows:

    getRhsOperand().add(newItem);
 

Objects of the following type(s) are allowed in the list FunctionArgumentOperand

getFunctionString

public String getFunctionString()

Gets the value of the functionString property.

Returns:

possible object is String

setFunctionString

public void setFunctionString(String value)

Sets the value of the functionString property.

Parameters:

value - allowed object is String