com.google.api.services.doubleclicksearch.model

Class ReportApiColumnSpec

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.ReportApiColumnSpec

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ReportApiColumnSpec
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/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
ReportApiColumnSpec()

Method Summary

Modifier and Type	Method and Description
ReportApiColumnSpec	clone()
String	getColumnName() Name of a DoubleClick Search column to include in the report.
String	getCustomDimensionName() Segments a report by a custom dimension.
String	getCustomMetricName() Name of a custom metric to include in the report.
String	getEndDate() Inclusive day in YYYY-MM-DD format.
Boolean	getGroupByColumn() Synchronous report only.
String	getHeaderText() Text used to identify this column in the report output; defaults to `columnName` or `savedColumnName` when not specified.
String	getPlatformSource() The platform that is used to provide data for the custom dimension.
String	getProductReportPerspective() Returns metrics only for a specific type of product activity.
String	getSavedColumnName() Name of a saved column to include in the report.
String	getStartDate() Inclusive date in YYYY-MM-DD format.
ReportApiColumnSpec	set(String fieldName, Object value)
ReportApiColumnSpec	setColumnName(String columnName) Name of a DoubleClick Search column to include in the report.
ReportApiColumnSpec	setCustomDimensionName(String customDimensionName) Segments a report by a custom dimension.
ReportApiColumnSpec	setCustomMetricName(String customMetricName) Name of a custom metric to include in the report.
ReportApiColumnSpec	setEndDate(String endDate) Inclusive day in YYYY-MM-DD format.
ReportApiColumnSpec	setGroupByColumn(Boolean groupByColumn) Synchronous report only.
ReportApiColumnSpec	setHeaderText(String headerText) Text used to identify this column in the report output; defaults to `columnName` or `savedColumnName` when not specified.
ReportApiColumnSpec	setPlatformSource(String platformSource) The platform that is used to provide data for the custom dimension.
ReportApiColumnSpec	setProductReportPerspective(String productReportPerspective) Returns metrics only for a specific type of product activity.
ReportApiColumnSpec	setSavedColumnName(String savedColumnName) Name of a saved column to include in the report.
ReportApiColumnSpec	setStartDate(String startDate) Inclusive date in YYYY-MM-DD format.

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

ReportApiColumnSpec

public ReportApiColumnSpec()

Method Detail

getColumnName

public String getColumnName()

Name of a DoubleClick Search column to include in the report.

Returns:

value or null for none

setColumnName

public ReportApiColumnSpec setColumnName(String columnName)

Name of a DoubleClick Search column to include in the report.

Parameters:

columnName - columnName or null for none

getCustomDimensionName

public String getCustomDimensionName()

Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive.\ If used in a conversion report, returns the value of the specified custom dimension for the given conversion, if set. This column does not segment the conversion report.

Returns:

value or null for none

setCustomDimensionName

public ReportApiColumnSpec setCustomDimensionName(String customDimensionName)

Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive.\ If used in a conversion report, returns the value of the specified custom dimension for the given conversion, if set. This column does not segment the conversion report.

Parameters:

customDimensionName - customDimensionName or null for none

getCustomMetricName

public String getCustomMetricName()

Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive.

Returns:

value or null for none

setCustomMetricName

public ReportApiColumnSpec setCustomMetricName(String customMetricName)

Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive.

Parameters:

customMetricName - customMetricName or null for none

getEndDate

public String getEndDate()

Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with `startDate`.

Returns:

value or null for none

setEndDate

public ReportApiColumnSpec setEndDate(String endDate)

Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with `startDate`.

Parameters:

endDate - endDate or null for none

getGroupByColumn

public Boolean getGroupByColumn()

Synchronous report only. Set to `true` to group by this column. Defaults to `false`.

Returns:

value or null for none

setGroupByColumn

public ReportApiColumnSpec setGroupByColumn(Boolean groupByColumn)

Synchronous report only. Set to `true` to group by this column. Defaults to `false`.

Parameters:

groupByColumn - groupByColumn or null for none

getHeaderText

public String getHeaderText()

Text used to identify this column in the report output; defaults to `columnName` or `savedColumnName` when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name.

Returns:

value or null for none

setHeaderText

public ReportApiColumnSpec setHeaderText(String headerText)

Text used to identify this column in the report output; defaults to `columnName` or `savedColumnName` when not specified. This can be used to prevent collisions between DoubleClick Search columns and saved columns with the same name.

Parameters:

headerText - headerText or null for none

getPlatformSource

public String getPlatformSource()

The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".

Returns:

value or null for none

setPlatformSource

public ReportApiColumnSpec setPlatformSource(String platformSource)

The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight".

Parameters:

platformSource - platformSource or null for none

getProductReportPerspective

public String getProductReportPerspective()

Returns metrics only for a specific type of product activity. Accepted values are: - "`sold`": returns metrics only for products that were sold - "`advertised`": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold

Returns:

value or null for none

setProductReportPerspective

public ReportApiColumnSpec setProductReportPerspective(String productReportPerspective)

Returns metrics only for a specific type of product activity. Accepted values are: - "`sold`": returns metrics only for products that were sold - "`advertised`": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold

Parameters:

productReportPerspective - productReportPerspective or null for none

getSavedColumnName

public String getSavedColumnName()

Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI.

Returns:

value or null for none

setSavedColumnName

public ReportApiColumnSpec setSavedColumnName(String savedColumnName)

Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the DoubleClick Search UI.

Parameters:

savedColumnName - savedColumnName or null for none

getStartDate

public String getStartDate()

Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with `endDate`.

Returns:

value or null for none

setStartDate

public ReportApiColumnSpec setStartDate(String startDate)

Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together with `endDate`.

Parameters:

startDate - startDate or null for none

set

public ReportApiColumnSpec set(String fieldName,
                               Object value)

Overrides:

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

clone

public ReportApiColumnSpec clone()

Overrides:

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