type Statement (v202402)
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/v202402
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 2024-02-13 UTC.
[null,null,["Last updated 2024-02-13 UTC."],[[["The Statement object defines the `WHERE`, `ORDER BY`, and `LIMIT` clauses for retrieving specific data using PQL queries in Google Ad Manager."],["Statements support bind variables, acting as placeholders for literal values within the query, enhancing flexibility."],["Bind variables are represented by a colon followed by a name (e.g., `:idValue`) and their values are set using specific objects like `TextValue` or `NumberValue`."],["The `query` field holds the PQL syntax, while the `values` field contains an array of key-value pairs for bind variables and their corresponding values."],["Statements also enable wildcard string matching using the `LIKE` keyword, allowing broader searches within the data."]]],["The core content details various services and their operations within an ad management system. Key services include `ActivityGroupService`, `AdRuleService`, `AudienceSegmentService`, and many others, each handling specific aspects like ad rules, audiences, and content. `AdRuleService` actions such as `getAdRulesByStatement()`, `getAdSpotsByStatement()`, `getBreakTemplatesByStatement()`, and `performAdRuleAction()` are defined. Also, the \"Statement\" section defines how to retrieve objects using PQL, including `WHERE`, `ORDER BY`, and `LIMIT` clauses, bind variables, and wildcard matching.\n"]]
