type Statement (v202405)
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/v202405
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-05-15 UTC.
[null,null,["Last updated 2024-05-15 UTC."],[[["The `Statement` object in Google Ad Manager's Publisher Query Language (PQL) defines the `WHERE`, `ORDER BY`, and `LIMIT` clauses for querying data."],["It allows using bind variables as placeholders for literal values in the query, enhancing flexibility."],["`Statement` supports the `LIKE` keyword to perform wildcard string matching in queries."],["It is used to specify query conditions, sorting order, and the maximum number of results to retrieve, making data retrieval more precise and efficient."],["Bind variables are represented using a colon prefix (e.g., `:idValue`) and their values are provided separately through a `String_ValueMapEntry` object, enhancing query security and organization."]]],["The provided content details various services and the **Statement** structure used for querying within the Ad Manager API. It describes how to use Publisher Query Language (PQL) syntax to formulate queries with `WHERE`, `ORDER BY`, and `LIMIT` clauses. Statements support bind variables (e.g., `:idValue`) and wildcard string matching (`LIKE`). The `query` field holds the PQL string, and `values` field map bind variable names to their literal values, including `NumberValue`, `TextValue`, or `BooleanValue`.\n"]]
