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

Class ResponseMetaData

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Response's metadata carrying additional information about the report content.

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

Method Summary

Modifier and Type	Method and Description
ResponseMetaData	clone()
String	getCurrencyCode() The currency code used in this report.
Boolean	getDataLossFromOtherRow() If true, indicates some buckets of dimension combinations are rolled into "(other)" row.
String	getEmptyReason() If empty reason is specified, the report is empty for this reason.
SchemaRestrictionResponse	getSchemaRestrictionResponse() Describes the schema restrictions actively enforced in creating this report.
Boolean	getSubjectToThresholding() If `subjectToThresholding` is true, this report is subject to thresholding and only returns data that meets the minimum aggregation thresholds.
String	getTimeZone() The property's current timezone.
ResponseMetaData	set(String fieldName, Object value)
ResponseMetaData	setCurrencyCode(String currencyCode) The currency code used in this report.
ResponseMetaData	setDataLossFromOtherRow(Boolean dataLossFromOtherRow) If true, indicates some buckets of dimension combinations are rolled into "(other)" row.
ResponseMetaData	setEmptyReason(String emptyReason) If empty reason is specified, the report is empty for this reason.
ResponseMetaData	setSchemaRestrictionResponse(SchemaRestrictionResponse schemaRestrictionResponse) Describes the schema restrictions actively enforced in creating this report.
ResponseMetaData	setSubjectToThresholding(Boolean subjectToThresholding) If `subjectToThresholding` is true, this report is subject to thresholding and only returns data that meets the minimum aggregation thresholds.
ResponseMetaData	setTimeZone(String timeZone) The property's current timezone.

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

ResponseMetaData

public ResponseMetaData()

Method Detail

getCurrencyCode

public String getCurrencyCode()

The currency code used in this report. Intended to be used in formatting currency metrics like `purchaseRevenue` for visualization. If currency_code was specified in the request, this response parameter will echo the request parameter; otherwise, this response parameter is the property's current currency_code. Currency codes are string encodings of currency types from the ISO 4217 standard (https://en.wikipedia.org/wiki/ISO_4217); for example "USD", "EUR", "JPY". To learn more, see https://support.google.com/analytics/answer/9796179.

Returns:

value or null for none

setCurrencyCode

public ResponseMetaData setCurrencyCode(String currencyCode)

The currency code used in this report. Intended to be used in formatting currency metrics like `purchaseRevenue` for visualization. If currency_code was specified in the request, this response parameter will echo the request parameter; otherwise, this response parameter is the property's current currency_code. Currency codes are string encodings of currency types from the ISO 4217 standard (https://en.wikipedia.org/wiki/ISO_4217); for example "USD", "EUR", "JPY". To learn more, see https://support.google.com/analytics/answer/9796179.

Parameters:

currencyCode - currencyCode or null for none

getDataLossFromOtherRow

public Boolean getDataLossFromOtherRow()

If true, indicates some buckets of dimension combinations are rolled into "(other)" row. This can happen for high cardinality reports.

Returns:

value or null for none

setDataLossFromOtherRow

public ResponseMetaData setDataLossFromOtherRow(Boolean dataLossFromOtherRow)

If true, indicates some buckets of dimension combinations are rolled into "(other)" row. This can happen for high cardinality reports.

Parameters:

dataLossFromOtherRow - dataLossFromOtherRow 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 ResponseMetaData setEmptyReason(String emptyReason)

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

Parameters:

emptyReason - emptyReason or null for none

getSchemaRestrictionResponse

public SchemaRestrictionResponse getSchemaRestrictionResponse()

Describes the schema restrictions actively enforced in creating this report. To learn more, see [Access and data-restriction management](https://support.google.com/analytics/answer/10851388).

Returns:

value or null for none

setSchemaRestrictionResponse

public ResponseMetaData setSchemaRestrictionResponse(SchemaRestrictionResponse schemaRestrictionResponse)

Describes the schema restrictions actively enforced in creating this report. To learn more, see [Access and data-restriction management](https://support.google.com/analytics/answer/10851388).

Parameters:

schemaRestrictionResponse - schemaRestrictionResponse or null for none

getSubjectToThresholding

public Boolean getSubjectToThresholding()

If `subjectToThresholding` is true, this report is subject to thresholding and only returns data that meets the minimum aggregation thresholds. It is possible for a request to be subject to thresholding thresholding and no data is absent from the report, and this happens when all data is above the thresholds. To learn more, see [Data thresholds](https://support.google.com/analytics/answer/9383630) and [About Demographics and Interests](https://support.google.com/analytics/answer/2799357).

Returns:

value or null for none

setSubjectToThresholding

public ResponseMetaData setSubjectToThresholding(Boolean subjectToThresholding)

If `subjectToThresholding` is true, this report is subject to thresholding and only returns data that meets the minimum aggregation thresholds. It is possible for a request to be subject to thresholding thresholding and no data is absent from the report, and this happens when all data is above the thresholds. To learn more, see [Data thresholds](https://support.google.com/analytics/answer/9383630) and [About Demographics and Interests](https://support.google.com/analytics/answer/2799357).

Parameters:

subjectToThresholding - subjectToThresholding or null for none

getTimeZone

public String getTimeZone()

The property's current timezone. Intended to be used to interpret time-based dimensions like `hour` and `minute`. Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example "America/New_York" or "Asia/Tokyo".

Returns:

value or null for none

setTimeZone

public ResponseMetaData setTimeZone(String timeZone)

The property's current timezone. Intended to be used to interpret time-based dimensions like `hour` and `minute`. Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example "America/New_York" or "Asia/Tokyo".

Parameters:

timeZone - timeZone or null for none

set

public ResponseMetaData set(String fieldName,
                            Object value)

Overrides:

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

clone

public ResponseMetaData clone()

Overrides:

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