\Google\AdsApi\AdWords\Query\v201809ReportQueryWhereBuilder

Builds a logic expression in the WHERE clause of an AWQL string and returns a `ReportQueryBuilder` object for chaining.

Summary

Methods
Properties
Constants
createWithField()
copyFrom()
buildWhere()
equalTo()
notEqualTo()
greaterThan()
greaterThanOrEqualTo()
lessThan()
lessThanOrEqualTo()
startsWith()
startsWithIgnoreCase()
contains()
containsIgnoreCase()
doesNotContain()
doesNotContainIgnoreCase()
in()
notIn()
containsAny()
containsNone()
containsAll()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
__construct()
$queryBuilder
$expressionBuilder
N/A

Properties

Methods

createWithField()

createWithField(string  $field,\Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder  $queryBuilder): \Google\AdsApi\AdWords\Query\v201809\ReportQueryWhereBuilder

Creates a where builder object to start a logic expression with a field name.

Parameters

string $field

name of the field to be used as the left-hand operand of a logic expression

\Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder $queryBuilder

the query builder object for continuation of building a complete AWQL string

Returns

\Google\AdsApi\AdWords\Query\v201809\ReportQueryWhereBuilder

a where builder object to build a logic expression starting with the given field name

copyFrom()

copyFrom(\Google\AdsApi\AdWords\Query\v201809\ReportQueryWhereBuilder  $otherInstance,\Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder  $queryBuilder): \Google\AdsApi\AdWords\Query\v201809\ReportQueryWhereBuilder

Creates a new where builder object by copying the logic expression from another where builder object.

Parameters

\Google\AdsApi\AdWords\Query\v201809\ReportQueryWhereBuilder $otherInstance

the other where builder object for copying the logic expression

\Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder $queryBuilder

the query builder object for continuation of building a complete AWQL string

Returns

\Google\AdsApi\AdWords\Query\v201809\ReportQueryWhereBuilder

a new where builder object that copies from the input one

buildWhere()

buildWhere(): string

Builds a logic expression in the WHERE clause of an AWQL string.

Throws

\BadFunctionCallException

when no operators was specified prior to calling this function

Returns

string —

a logic expression in the WHERE clause of an AWQL string

equalTo()

equalTo(string  $value): \Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder

Sets the value that follows the equal (=) operator.

Parameters

string $value

represents the value for comparison

Returns

\Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder

the ReportQueryBuilder object for continuation of building a complete AWQL string

notEqualTo()

notEqualTo(string  $value): \Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder

Sets the value that follows the not equal (!=) operator.

Parameters

string $value

represents the value for comparison

Returns

\Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder

the ReportQueryBuilder object for continuation of building a complete AWQL string

greaterThan()

greaterThan(string  $value): \Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder

Sets the value that follows the greater than (>) operator.

Parameters

string $value

represents the value for comparison

Returns

\Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder

the ReportQueryBuilder object for continuation of building a complete AWQL string

greaterThanOrEqualTo()

greaterThanOrEqualTo(string  $value): \Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder

Sets the value that follows the greater than or equal (>=) operator.

Parameters

string $value

represents the value for comparison

Returns

\Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder

the ReportQueryBuilder object for continuation of building a complete AWQL string

lessThan()

lessThan(string  $value): \Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder

Sets the value that follows the less than (<) operator.

Parameters

string $value

represents the value for comparison

Returns

\Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder

the ReportQueryBuilder object for continuation of building a complete AWQL string

lessThanOrEqualTo()

lessThanOrEqualTo(string  $value): \Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder

Sets the value that follows the less than or equal (<=) operator.

Parameters

string $value

represents the value for comparison

Returns

\Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder

the ReportQueryBuilder object for continuation of building a complete AWQL string

startsWith()

startsWith(string  $value): \Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder

Sets the value that follows the STARTS_WITH operator.

Parameters

string $value

represents the value for comparison

Returns

\Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder

the ReportQueryBuilder object for continuation of building a complete AWQL string

startsWithIgnoreCase()

startsWithIgnoreCase(string  $value): \Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder

Sets the value that follows the STARTS_WITH_IGNORE_CASE operator.

Parameters

string $value

represents the value for comparison

Returns

\Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder

the ReportQueryBuilder object for continuation of building a complete AWQL string

contains()

contains(string  $value): \Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder

Sets the value that follows the CONTAINS operator.

Parameters

string $value

represents the value for comparison

Returns

\Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder

the ReportQueryBuilder object for continuation of building a complete AWQL string

containsIgnoreCase()

containsIgnoreCase(string  $value): \Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder

Sets the value that follows the CONTAINS_IGNORE_CASE operator.

Parameters

string $value

represents the value for comparison

Returns

\Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder

the ReportQueryBuilder object for continuation of building a complete AWQL string

doesNotContain()

doesNotContain(string  $value): \Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder

Sets the value that follows the DOES_NOT_CONTAIN operator.

Parameters

string $value

represents the value for comparison

Returns

\Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder

the ReportQueryBuilder object for continuation of building a complete AWQL string

doesNotContainIgnoreCase()

doesNotContainIgnoreCase(string  $value): \Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder

Sets the value that follows the DOES_NOT_CONTAIN_IGNORE_CASE operator.

Parameters

string $value

represents the value for comparison

Returns

\Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder

the ReportQueryBuilder object for continuation of building a complete AWQL string

in()

in(array  $values): \Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder

Sets the list of values that follows the IN operator.

Parameters

array $values

the list of values that follows the IN operator

Returns

\Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder

the ReportQueryBuilder object for continuation of building a complete AWQL string

notIn()

notIn(array  $values): \Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder

Sets the list of values that follows the NOT_IN operator.

Parameters

array $values

the list of values that follows the NOT_IN operator

Returns

\Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder

the ReportQueryBuilder object for continuation of building a complete AWQL string

containsAny()

containsAny(array  $values): \Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder

Sets the list of values that follows the CONTAINS_ANY operator.

Parameters

array $values

the list of values that follows the CONTAINS_ANY operator

Returns

\Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder

the ReportQueryBuilder object for continuation of building a complete AWQL string

containsNone()

containsNone(array  $values): \Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder

Sets the list of values that follows the CONTAINS_NONE operator.

Parameters

array $values

the list of values that follows the CONTAINS_NONE operator

Returns

\Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder

the ReportQueryBuilder object for continuation of building a complete AWQL string

containsAll()

containsAll(array  $values): \Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder

Sets the list of values that follows the CONTAINS_ALL operator.

Parameters

array $values

the list of values that follows the CONTAINS_ALL operator

Returns

\Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder

the ReportQueryBuilder object for continuation of building a complete AWQL string

__construct()

__construct(\Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder  $queryBuilder,\Google\AdsApi\AdWords\Query\v201809\ExpressionBuilder  $expressionBuilder)

Creates a where builder object to build a logic expression in the WHERE clause of an AWQL string.

Parameters

\Google\AdsApi\AdWords\Query\v201809\ReportQueryBuilder $queryBuilder

the query builder object for continuation of building a complete AWQL string

\Google\AdsApi\AdWords\Query\v201809\ExpressionBuilder $expressionBuilder

the expression builder to build the logic expression