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

Class ReportQuery.Builder

java.lang.Object

com.google.api.ads.adwords.lib.utils.v201710.ReportQuery.Builder

All Implemented Interfaces:

QueryBuilderInterface<ReportQueryInterface>, ReportQueryInterface.BuilderInterface

Enclosing class:

ReportQuery

public static class ReportQuery.Builder
extends Object
implements ReportQueryInterface.BuilderInterface

Builds a ReportQuery object.

This builder is not thread-safe.

Nested Class Summary

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

ReportQueryInterface.BuilderInterface.ReportWhereBuilderInterface<BuilderT extends ReportQueryInterface.BuilderInterface>

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

QueryBuilderInterface.WhereBuilderInterface<QueryT>

Constructor Summary

Constructors

Constructor and Description
Builder() Constructs a new report query builder.
Builder(ReportQueryInterface.BuilderInterface builderInterface) Constructs a new report query builder by copying all properties from the passed report query builder.

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Constructs a new report query builder.

Builder

public Builder(ReportQueryInterface.BuilderInterface builderInterface)

Constructs a new report query builder by copying all properties from the passed report query builder.

Parameters:

builderInterface - the report query builder whose properties will be copied to.

Method Detail

where

public ReportQueryInterface.BuilderInterface.ReportWhereBuilderInterface<ReportQuery.Builder> 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>

Specified by:

where in interface ReportQueryInterface.BuilderInterface

Parameters:

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

Returns:

the WHERE builder to create a predicate

fields

public ReportQuery.Builder fields(String... fields)

Description copied from interface: QueryBuilderInterface

Selects the provided fields for building as a query.

Specified by:

fields in interface QueryBuilderInterface<ReportQueryInterface>

Specified by:

fields in interface ReportQueryInterface.BuilderInterface

Parameters:

fields - the provided fields to be selected

Returns:

this query builder itself for method chaining

fields

public ReportQuery.Builder 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>

Specified by:

fields in interface ReportQueryInterface.BuilderInterface

Parameters:

fields - the fields to be selected

Returns:

this builder itself for method chaining

from

public ReportQuery.Builder from(Enum<?> reportType)

Description copied from interface: ReportQueryInterface.BuilderInterface

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

Specified by:

from in interface ReportQueryInterface.BuilderInterface

Parameters:

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

Returns:

this builder itself for method chaining

from

public ReportQuery.Builder from(String reportType)

Description copied from interface: ReportQueryInterface.BuilderInterface

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

Specified by:

from in interface ReportQueryInterface.BuilderInterface

Parameters:

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

Returns:

this builder itself for method chaining

during

public ReportQuery.Builder during(Enum<?> dateRange)

Description copied from interface: ReportQueryInterface.BuilderInterface

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.

Specified by:

during in interface ReportQueryInterface.BuilderInterface

Parameters:

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

Returns:

this builder itself for method chaining

during

public ReportQuery.Builder during(org.joda.time.LocalDate startDate,
                                  org.joda.time.LocalDate endDate)

Description copied from interface: ReportQueryInterface.BuilderInterface

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.

Specified by:

during in interface ReportQueryInterface.BuilderInterface

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

build

public ReportQuery build()

Description copied from interface: QueryBuilderInterface

Builds the query from the attributes of this builder.

Specified by:

build in interface QueryBuilderInterface<ReportQueryInterface>

Specified by:

build in interface ReportQueryInterface.BuilderInterface

Returns:

the built query object