type Statement (v202411)
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/v202411
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-11-19 UTC.
[null,null,["Last updated 2024-11-19 UTC."],[[["The Statement object defines the `WHERE`, `ORDER BY`, and `LIMIT` clauses for PQL queries, used to retrieve specific objects."],["It supports bind variables as placeholders for literal values, enhancing query flexibility and security."],["The `query` field holds the PQL syntax, while the `values` field stores key-value pairs for bind variables and their corresponding values."],["Statements allow using the `LIKE` keyword for wildcard string matching, enabling broader searches within the data."],["Bind variables are represented using a colon prefix (e.g., `:idValue`) and their values are set using specific Value object types."]]],["The core content details various services for managing ads, including `AdRuleService`, `AdjustmentService`, `CreativeService`, and `LineItemService`, among others. The `Statement` object is central, enabling PQL queries using `WHERE`, `ORDER BY`, and `LIMIT` clauses. Queries support bind variables (e.g., `:idValue`) and `LIKE` for wildcard matching. `Statements` use 'query' field for PQL syntax and 'values' to map variable names to their corresponding values (e.g. `TextValue`). Line item data can be retrieved or acted upon.\n"]]
