com.google.api.services.doubleclicksearch.model

Class ReportRequest

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.doubleclicksearch.model.ReportRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ReportRequest
extends com.google.api.client.json.GenericJson

A request object used to create a DoubleClick Search report.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Search Ads 360 API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReportRequest.Filters Model definition for ReportRequestFilters.
static class	ReportRequest.OrderBy Model definition for ReportRequestOrderBy.
static class	ReportRequest.ReportScope The reportScope is a set of IDs that are used to determine which subset of entities will be returned in the report.
static class	ReportRequest.TimeRange If metrics are requested in a report, this argument will be used to restrict the metrics to a specific time range.

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ReportRequest()

Method Summary

Modifier and Type	Method and Description
ReportRequest	clone()
List<ReportApiColumnSpec>	getColumns() The columns to include in the report.
String	getDownloadFormat() Format that the report should be returned in.
List<ReportRequest.Filters>	getFilters() A list of filters to be applied to the report.\ The maximum number of filters per request is 300.
Boolean	getIncludeDeletedEntities() Determines if removed entities should be included in the report.
Boolean	getIncludeRemovedEntities() Determines if removed entities should be included in the report.
Integer	getMaxRowsPerFile() Asynchronous report only.
List<ReportRequest.OrderBy>	getOrderBy() Synchronous report only.
ReportRequest.ReportScope	getReportScope() The reportScope is a set of IDs that are used to determine which subset of entities will be returned in the report.
String	getReportType() Determines the type of rows that are returned in the report.
Integer	getRowCount() Synchronous report only.
Integer	getStartRow() Synchronous report only.
String	getStatisticsCurrency() Specifies the currency in which monetary will be returned.
ReportRequest.TimeRange	getTimeRange() If metrics are requested in a report, this argument will be used to restrict the metrics to a specific time range.
Boolean	getVerifySingleTimeZone() If `true`, the report would only be created if all the requested stat data are sourced from a single timezone.
ReportRequest	set(String fieldName, Object value)
ReportRequest	setColumns(List<ReportApiColumnSpec> columns) The columns to include in the report.
ReportRequest	setDownloadFormat(String downloadFormat) Format that the report should be returned in.
ReportRequest	setFilters(List<ReportRequest.Filters> filters) A list of filters to be applied to the report.\ The maximum number of filters per request is 300.
ReportRequest	setIncludeDeletedEntities(Boolean includeDeletedEntities) Determines if removed entities should be included in the report.
ReportRequest	setIncludeRemovedEntities(Boolean includeRemovedEntities) Determines if removed entities should be included in the report.
ReportRequest	setMaxRowsPerFile(Integer maxRowsPerFile) Asynchronous report only.
ReportRequest	setOrderBy(List<ReportRequest.OrderBy> orderBy) Synchronous report only.
ReportRequest	setReportScope(ReportRequest.ReportScope reportScope) The reportScope is a set of IDs that are used to determine which subset of entities will be returned in the report.
ReportRequest	setReportType(String reportType) Determines the type of rows that are returned in the report.
ReportRequest	setRowCount(Integer rowCount) Synchronous report only.
ReportRequest	setStartRow(Integer startRow) Synchronous report only.
ReportRequest	setStatisticsCurrency(String statisticsCurrency) Specifies the currency in which monetary will be returned.
ReportRequest	setTimeRange(ReportRequest.TimeRange timeRange) If metrics are requested in a report, this argument will be used to restrict the metrics to a specific time range.
ReportRequest	setVerifySingleTimeZone(Boolean verifySingleTimeZone) If `true`, the report would only be created if all the requested stat data are sourced from a single timezone.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

ReportRequest

public ReportRequest()

Method Detail

getColumns

public List<ReportApiColumnSpec> getColumns()

The columns to include in the report. This includes both DoubleClick Search columns and saved columns. For DoubleClick Search columns, only the `columnName` parameter is required. For saved columns only the `savedColumnName` parameter is required. Both `columnName` and `savedColumnName` cannot be set in the same stanza.\ The maximum number of columns per request is 300.

Returns:

value or null for none

setColumns

public ReportRequest setColumns(List<ReportApiColumnSpec> columns)

The columns to include in the report. This includes both DoubleClick Search columns and saved columns. For DoubleClick Search columns, only the `columnName` parameter is required. For saved columns only the `savedColumnName` parameter is required. Both `columnName` and `savedColumnName` cannot be set in the same stanza.\ The maximum number of columns per request is 300.

Parameters:

columns - columns or null for none

getDownloadFormat

public String getDownloadFormat()

Format that the report should be returned in. Currently `csv` or `tsv` is supported.

Returns:

value or null for none

setDownloadFormat

public ReportRequest setDownloadFormat(String downloadFormat)

Format that the report should be returned in. Currently `csv` or `tsv` is supported.

Parameters:

downloadFormat - downloadFormat or null for none

getFilters

public List<ReportRequest.Filters> getFilters()

A list of filters to be applied to the report.\ The maximum number of filters per request is 300.

Returns:

value or null for none

setFilters

public ReportRequest setFilters(List<ReportRequest.Filters> filters)

A list of filters to be applied to the report.\ The maximum number of filters per request is 300.

Parameters:

filters - filters or null for none

getIncludeDeletedEntities

public Boolean getIncludeDeletedEntities()

Determines if removed entities should be included in the report. Defaults to `false`. Deprecated, please use `includeRemovedEntities` instead.

Returns:

value or null for none

setIncludeDeletedEntities

public ReportRequest setIncludeDeletedEntities(Boolean includeDeletedEntities)

