com.google.api.services.analyticsreporting.v4.model

Class ReportData

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.analyticsreporting.v4.model.ReportData

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ReportData
extends GenericJson

The data part of the 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 Analytics Reporting 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

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
ReportData()

Method Summary

Modifier and Type	Method and Description
ReportData	clone()
String	getDataLastRefreshed() The last time the data in the report was refreshed.
String	getEmptyReason() If empty reason is specified, the report is empty for this reason.
Boolean	getIsDataGolden() Indicates if response to this request is golden or not.
List<DateRangeValues>	getMaximums() Minimum and maximum values seen over all matching rows.
List<DateRangeValues>	getMinimums() Minimum and maximum values seen over all matching rows.
Integer	getRowCount() Total number of matching rows for this query.
List<ReportRow>	getRows() There's one ReportRow for every unique combination of dimensions.
List<Long>	getSamplesReadCounts() If the results are [sampled](https://support.google.com/analytics/answer/2637192), this returns the total number of samples read, one entry per date range.
List<Long>	getSamplingSpaceSizes() If the results are [sampled](https://support.google.com/analytics/answer/2637192), this returns the total number of samples present, one entry per date range.
List<DateRangeValues>	getTotals() For each requested date range, for the set of all rows that match the query, every requested value format gets a total.
ReportData	set(String fieldName, Object value)
ReportData	setDataLastRefreshed(String dataLastRefreshed) The last time the data in the report was refreshed.
ReportData	setEmptyReason(String emptyReason) If empty reason is specified, the report is empty for this reason.
ReportData	setIsDataGolden(Boolean isDataGolden) Indicates if response to this request is golden or not.
ReportData	setMaximums(List<DateRangeValues> maximums) Minimum and maximum values seen over all matching rows.
ReportData	setMinimums(List<DateRangeValues> minimums) Minimum and maximum values seen over all matching rows.
ReportData	setRowCount(Integer rowCount) Total number of matching rows for this query.
ReportData	setRows(List<ReportRow> rows) There's one ReportRow for every unique combination of dimensions.
ReportData	setSamplesReadCounts(List<Long> samplesReadCounts) If the results are [sampled](https://support.google.com/analytics/answer/2637192), this returns the total number of samples read, one entry per date range.
ReportData	setSamplingSpaceSizes(List<Long> samplingSpaceSizes) If the results are [sampled](https://support.google.com/analytics/answer/2637192), this returns the total number of samples present, one entry per date range.
ReportData	setTotals(List<DateRangeValues> totals) For each requested date range, for the set of all rows that match the query, every requested value format gets a total.

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

ReportData

public ReportData()

Method Detail

getDataLastRefreshed

public String getDataLastRefreshed()

The last time the data in the report was refreshed. All the hits received before this timestamp are included in the calculation of the report.

Returns:

value or null for none

setDataLastRefreshed

public ReportData setDataLastRefreshed(String dataLastRefreshed)

The last time the data in the report was refreshed. All the hits received before this timestamp are included in the calculation of the report.

Parameters:

dataLastRefreshed - dataLastRefreshed or null for none

getEmptyReason

public String getEmptyReason()

If empty reason is specified, the report is empty for this reason.

Returns:

value or null for none

setEmptyReason

public ReportData setEmptyReason(String emptyReason)

If empty reason is specified, the report is empty for this reason.

Parameters:

emptyReason - emptyReason or null for none

getIsDataGolden

public Boolean getIsDataGolden()

Indicates if response to this request is golden or not. Data is golden when the exact same request will not produce any new results if asked at a later point in time.

Returns:

value or null for none

setIsDataGolden

public ReportData setIsDataGolden(Boolean isDataGolden)

Indicates if response to this request is golden or not. Data is golden when the exact same request will not produce any new results if asked at a later point in time.

Parameters:

isDataGolden - isDataGolden or null for none

getMaximums

public List<DateRangeValues> getMaximums()

Minimum and maximum values seen over all matching rows. These are both empty when `hideValueRanges` in the request is false, or when rowCount is zero.

Returns:

value or null for none

setMaximums

public ReportData setMaximums(List<DateRangeValues> maximums)

Minimum and maximum values seen over all matching rows. These are both empty when `hideValueRanges` in the request is false, or when rowCount is zero.

Parameters:

maximums - maximums or null for none

getMinimums

public List<DateRangeValues> getMinimums()

Minimum and maximum values seen over all matching rows. These are both empty when `hideValueRanges` in the request is false, or when rowCount is zero.

Returns:

value or null for none

setMinimums

public ReportData setMinimums(List<DateRangeValues> minimums)

Minimum and maximum values seen over all matching rows. These are both empty when `hideValueRanges` in the request is false, or when rowCount is zero.

Parameters:

minimums - minimums or null for none

getRowCount

public Integer getRowCount()

Total number of matching rows for this query.

Returns:

value or null for none

setRowCount

public ReportData setRowCount(Integer rowCount)

Total number of matching rows for this query.

Parameters:

rowCount - rowCount or null for none

getRows

public List<ReportRow> getRows()

There's one ReportRow for every unique combination of dimensions.

Returns:

value or null for none

setRows

public ReportData setRows(List<ReportRow> rows)

There's one ReportRow for every unique combination of dimensions.

Parameters:

rows - rows or null for none

getSamplesReadCounts

public List<Long> getSamplesReadCounts()

If the results are [sampled](https://support.google.com/analytics/answer/2637192), this returns the total number of samples read, one entry per date range. If the results are not sampled this field will not be defined. See [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) for details.

Returns:

value or null for none

setSamplesReadCounts

public ReportData setSamplesReadCounts(List<Long> samplesReadCounts)

If the results are [sampled](https://support.google.com/analytics/answer/2637192), this returns the total number of samples read, one entry per date range. If the results are not sampled this field will not be defined. See [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) for details.

Parameters:

samplesReadCounts - samplesReadCounts or null for none

getSamplingSpaceSizes

public List<Long> getSamplingSpaceSizes()

If the results are [sampled](https://support.google.com/analytics/answer/2637192), this returns the total number of samples present, one entry per date range. If the results are not sampled this field will not be defined. See [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) for details.

Returns:

value or null for none

setSamplingSpaceSizes

public ReportData setSamplingSpaceSizes(List<Long> samplingSpaceSizes)

If the results are [sampled](https://support.google.com/analytics/answer/2637192), this returns the total number of samples present, one entry per date range. If the results are not sampled this field will not be defined. See [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) for details.

Parameters:

samplingSpaceSizes - samplingSpaceSizes or null for none

getTotals

public List<DateRangeValues> getTotals()

For each requested date range, for the set of all rows that match the query, every requested value format gets a total. The total for a value format is computed by first totaling the metrics mentioned in the value format and then evaluating the value format as a scalar expression. E.g., The "totals" for `3 / (ga:sessions + 2)` we compute `3 / ((sum of all relevant ga:sessions) + 2)`. Totals are computed before pagination.

Returns:

value or null for none

setTotals

public ReportData setTotals(List<DateRangeValues> totals)

For each requested date range, for the set of all rows that match the query, every requested value format gets a total. The total for a value format is computed by first totaling the metrics mentioned in the value format and then evaluating the value format as a scalar expression. E.g., The "totals" for `3 / (ga:sessions + 2)` we compute `3 / ((sum of all relevant ga:sessions) + 2)`. Totals are computed before pagination.

Parameters:

totals - totals or null for none

set

public ReportData set(String fieldName,
                      Object value)

Overrides:

set in class GenericJson

clone

public ReportData clone()

Overrides:

clone in class GenericJson