type Function (v201809)

Service
AdGroupFeedService CampaignCriterionService CampaignFeedService CustomerFeedService
Dependencies
CustomerFeed FunctionOperand
▼
Function

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)));
Namespace
https://adwords.google.com/api/adwords/cm/v201809

Field

operator

Function.Operator

Operator for a function.

Enumerations
IN
The IN operator.
IDENTITY
The IDENTITY operator.
EQUALS
The EQUALS operator
AND
Operator that takes two or more operands that are of type FunctionOperand and checks that all the operands evaluate to true. For functions related to ad formats, all the operands must be in lhsOperand. Return ConstantOperand with Bool type.
CONTAINS_ANY
Operator that returns true if the elements in lhsOperand contains any of the elements in rhsOperands. Otherwise, return false.
UNKNOWN

This field is required and should not be null.

lhsOperand

  1. FunctionArgumentOperand[]
    1. ConstantOperand
    2. FeedAttributeOperand
    3. FunctionOperand
    4. RequestContextOperand

Operand on the LHS in the equation. This is also the operand to be used for single operand expressions such as NOT.

The minimum size of this collection is 1.

rhsOperand

  1. FunctionArgumentOperand[]
    1. ConstantOperand
    2. FeedAttributeOperand
    3. FunctionOperand
    4. RequestContextOperand

Operand on the RHS of the equation.

functionString

xsd:string

String representation of the Function.

For mutate actions, this field can be set instead of the operator, lhsOperand, and rhsOperand fields. This field will be parsed and used to populate the other fields.

When Function objects are returned from get or mutate calls, this field contains the string representation of the Function. Note that because multiple strings may map to the same Function (whitespace and single versus double quotation marks, for example), the value returned may not be identical to the string sent in the request.