com.google.api.services.analyticsdata.v1beta.model

Class RunPivotReportResponse

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.analyticsdata.v1beta.model.RunPivotReportResponse

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

The response pivot report table corresponding to a pivot request.

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 Google Analytics Data 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
RunPivotReportResponse()

Method Summary

Modifier and Type	Method and Description
RunPivotReportResponse	clone()
List<Row>	getAggregates() Aggregation of metric values.
List<DimensionHeader>	getDimensionHeaders() Describes dimension columns.
String	getKind() Identifies what kind of resource this message is.
ResponseMetaData	getMetadata() Metadata for the report.
List<MetricHeader>	getMetricHeaders() Describes metric columns.
List<PivotHeader>	getPivotHeaders() Summarizes the columns and rows created by a pivot.
PropertyQuota	getPropertyQuota() This Analytics Property's quota state including this request.
List<Row>	getRows() Rows of dimension value combinations and metric values in the report.
RunPivotReportResponse	set(String fieldName, Object value)
RunPivotReportResponse	setAggregates(List<Row> aggregates) Aggregation of metric values.
RunPivotReportResponse	setDimensionHeaders(List<DimensionHeader> dimensionHeaders) Describes dimension columns.
RunPivotReportResponse	setKind(String kind) Identifies what kind of resource this message is.
RunPivotReportResponse	setMetadata(ResponseMetaData metadata) Metadata for the report.
RunPivotReportResponse	setMetricHeaders(List<MetricHeader> metricHeaders) Describes metric columns.
RunPivotReportResponse	setPivotHeaders(List<PivotHeader> pivotHeaders) Summarizes the columns and rows created by a pivot.
RunPivotReportResponse	setPropertyQuota(PropertyQuota propertyQuota) This Analytics Property's quota state including this request.
RunPivotReportResponse	setRows(List<Row> rows) Rows of dimension value combinations and metric values in 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

RunPivotReportResponse

public RunPivotReportResponse()

Method Detail

getAggregates

public List<Row> getAggregates()

Aggregation of metric values. Can be totals, minimums, or maximums. The returned aggregations are controlled by the metric_aggregations in the pivot. The type of aggregation returned in each row is shown by the dimension_values which are set to "RESERVED_".

Returns:

value or null for none

setAggregates

public RunPivotReportResponse setAggregates(List<Row> aggregates)

Aggregation of metric values. Can be totals, minimums, or maximums. The returned aggregations are controlled by the metric_aggregations in the pivot. The type of aggregation returned in each row is shown by the dimension_values which are set to "RESERVED_".

Parameters:

aggregates - aggregates or null for none

getDimensionHeaders

public List<DimensionHeader> getDimensionHeaders()

Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.

Returns:

value or null for none

setDimensionHeaders

public RunPivotReportResponse setDimensionHeaders(List<DimensionHeader> dimensionHeaders)

Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows.

Parameters:

dimensionHeaders - dimensionHeaders or null for none

getKind

public String getKind()

Identifies what kind of resource this message is. This `kind` is always the fixed string "analyticsData#runPivotReport". Useful to distinguish between response types in JSON.

Returns:

value or null for none

setKind

public RunPivotReportResponse setKind(String kind)

Identifies what kind of resource this message is. This `kind` is always the fixed string "analyticsData#runPivotReport". Useful to distinguish between response types in JSON.

Parameters:

kind - kind or null for none

getMetadata

public ResponseMetaData getMetadata()

Metadata for the report.

Returns:

value or null for none

setMetadata

public RunPivotReportResponse setMetadata(ResponseMetaData metadata)

Metadata for the report.

Parameters:

metadata - metadata or null for none

getMetricHeaders

public List<MetricHeader> getMetricHeaders()

Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.

Returns:

value or null for none

setMetricHeaders

public RunPivotReportResponse setMetricHeaders(List<MetricHeader> metricHeaders)

Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows.

Parameters:

metricHeaders - metricHeaders or null for none

getPivotHeaders

public List<PivotHeader> getPivotHeaders()

Summarizes the columns and rows created by a pivot. Each pivot in the request produces one header in the response. If we have a request like this: "pivots": [{ "fieldNames": ["country", "city"] }, { "fieldNames": "eventName" }] We will have the following `pivotHeaders` in the response: "pivotHeaders" : [{ "dimensionHeaders": [{ "dimensionValues": [ { "value": "United Kingdom" }, { "value": "London" } ] }, { "dimensionValues": [ { "value": "Japan" }, { "value": "Osaka" } ] }] }, { "dimensionHeaders": [{ "dimensionValues": [{ "value": "session_start" }] }, { "dimensionValues": [{ "value": "scroll" }] }] }]

Returns:

value or null for none

setPivotHeaders

public RunPivotReportResponse setPivotHeaders(List<PivotHeader> pivotHeaders)

Summarizes the columns and rows created by a pivot. Each pivot in the request produces one header in the response. If we have a request like this: "pivots": [{ "fieldNames": ["country", "city"] }, { "fieldNames": "eventName" }] We will have the following `pivotHeaders` in the response: "pivotHeaders" : [{ "dimensionHeaders": [{ "dimensionValues": [ { "value": "United Kingdom" }, { "value": "London" } ] }, { "dimensionValues": [ { "value": "Japan" }, { "value": "Osaka" } ] }] }, { "dimensionHeaders": [{ "dimensionValues": [{ "value": "session_start" }] }, { "dimensionValues": [{ "value": "scroll" }] }] }]

Parameters:

pivotHeaders - pivotHeaders or null for none

getPropertyQuota

public PropertyQuota getPropertyQuota()

This Analytics Property's quota state including this request.

Returns:

value or null for none

setPropertyQuota

public RunPivotReportResponse setPropertyQuota(PropertyQuota propertyQuota)

This Analytics Property's quota state including this request.

Parameters:

propertyQuota - propertyQuota or null for none

getRows

public List<Row> getRows()

Rows of dimension value combinations and metric values in the report.

Returns:

value or null for none

setRows

public RunPivotReportResponse setRows(List<Row> rows)

Rows of dimension value combinations and metric values in the report.

Parameters:

rows - rows or null for none

set

public RunPivotReportResponse set(String fieldName,
                                  Object value)

Overrides:

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

clone

public RunPivotReportResponse clone()

Overrides:

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