public final class ReportApiColumnSpec
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
com.google.api.client.util.GenericData.Flags
Constructor and Description |
---|
ReportApiColumnSpec() |
Modifier and Type | Method and Description |
---|---|
ReportApiColumnSpec |
clone() |
java.lang.String |
getColumnName()
Name of a DoubleClick Search column to include in the report.
|
java.lang.String |
getCustomDimensionName()
Segments a report by a custom dimension.
|
java.lang.String |
getCustomMetricName()
Name of a custom metric to include in the report.
|
java.lang.String |
getEndDate()
Inclusive day in YYYY-MM-DD format.
|
java.lang.Boolean |
getGroupByColumn()
Synchronous report only.
|
java.lang.String |
getHeaderText()
Text used to identify this column in the report output; defaults to columnName or
savedColumnName when not specified.
|
java.lang.String |
getPlatformSource()
The platform that is used to provide data for the custom dimension.
|
java.lang.String |
getProductReportPerspective()
Returns metrics only for a specific type of product activity.
|
java.lang.String |
getSavedColumnName()
Name of a saved column to include in the report.
|
java.lang.String |
getStartDate()
Inclusive date in YYYY-MM-DD format.
|
boolean |
isGroupByColumn()
Convenience method that returns only
Boolean.TRUE or Boolean.FALSE . |
ReportApiColumnSpec |
set(java.lang.String fieldName,
java.lang.Object value) |
ReportApiColumnSpec |
setColumnName(java.lang.String columnName)
Name of a DoubleClick Search column to include in the report.
|
ReportApiColumnSpec |
setCustomDimensionName(java.lang.String customDimensionName)
Segments a report by a custom dimension.
|
ReportApiColumnSpec |
setCustomMetricName(java.lang.String customMetricName)
Name of a custom metric to include in the report.
|
ReportApiColumnSpec |
setEndDate(java.lang.String endDate)
Inclusive day in YYYY-MM-DD format.
|
ReportApiColumnSpec |
setGroupByColumn(java.lang.Boolean groupByColumn)
Synchronous report only.
|
ReportApiColumnSpec |
setHeaderText(java.lang.String headerText)
Text used to identify this column in the report output; defaults to columnName or
savedColumnName when not specified.
|
ReportApiColumnSpec |
setPlatformSource(java.lang.String platformSource)
The platform that is used to provide data for the custom dimension.
|
ReportApiColumnSpec |
setProductReportPerspective(java.lang.String productReportPerspective)
Returns metrics only for a specific type of product activity.
|
ReportApiColumnSpec |
setSavedColumnName(java.lang.String savedColumnName)
Name of a saved column to include in the report.
|
ReportApiColumnSpec |
setStartDate(java.lang.String startDate)
Inclusive date in YYYY-MM-DD format.
|
getFactory, setFactory, toPrettyString, toString
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values
public java.lang.String getColumnName()
null
for nonepublic ReportApiColumnSpec setColumnName(java.lang.String columnName)
columnName
- columnName or null
for nonepublic java.lang.String getCustomDimensionName()
null
for nonepublic ReportApiColumnSpec setCustomDimensionName(java.lang.String customDimensionName)
customDimensionName
- customDimensionName or null
for nonepublic java.lang.String getCustomMetricName()
null
for nonepublic ReportApiColumnSpec setCustomMetricName(java.lang.String customMetricName)
customMetricName
- customMetricName or null
for nonepublic java.lang.String getEndDate()
null
for nonepublic ReportApiColumnSpec setEndDate(java.lang.String endDate)
endDate
- endDate or null
for nonepublic java.lang.Boolean getGroupByColumn()
null
for nonepublic ReportApiColumnSpec setGroupByColumn(java.lang.Boolean groupByColumn)
groupByColumn
- groupByColumn or null
for nonepublic boolean isGroupByColumn()
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
.
Synchronous report only. Set to true to group by this column. Defaults to false.
public java.lang.String getHeaderText()
null
for nonepublic ReportApiColumnSpec setHeaderText(java.lang.String headerText)
headerText
- headerText or null
for nonepublic java.lang.String getPlatformSource()
null
for nonepublic ReportApiColumnSpec setPlatformSource(java.lang.String platformSource)
platformSource
- platformSource or null
for nonepublic java.lang.String getProductReportPerspective()
null
for nonepublic ReportApiColumnSpec setProductReportPerspective(java.lang.String productReportPerspective)
productReportPerspective
- productReportPerspective or null
for nonepublic java.lang.String getSavedColumnName()
null
for nonepublic ReportApiColumnSpec setSavedColumnName(java.lang.String savedColumnName)
savedColumnName
- savedColumnName or null
for nonepublic java.lang.String getStartDate()
null
for nonepublic ReportApiColumnSpec setStartDate(java.lang.String startDate)
startDate
- startDate or null
for nonepublic ReportApiColumnSpec set(java.lang.String fieldName, java.lang.Object value)
set
in class com.google.api.client.json.GenericJson
public ReportApiColumnSpec clone()
clone
in class com.google.api.client.json.GenericJson