type Statement (v202505)

  • A Statement object is used to capture WHERE, ORDER BY, and LIMIT clauses for PQL queries.

  • Statements are typically used to retrieve predefined domain types, eliminating the need for a SELECT clause.

  • Statements support the use of bind variables and the LIKE keyword for wildcard string matching.

  • Bind variables are defined using a colon prefix (e.g., :idValue) and their literal values are set with Value objects like NumberValue, TextValue, or BooleanValue.

  • The query field holds the PQL query string, while the values field contains a list of String_ValueMapEntry objects mapping bind variable names to their literal values.
Service
AdRuleService AdjustmentService AudienceSegmentService CdnConfigurationService CmsMetadataService CompanyService ContactService ContentBundleService ContentService CreativeService CreativeSetService CreativeTemplateService CreativeWrapperService CustomFieldService CustomTargetingService DaiAuthenticationKeyService DaiEncodingProfileService InventoryService LabelService LineItemCreativeAssociationService LineItemService LineItemTemplateService LiveStreamEventService MobileApplicationService NativeStyleService OrderService PlacementService ProposalLineItemService ProposalService PublisherQueryLanguageService ReportService SiteService StreamActivityMonitorService SuggestedAdUnitService TargetingPresetService TeamService UserService UserTeamAssociationService YieldGroupService
Dependencies
getLiveStreamEventsByStatem... getSlatesByStatement() performLiveStreamEventAction() performSlateAction()
▼
Statement

Captures the WHERE, ORDER BY and LIMIT clauses of a PQL query. Statements are typically used to retrieve objects of a predefined domain type, which makes SELECT clause unnecessary.

An example query text might be "WHERE status = 'ACTIVE' ORDER BY id LIMIT 30".

Statements support bind variables. These are substitutes for literals and can be thought of as input parameters to a PQL query.

An example of such a query might be "WHERE id = :idValue".

Statements also support use of the LIKE keyword. This provides wildcard string matching.

An example of such a query might be "WHERE name LIKE '%searchString%'".

The value for the variable idValue must then be set with an object of type Value, e.g., NumberValue, TextValue or BooleanValue.
Namespace
https://www.google.com/apis/ads/publisher/v202505

Field

query

xsd:string

Holds the query in PQL syntax. The syntax is:
[WHERE <condition> {[AND | OR] <condition> ...}]
[ORDER BY <property> [ASC | DESC]]
[LIMIT {[<offset>,] <count>} | {<count> OFFSET <offset>}]

<condition>
     := <property> {< | <= | > | >= | = | != } <value>
<condition>
     := <property> {< | <= | > | >= | = | != } <bind variable>
<condition> := <property> IN <list>
<condition> := <property> IS NULL
<condition> := <property> LIKE <wildcard%match>
<bind variable> := :<name>

values

String_ValueMapEntry[]

Holds keys and values for bind variables and their values. The key is the name of the bind variable. The value is the literal value of the variable.

In the example "WHERE status = :bindStatus ORDER BY id LIMIT 30", the bind variable, represented by :bindStatus is named bindStatus, which would also be the parameter map key. The bind variable's value would be represented by a parameter map value of type TextValue. The final result, for example, would be an entry of "bindStatus" => StringParam("ACTIVE").