com.google.api.services.admob.v1beta.model

Class CampaignReportSpec

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.admob.v1beta.model.CampaignReportSpec

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

The specification for generating a Campaign report. For example, the specification to get IMPRESSIONS and CLICKS sliced by CAMPAIGN_ID can look like the following example: { "date_range": { "start_date": {"year": 2021, "month": 12, "day": 1}, "end_date": {"year": 2021, "month": 12, "day": 30} }, "dimensions": ["CAMPAIGN_ID"], "metrics": ["IMPRESSIONS", "CLICKS"], }

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 AdMob 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
CampaignReportSpec()

Method Summary

Modifier and Type	Method and Description
CampaignReportSpec	clone()
DateRange	getDateRange() The date range for which the report is generated.
List<String>	getDimensions() List of dimensions of the report.
String	getLanguageCode() Language used for any localized text, such as certain applicable dimension values.
List<String>	getMetrics() List of metrics of the report.
CampaignReportSpec	set(String fieldName, Object value)
CampaignReportSpec	setDateRange(DateRange dateRange) The date range for which the report is generated.
CampaignReportSpec	setDimensions(List<String> dimensions) List of dimensions of the report.
CampaignReportSpec	setLanguageCode(String languageCode) Language used for any localized text, such as certain applicable dimension values.
CampaignReportSpec	setMetrics(List<String> metrics) List of metrics of the report.

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

CampaignReportSpec

public CampaignReportSpec()

Method Detail

getDateRange

public DateRange getDateRange()

The date range for which the report is generated. The max range is 30 days.

Returns:

value or null for none

setDateRange

public CampaignReportSpec setDateRange(DateRange dateRange)

The date range for which the report is generated. The max range is 30 days.

Parameters:

dateRange - dateRange or null for none

getDimensions

public List<String> getDimensions()

List of dimensions of the report. The value combination of these dimensions determines the row of the report. If no dimensions are specified, the report returns a single row of requested metrics for the entire account.

Returns:

value or null for none

setDimensions

public CampaignReportSpec setDimensions(List<String> dimensions)

List of dimensions of the report. The value combination of these dimensions determines the row of the report. If no dimensions are specified, the report returns a single row of requested metrics for the entire account.

Parameters:

dimensions - dimensions or null for none

getLanguageCode

public String getLanguageCode()

Language used for any localized text, such as certain applicable dimension values. The language tag is defined in the IETF BCP47. Defaults to 'en-US' if unspecified or invalid.

Returns:

value or null for none

setLanguageCode

public CampaignReportSpec setLanguageCode(String languageCode)

Language used for any localized text, such as certain applicable dimension values. The language tag is defined in the IETF BCP47. Defaults to 'en-US' if unspecified or invalid.

Parameters:

languageCode - languageCode or null for none

getMetrics

public List<String> getMetrics()

List of metrics of the report. A report must specify at least one metric.

Returns:

value or null for none

setMetrics

public CampaignReportSpec setMetrics(List<String> metrics)

List of metrics of the report. A report must specify at least one metric.

Parameters:

metrics - metrics or null for none

set

public CampaignReportSpec set(String fieldName,
                              Object value)

Overrides:

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

clone

public CampaignReportSpec clone()

Overrides:

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