com.google.api.services.dfareporting.model

Class ReportDataQueryRequest

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.dfareporting.model.ReportDataQueryRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

The request body containing ad-hoc query parameters.

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 Campaign Manager 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
ReportDataQueryRequest()

Method Summary

Modifier and Type	Method and Description
ReportDataQueryRequest	clone()
DateRange	getDateRange() Optional.
List<DimensionValue>	getDimensionFilters() Optional.
List<String>	getDimensionNames() Optional.
Integer	getMaxResults() Optional.
List<String>	getMetricNames() Required.
String	getPageToken() Optional.
List<SortBy>	getSortBys() Optional.
ReportDataQueryRequest	set(String fieldName, Object value)
ReportDataQueryRequest	setDateRange(DateRange dateRange) Optional.
ReportDataQueryRequest	setDimensionFilters(List<DimensionValue> dimensionFilters) Optional.
ReportDataQueryRequest	setDimensionNames(List<String> dimensionNames) Optional.
ReportDataQueryRequest	setMaxResults(Integer maxResults) Optional.
ReportDataQueryRequest	setMetricNames(List<String> metricNames) Required.
ReportDataQueryRequest	setPageToken(String pageToken) Optional.
ReportDataQueryRequest	setSortBys(List<SortBy> sortBys) Optional.

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

ReportDataQueryRequest

public ReportDataQueryRequest()

Method Detail

getDateRange

public DateRange getDateRange()

Optional. The requested date range covering the report duration.

Returns:

value or null for none

setDateRange

public ReportDataQueryRequest setDateRange(DateRange dateRange)

Optional. The requested date range covering the report duration.

Parameters:

dateRange - dateRange or null for none

getDimensionFilters

public List<DimensionValue> getDimensionFilters()

Optional. The list of dimension values on which report lines are filtered. Utilizes the existing legacy filter message `DimensionValue`.

Returns:

value or null for none

setDimensionFilters

public ReportDataQueryRequest setDimensionFilters(List<DimensionValue> dimensionFilters)

Optional. The list of dimension values on which report lines are filtered. Utilizes the existing legacy filter message `DimensionValue`.

Parameters:

dimensionFilters - dimensionFilters or null for none

getDimensionNames

public List<String> getDimensionNames()

Optional. The list of dimension names to group by.

Returns:

value or null for none

setDimensionNames

public ReportDataQueryRequest setDimensionNames(List<String> dimensionNames)

Optional. The list of dimension names to group by.

Parameters:

dimensionNames - dimensionNames or null for none

getMaxResults

public Integer getMaxResults()

Optional. Maximum number of result rows to return per page. The default value is 100. The maximum allowed value is 1000. Values above 1000 will be coerced (clamped) down to 1000. Negative values will be rejected.

Returns:

value or null for none

setMaxResults

public ReportDataQueryRequest setMaxResults(Integer maxResults)

Optional. Maximum number of result rows to return per page. The default value is 100. The maximum allowed value is 1000. Values above 1000 will be coerced (clamped) down to 1000. Negative values will be rejected.

Parameters:

maxResults - maxResults or null for none

getMetricNames

public List<String> getMetricNames()

Required. The list of metric names to include.

Returns:

value or null for none

setMetricNames

public ReportDataQueryRequest setMetricNames(List<String> metricNames)

Required. The list of metric names to include.

Parameters:

metricNames - metricNames or null for none

getPageToken

public String getPageToken()

Optional. Continuation token for paginating results.

Returns:

value or null for none

setPageToken

public ReportDataQueryRequest setPageToken(String pageToken)

Optional. Continuation token for paginating results.

Parameters:

pageToken - pageToken or null for none

getSortBys

public List<SortBy> getSortBys()

Optional. Sort options across either requested dimensions or metrics.

Returns:

value or null for none

setSortBys

public ReportDataQueryRequest setSortBys(List<SortBy> sortBys)

Optional. Sort options across either requested dimensions or metrics.

Parameters:

sortBys - sortBys or null for none

set

public ReportDataQueryRequest set(String fieldName,
                                  Object value)

Overrides:

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

clone

public ReportDataQueryRequest clone()

Overrides:

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