Determines if removed entities should be included in the report. Defaults to `false`. Deprecated, please use `includeRemovedEntities` instead.

Parameters:

includeDeletedEntities - includeDeletedEntities or null for none

getIncludeRemovedEntities

public Boolean getIncludeRemovedEntities()

Determines if removed entities should be included in the report. Defaults to `false`.

Returns:

value or null for none

setIncludeRemovedEntities

public ReportRequest setIncludeRemovedEntities(Boolean includeRemovedEntities)

Determines if removed entities should be included in the report. Defaults to `false`.

Parameters:

includeRemovedEntities - includeRemovedEntities or null for none

getMaxRowsPerFile

public Integer getMaxRowsPerFile()

Asynchronous report only. The maximum number of rows per report file. A large report is split into many files based on this field. Acceptable values are `1000000` to `100000000`, inclusive.

Returns:

value or null for none

setMaxRowsPerFile

public ReportRequest setMaxRowsPerFile(Integer maxRowsPerFile)

Asynchronous report only. The maximum number of rows per report file. A large report is split into many files based on this field. Acceptable values are `1000000` to `100000000`, inclusive.

Parameters:

maxRowsPerFile - maxRowsPerFile or null for none

getOrderBy

public List<ReportRequest.OrderBy> getOrderBy()

Synchronous report only. A list of columns and directions defining sorting to be performed on the report rows.\ The maximum number of orderings per request is 300.

Returns:

value or null for none

setOrderBy

public ReportRequest setOrderBy(List<ReportRequest.OrderBy> orderBy)

Synchronous report only. A list of columns and directions defining sorting to be performed on the report rows.\ The maximum number of orderings per request is 300.

Parameters:

orderBy - orderBy or null for none

getReportScope

public ReportRequest.ReportScope getReportScope()

The reportScope is a set of IDs that are used to determine which subset of entities will be returned in the report. The full lineage of IDs from the lowest scoped level desired up through agency is required.

Returns:

value or null for none

setReportScope

public ReportRequest setReportScope(ReportRequest.ReportScope reportScope)

The reportScope is a set of IDs that are used to determine which subset of entities will be returned in the report. The full lineage of IDs from the lowest scoped level desired up through agency is required.

Parameters:

reportScope - reportScope or null for none

getReportType

public String getReportType()

Determines the type of rows that are returned in the report. For example, if you specify `reportType: keyword`, each row in the report will contain data about a keyword. See the [Types of Reports](/search-ads/v2/report-types/) reference for the columns that are available for each type.

Returns:

value or null for none

setReportType

public ReportRequest setReportType(String reportType)

Determines the type of rows that are returned in the report. For example, if you specify `reportType: keyword`, each row in the report will contain data about a keyword. See the [Types of Reports](/search-ads/v2/report-types/) reference for the columns that are available for each type.

Parameters:

reportType - reportType or null for none

getRowCount

public Integer getRowCount()

Synchronous report only. The maximum number of rows to return; additional rows are dropped. Acceptable values are `0` to `10000`, inclusive. Defaults to `10000`.

Returns:

value or null for none

setRowCount

public ReportRequest setRowCount(Integer rowCount)

Synchronous report only. The maximum number of rows to return; additional rows are dropped. Acceptable values are `0` to `10000`, inclusive. Defaults to `10000`.

Parameters:

rowCount - rowCount or null for none

getStartRow

public Integer getStartRow()

Synchronous report only. Zero-based index of the first row to return. Acceptable values are `0` to `50000`, inclusive. Defaults to `0`.

Returns:

value or null for none

setStartRow

public ReportRequest setStartRow(Integer startRow)

Synchronous report only. Zero-based index of the first row to return. Acceptable values are `0` to `50000`, inclusive. Defaults to `0`.

Parameters:

startRow - startRow or null for none

getStatisticsCurrency

public String getStatisticsCurrency()

Specifies the currency in which monetary will be returned. Possible values are: `usd`, `agency` (valid if the report is scoped to agency or lower), `advertiser` (valid if the report is scoped to * advertiser or lower), or `account` (valid if the report is scoped to engine account or lower).

Returns:

value or null for none

setStatisticsCurrency

public ReportRequest setStatisticsCurrency(String statisticsCurrency)

Specifies the currency in which monetary will be returned. Possible values are: `usd`, `agency` (valid if the report is scoped to agency or lower), `advertiser` (valid if the report is scoped to * advertiser or lower), or `account` (valid if the report is scoped to engine account or lower).

Parameters:

statisticsCurrency - statisticsCurrency or null for none

getTimeRange

public ReportRequest.TimeRange getTimeRange()

If metrics are requested in a report, this argument will be used to restrict the metrics to a specific time range.

Returns:

value or null for none

setTimeRange

public ReportRequest setTimeRange(ReportRequest.TimeRange timeRange)

If metrics are requested in a report, this argument will be used to restrict the metrics to a specific time range.

Parameters:

timeRange - timeRange or null for none

getVerifySingleTimeZone

public Boolean getVerifySingleTimeZone()

If `true`, the report would only be created if all the requested stat data are sourced from a single timezone. Defaults to `false`.

Returns:

value or null for none

setVerifySingleTimeZone

public ReportRequest setVerifySingleTimeZone(Boolean verifySingleTimeZone)

If `true`, the report would only be created if all the requested stat data are sourced from a single timezone. Defaults to `false`.

Parameters:

verifySingleTimeZone - verifySingleTimeZone or null for none

set

public ReportRequest set(String fieldName,
                         Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public ReportRequest clone()

Overrides:

clone in class com.google.api.client.json.GenericJson