Share your feedback about the AdWords API! Take our annual survey.

type Predicate (v201809)

Specifies how an entity (eg. adgroup, campaign, criterion, ad) should be filtered.


Namespace
https://adwords.google.com/api/adwords/cm/v201809

Field

field

xsd:string

The field by which to filter the returned data. Possible values are marked Filterable on the entity's reference page. For example, for predicates for the CampaignService selector, refer to the filterable fields from the Campaign reference page.

This field is required and should not be null.

operator

Predicate.Operator

The operator to use for filtering the data returned.


Enumerations
EQUALS
Checks if the field is equal to the given value.

This operator is used with integers, dates, booleans, strings, enums, and sets.

NOT_EQUALS
Checks if the field does not equal the given value.

This operator is used with integers, booleans, strings, enums, and sets.

IN
Checks if the field is equal to one of the given values.

This operator accepts multiple operands and is used with integers, booleans, strings, and enums.

NOT_IN
Checks if the field does not equal any of the given values.

This operator accepts multiple operands and is used with integers, booleans, strings, and enums.

GREATER_THAN
Checks if the field is greater than the given value.

This operator is used with numbers and dates.

GREATER_THAN_EQUALS
Checks if the field is greater or equal to the given value.

This operator is used with numbers and dates.

LESS_THAN
Checks if the field is less than the given value.

This operator is used with numbers and dates.

LESS_THAN_EQUALS
Checks if the field is less or equal to than the given value.

This operator is used with numbers and dates.

STARTS_WITH
Checks if the field starts with the given value.

This operator is used with strings.

STARTS_WITH_IGNORE_CASE
Checks if the field starts with the given value, ignoring case.

This operator is used with strings.

CONTAINS
Checks if the field contains the given value as a substring.

This operator is used with strings.

CONTAINS_IGNORE_CASE
Checks if the field contains the given value as a substring, ignoring case.

This operator is used with strings.

DOES_NOT_CONTAIN
Checks if the field does not contain the given value as a substring.

This operator is used with strings.

DOES_NOT_CONTAIN_IGNORE_CASE
Checks if the field does not contain the given value as a substring, ignoring case.

This operator is used with strings.

CONTAINS_ANY
Checks if the field contains any of the given values.

This operator accepts multiple values and is used on sets of numbers or strings.

CONTAINS_ALL
Checks if the field contains all of the given values.

This operator accepts multiple values and is used on sets of numbers or strings.

CONTAINS_NONE
Checks if the field contains none of the given values.

This operator accepts multiple values and is used on sets of numbers or strings.

UNKNOWN

This field is required and should not be null.

values

xsd:string[]

The values by which to filter the field. The Operator.CONTAINS_ALL, Operator.CONTAINS_ANY, Operator.CONTAINS_NONE, Operator.IN and Operator.NOT_IN take multiple values. All others take a single value.

This field must not contain null elements.
This field is required and should not be null.

Send feedback about...

AdWords API
AdWords API
Need help? Visit our support page.