type Statement (v202408)
Stay organized with collections
Save and categorize content based on your preferences.
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/v202408
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") .
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-06 UTC.
[null,null,["Last updated 2025-08-06 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eStatement\u003c/code\u003e object defines the \u003ccode\u003eWHERE\u003c/code\u003e, \u003ccode\u003eORDER BY\u003c/code\u003e, and \u003ccode\u003eLIMIT\u003c/code\u003e clauses for querying objects within the Google Ad Manager API.\u003c/p\u003e\n"],["\u003cp\u003eIt uses Publisher Query Language (PQL) syntax for constructing queries.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eStatement\u003c/code\u003e supports bind variables for parameterized queries and the \u003ccode\u003eLIKE\u003c/code\u003e keyword for wildcard matching.\u003c/p\u003e\n"],["\u003cp\u003eIt has two main fields: \u003ccode\u003equery\u003c/code\u003e to hold the PQL query string and \u003ccode\u003evalues\u003c/code\u003e to store bind variable key-value pairs.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003evalues\u003c/code\u003e field uses \u003ccode\u003eString_ValueMapEntry\u003c/code\u003e objects to associate bind variable names with their corresponding values, which can be of various types like \u003ccode\u003eTextValue\u003c/code\u003e, \u003ccode\u003eNumberValue\u003c/code\u003e, or \u003ccode\u003eBooleanValue\u003c/code\u003e.\u003c/p\u003e\n"]]],["The provided content details various services for ad management, including `AdRuleService`, `AdjustmentService`, and others. These services manage diverse aspects like content, creatives, inventory, and user data. It also describes the `Statement`, used for PQL queries, containing `WHERE`, `ORDER BY`, and `LIMIT` clauses. Statements support bind variables, and wildcard string matching via `LIKE`. The `query` field holds the PQL syntax, while `values` contains key-value pairs for bind variables. Also it provides `getSuggestedAdUnitsByStatement` and `performSuggestedAdUnitAction`.\n"],null,["# type Statement (v202408)\n\n**Service** \n[AdRuleService](/ad-manager/api/reference/v202408/AdRuleService.Statement) [AdjustmentService](/ad-manager/api/reference/v202408/AdjustmentService.Statement) [AudienceSegmentService](/ad-manager/api/reference/v202408/AudienceSegmentService.Statement) [CdnConfigurationService](/ad-manager/api/reference/v202408/CdnConfigurationService.Statement) [CmsMetadataService](/ad-manager/api/reference/v202408/CmsMetadataService.Statement) [CompanyService](/ad-manager/api/reference/v202408/CompanyService.Statement) [ContactService](/ad-manager/api/reference/v202408/ContactService.Statement) [ContentBundleService](/ad-manager/api/reference/v202408/ContentBundleService.Statement) [ContentService](/ad-manager/api/reference/v202408/ContentService.Statement) [CreativeService](/ad-manager/api/reference/v202408/CreativeService.Statement) [CreativeSetService](/ad-manager/api/reference/v202408/CreativeSetService.Statement) [CreativeTemplateService](/ad-manager/api/reference/v202408/CreativeTemplateService.Statement) [CreativeWrapperService](/ad-manager/api/reference/v202408/CreativeWrapperService.Statement) [CustomFieldService](/ad-manager/api/reference/v202408/CustomFieldService.Statement) [CustomTargetingService](/ad-manager/api/reference/v202408/CustomTargetingService.Statement) [DaiAuthenticationKeyService](/ad-manager/api/reference/v202408/DaiAuthenticationKeyService.Statement) [DaiEncodingProfileService](/ad-manager/api/reference/v202408/DaiEncodingProfileService.Statement) [InventoryService](/ad-manager/api/reference/v202408/InventoryService.Statement) [LabelService](/ad-manager/api/reference/v202408/LabelService.Statement) [LineItemCreativeAssociationService](/ad-manager/api/reference/v202408/LineItemCreativeAssociationService.Statement) [LineItemService](/ad-manager/api/reference/v202408/LineItemService.Statement) [LineItemTemplateService](/ad-manager/api/reference/v202408/LineItemTemplateService.Statement) [LiveStreamEventService](/ad-manager/api/reference/v202408/LiveStreamEventService.Statement) [MobileApplicationService](/ad-manager/api/reference/v202408/MobileApplicationService.Statement) [NativeStyleService](/ad-manager/api/reference/v202408/NativeStyleService.Statement) [OrderService](/ad-manager/api/reference/v202408/OrderService.Statement) [PlacementService](/ad-manager/api/reference/v202408/PlacementService.Statement) [ProposalLineItemService](/ad-manager/api/reference/v202408/ProposalLineItemService.Statement) [ProposalService](/ad-manager/api/reference/v202408/ProposalService.Statement) [PublisherQueryLanguageService](/ad-manager/api/reference/v202408/PublisherQueryLanguageService.Statement) [ReportService](/ad-manager/api/reference/v202408/ReportService.Statement) [SiteService](/ad-manager/api/reference/v202408/SiteService.Statement) [StreamActivityMonitorService](/ad-manager/api/reference/v202408/StreamActivityMonitorService.Statement) **SuggestedAdUnitService** [TargetingPresetService](/ad-manager/api/reference/v202408/TargetingPresetService.Statement) [TeamService](/ad-manager/api/reference/v202408/TeamService.Statement) [UserService](/ad-manager/api/reference/v202408/UserService.Statement) [UserTeamAssociationService](/ad-manager/api/reference/v202408/UserTeamAssociationService.Statement) [YieldGroupService](/ad-manager/api/reference/v202408/YieldGroupService.Statement) **Dependencies** \n[getSuggestedAdUnitsByStatem...](/ad-manager/api/reference/v202408/SuggestedAdUnitService#getSuggestedAdUnitsByStatement \"getSuggestedAdUnitsByStatement()\") [performSuggestedAdUnitAction()](/ad-manager/api/reference/v202408/SuggestedAdUnitService#performSuggestedAdUnitAction) \n▼\n**Statement**\n\nCaptures the `WHERE`, `ORDER BY` and `LIMIT` clauses of a\nPQL query. Statements are typically used to retrieve objects of a predefined\ndomain type, which makes SELECT clause unnecessary.\n\n\nAn example query text might be `\"WHERE status = 'ACTIVE' ORDER BY id\nLIMIT 30\"`.\n\n\nStatements support bind variables. These are substitutes for literals\nand can be thought of as input parameters to a PQL query.\n\n\nAn example of such a query might be `\"WHERE id = :idValue\"`.\n\n\nStatements also support use of the LIKE keyword. This provides wildcard string matching.\n\n\nAn example of such a query might be `\"WHERE name LIKE '%searchString%'\"`.\nThe value for the variable idValue must then be set with an object of type [Value](/ad-manager/api/reference/v202408/SuggestedAdUnitService.Value), e.g., [NumberValue](/ad-manager/api/reference/v202408/SuggestedAdUnitService.NumberValue), [TextValue](/ad-manager/api/reference/v202408/SuggestedAdUnitService.TextValue) or [BooleanValue](/ad-manager/api/reference/v202408/SuggestedAdUnitService.BooleanValue).\n\n*** ** * ** ***\n\nNamespace\n:\n `https://www.google.com/apis/ads/publisher/v202408`\n\n| Field ----- ||\n|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### `query` | ` `xsd:`string` Holds the query in PQL syntax. The syntax is: `[WHERE \u003ccondition\u003e {[AND | OR] \u003ccondition\u003e ...}]` `[ORDER BY \u003cproperty\u003e [ASC | DESC]]` `[LIMIT {[\u003coffset\u003e,] \u003ccount\u003e} | {\u003ccount\u003e OFFSET \u003coffset\u003e}]` `\u003ccondition\u003e` `:= \u003cproperty\u003e {\u003c | \u003c= | \u003e | \u003e= | = | != } \u003cvalue\u003e` `\u003ccondition\u003e` `:= \u003cproperty\u003e {\u003c | \u003c= | \u003e | \u003e= | = | != } \u003cbind variable\u003e` `\u003ccondition\u003e := \u003cproperty\u003e IN \u003clist\u003e` `\u003ccondition\u003e := \u003cproperty\u003e IS NULL` `\u003ccondition\u003e := \u003cproperty\u003e LIKE \u003cwildcard%match\u003e` `\u003cbind variable\u003e := :\u003cname\u003e` \u003cbr /\u003e |\n| ### `values` | ` `[String_ValueMapEntry](/ad-manager/api/reference/v202408/SuggestedAdUnitService.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](/ad-manager/api/reference/v202408/SuggestedAdUnitService.TextValue). The final result, for example, would be an entry of `\"bindStatus\" =\u003e StringParam(\"ACTIVE\")`. \u003cbr /\u003e |"]]