type Statement (v202408)
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 2024-08-20 UTC.
[null,null,["Last updated 2024-08-20 UTC."],[[["The `Statement` object defines the `WHERE`, `ORDER BY`, and `LIMIT` clauses for querying objects within the Google Ad Manager API."],["It uses Publisher Query Language (PQL) syntax for constructing queries."],["`Statement` supports bind variables for parameterized queries and the `LIKE` keyword for wildcard matching."],["It has two main fields: `query` to hold the PQL query string and `values` to store bind variable key-value pairs."],["The `values` field uses `String_ValueMapEntry` objects to associate bind variable names with their corresponding values, which can be of various types like `TextValue`, `NumberValue`, or `BooleanValue`."]]],["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"]]
