com.google.api.ads.adwords.lib.utils

Interface ReportQueryInterface.BuilderInterface

All Superinterfaces:

QueryBuilderInterface<ReportQueryInterface>

All Known Implementing Classes:

ReportQuery.Builder, ReportQuery.Builder

Enclosing interface:

ReportQueryInterface

public static interface ReportQueryInterface.BuilderInterface
extends QueryBuilderInterface<ReportQueryInterface>

Builds an AWQL report query.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ReportQueryInterface.BuilderInterface.ReportWhereBuilderInterface<BuilderT extends ReportQueryInterface.BuilderInterface> A builder for the WHERE clause of queries.

Nested classes/interfaces inherited from interface com.google.api.ads.adwords.lib.utils.QueryBuilderInterface

QueryBuilderInterface.WhereBuilderInterface<QueryT>

Method Summary

Modifier and Type	Method and Description
ReportQueryInterface	build() Builds the query from the attributes of this builder.
ReportQueryInterface.BuilderInterface	during(Enum<?> dateRange) Specifies a date range for the DURING clause of a report query.
ReportQueryInterface.BuilderInterface	during(org.joda.time.LocalDate startDate, org.joda.time.LocalDate endDate) Specifies start and end dates for the DURING clause of a report query.
ReportQueryInterface.BuilderInterface	fields(Iterable<String> fields) Selects the provided fields for building a report query.
ReportQueryInterface.BuilderInterface	fields(String... fields) Selects the provided fields for building as a query.
ReportQueryInterface.BuilderInterface	from(Enum<?> reportType) Specifies a report type to be used as the FROM clause of a report query.
ReportQueryInterface.BuilderInterface	from(String reportType) Specifies a report type to be used as the FROM clause of a report query.
ReportQueryInterface.BuilderInterface.ReportWhereBuilderInterface	where(String field) Set the condition of this query as the WHERE clause.

Method Detail

fields

ReportQueryInterface.BuilderInterface fields(String... fields)

Description copied from interface: QueryBuilderInterface

Selects the provided fields for building as a query.

Specified by:

fields in interface QueryBuilderInterface<ReportQueryInterface>

Parameters:

fields - the provided fields to be selected

Returns:

this query builder itself for method chaining

fields

ReportQueryInterface.BuilderInterface fields(Iterable<String> fields)

Description copied from interface: QueryBuilderInterface

Selects the provided fields for building a report query.

Specified by:

fields in interface QueryBuilderInterface<ReportQueryInterface>

Parameters:

fields - the fields to be selected

Returns:

this builder itself for method chaining

where

ReportQueryInterface.BuilderInterface.ReportWhereBuilderInterface where(String field)

Description copied from interface: QueryBuilderInterface

Set the condition of this query as the WHERE clause.

Specified by:

where in interface QueryBuilderInterface<ReportQueryInterface>

Parameters:

field - the field of the given entity to be filtered on

Returns:

the WHERE builder to create a predicate

build

ReportQueryInterface build()

Description copied from interface: QueryBuilderInterface

Builds the query from the attributes of this builder.

Specified by:

build in interface QueryBuilderInterface<ReportQueryInterface>

Returns:

the built query object

from

ReportQueryInterface.BuilderInterface from(Enum<?> reportType)

Specifies a report type to be used as the FROM clause of a report query.

Parameters:

reportType - the report type to be used as the FROM clause

Returns:

this builder itself for method chaining

from

ReportQueryInterface.BuilderInterface from(String reportType)

Specifies a report type to be used as the FROM clause of a report query.

Parameters:

reportType - the report type to be used as the FROM clause

Returns:

this builder itself for method chaining

during

ReportQueryInterface.BuilderInterface during(Enum<?> dateRange)

Specifies a date range for the DURING clause of a report query. Calling this method will clear the stored date range and start and end dates.

Parameters:

dateRange - the date range to be used in the DURING clause

Returns:

this builder itself for method chaining

during

ReportQueryInterface.BuilderInterface during(org.joda.time.LocalDate startDate,
                                             org.joda.time.LocalDate endDate)

Specifies start and end dates for the DURING clause of a report query. Calling this method will clear the stored date range and start and end dates.

Parameters:

startDate - the start date to be used in the DURING clause

endDate - the end date to be used in the DURING clause

Returns:

this builder itself for method chaining