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 Publisher Query Language (PQL) queries used in Google Ad Manager."],["It allows for filtering data based on conditions, sorting results by properties, and limiting the number of returned objects."],["Statements support bind variables for parameterized queries and the `LIKE` keyword for wildcard string matching."],["The `query` field holds the PQL query string, and the `values` field stores key-value pairs for bind variables and their corresponding values."]]],["The core content details services within an ad management system, including Activity, AdRule, AudienceSegment, and others, alongside dependencies like `getOrdersByStatement()` and `performOrderAction()`. A key component is the **Statement**, a PQL query structure. It uses `WHERE`, `ORDER BY`, and `LIMIT` clauses to filter data, supports bind variables (e.g., `:idValue`), and includes wildcard matching with `LIKE`. Statements consist of a `query` field for the PQL syntax and `values` to define bind variables and their values.\n"]]
