public final class ReportRequest
extends com.google.api.client.json.GenericJson
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
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.
|
com.google.api.client.util.GenericData.Flags
Constructor and Description |
---|
ReportRequest() |
Modifier and Type | Method and Description |
---|---|
ReportRequest |
clone() |
java.util.List<ReportApiColumnSpec> |
getColumns()
The columns to include in the report.
|
java.lang.String |
getDownloadFormat()
Format that the report should be returned in.
|
java.util.List<ReportRequest.Filters> |
getFilters()
A list of filters to be applied to the report.
|
java.lang.Boolean |
getIncludeDeletedEntities()
Determines if removed entities should be included in the report.
|
java.lang.Boolean |
getIncludeRemovedEntities()
Determines if removed entities should be included in the report.
|
java.lang.Integer |
getMaxRowsPerFile()
Asynchronous report only.
|
java.util.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.
|
java.lang.String |
getReportType()
Determines the type of rows that are returned in the report.
|
java.lang.Integer |
getRowCount()
Synchronous report only.
|
java.lang.Integer |
getStartRow()
Synchronous report only.
|
java.lang.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.
|
java.lang.Boolean |
getVerifySingleTimeZone()
If true, the report would only be created if all the requested stat data are sourced from a
single timezone.
|
boolean |
isIncludeDeletedEntities()
Convenience method that returns only
Boolean.TRUE or Boolean.FALSE . |
boolean |
isIncludeRemovedEntities()
Convenience method that returns only
Boolean.TRUE or Boolean.FALSE . |
boolean |
isVerifySingleTimeZone()
Convenience method that returns only
Boolean.TRUE or Boolean.FALSE . |
ReportRequest |
set(java.lang.String fieldName,
java.lang.Object value) |
ReportRequest |
setColumns(java.util.List<ReportApiColumnSpec> columns)
The columns to include in the report.
|
ReportRequest |
setDownloadFormat(java.lang.String downloadFormat)
Format that the report should be returned in.
|
ReportRequest |
setFilters(java.util.List<ReportRequest.Filters> filters)
A list of filters to be applied to the report.
|
ReportRequest |
setIncludeDeletedEntities(java.lang.Boolean includeDeletedEntities)
Determines if removed entities should be included in the report.
|
ReportRequest |
setIncludeRemovedEntities(java.lang.Boolean includeRemovedEntities)
Determines if removed entities should be included in the report.
|
ReportRequest |
setMaxRowsPerFile(java.lang.Integer maxRowsPerFile)
Asynchronous report only.
|
ReportRequest |
setOrderBy(java.util.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(java.lang.String reportType)
Determines the type of rows that are returned in the report.
|
ReportRequest |
setRowCount(java.lang.Integer rowCount)
Synchronous report only.
|
ReportRequest |
setStartRow(java.lang.Integer startRow)
Synchronous report only.
|
ReportRequest |
setStatisticsCurrency(java.lang.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(java.lang.Boolean verifySingleTimeZone)
If true, the report would only be created if all the requested stat data are sourced from a
single timezone.
|
getFactory, setFactory, toPrettyString, toString
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values
public java.util.List<ReportApiColumnSpec> getColumns()
null
for nonepublic ReportRequest setColumns(java.util.List<ReportApiColumnSpec> columns)
columns
- columns or null
for nonepublic java.lang.String getDownloadFormat()
null
for nonepublic ReportRequest setDownloadFormat(java.lang.String downloadFormat)
downloadFormat
- downloadFormat or null
for nonepublic java.util.List<ReportRequest.Filters> getFilters()
null
for nonepublic ReportRequest setFilters(java.util.List<ReportRequest.Filters> filters)
filters
- filters or null
for nonepublic java.lang.Boolean getIncludeDeletedEntities()
null
for nonepublic ReportRequest setIncludeDeletedEntities(java.lang.Boolean includeDeletedEntities)
includeDeletedEntities
- includeDeletedEntities or null
for nonepublic boolean isIncludeDeletedEntities()
Boolean.TRUE
or Boolean.FALSE
.
Boolean properties can have four possible values:
null
, Data.NULL_BOOLEAN
, Boolean.TRUE
or Boolean.FALSE
.
This method returns Boolean.TRUE
if the default of the property is Boolean.TRUE
and it is null
or Data.NULL_BOOLEAN
.
Boolean.FALSE
is returned if the default of the property is Boolean.FALSE
and
it is null
or Data.NULL_BOOLEAN
.
Determines if removed entities should be included in the report. Defaults to false. Deprecated, please use includeRemovedEntities instead.
public java.lang.Boolean getIncludeRemovedEntities()
null
for nonepublic ReportRequest setIncludeRemovedEntities(java.lang.Boolean includeRemovedEntities)
includeRemovedEntities
- includeRemovedEntities or null
for nonepublic boolean isIncludeRemovedEntities()
Boolean.TRUE
or Boolean.FALSE
.
Boolean properties can have four possible values:
null
, Data.NULL_BOOLEAN
, Boolean.TRUE
or Boolean.FALSE
.
This method returns Boolean.TRUE
if the default of the property is Boolean.TRUE
and it is null
or Data.NULL_BOOLEAN
.
Boolean.FALSE
is returned if the default of the property is Boolean.FALSE
and
it is null
or Data.NULL_BOOLEAN
.
Determines if removed entities should be included in the report. Defaults to false.
public java.lang.Integer getMaxRowsPerFile()
null
for nonepublic ReportRequest setMaxRowsPerFile(java.lang.Integer maxRowsPerFile)
maxRowsPerFile
- maxRowsPerFile or null
for nonepublic java.util.List<ReportRequest.OrderBy> getOrderBy()
null
for nonepublic ReportRequest setOrderBy(java.util.List<ReportRequest.OrderBy> orderBy)
orderBy
- orderBy or null
for nonepublic ReportRequest.ReportScope getReportScope()
null
for nonepublic ReportRequest setReportScope(ReportRequest.ReportScope reportScope)
reportScope
- reportScope or null
for nonepublic java.lang.String getReportType()
null
for nonepublic ReportRequest setReportType(java.lang.String reportType)
reportType
- reportType or null
for nonepublic java.lang.Integer getRowCount()
null
for nonepublic ReportRequest setRowCount(java.lang.Integer rowCount)
rowCount
- rowCount or null
for nonepublic java.lang.Integer getStartRow()
null
for nonepublic ReportRequest setStartRow(java.lang.Integer startRow)
startRow
- startRow or null
for nonepublic java.lang.String getStatisticsCurrency()
null
for nonepublic ReportRequest setStatisticsCurrency(java.lang.String statisticsCurrency)
statisticsCurrency
- statisticsCurrency or null
for nonepublic ReportRequest.TimeRange getTimeRange()
null
for nonepublic ReportRequest setTimeRange(ReportRequest.TimeRange timeRange)
timeRange
- timeRange or null
for nonepublic java.lang.Boolean getVerifySingleTimeZone()
null
for nonepublic ReportRequest setVerifySingleTimeZone(java.lang.Boolean verifySingleTimeZone)
verifySingleTimeZone
- verifySingleTimeZone or null
for nonepublic boolean isVerifySingleTimeZone()
Boolean.TRUE
or Boolean.FALSE
.
Boolean properties can have four possible values:
null
, Data.NULL_BOOLEAN
, Boolean.TRUE
or Boolean.FALSE
.
This method returns Boolean.TRUE
if the default of the property is Boolean.TRUE
and it is null
or Data.NULL_BOOLEAN
.
Boolean.FALSE
is returned if the default of the property is Boolean.FALSE
and
it is null
or Data.NULL_BOOLEAN
.
If true, the report would only be created if all the requested stat data are sourced from a single timezone. Defaults to false.
public ReportRequest set(java.lang.String fieldName, java.lang.Object value)
set
in class com.google.api.client.json.GenericJson
public ReportRequest clone()
clone
in class com.google.api.client.json.GenericJson