Interface ResponseMetaDataOrBuilder (0.47.0)

Version 0.47.0

• 0.66.0 (latest)
• 0.65.0
• 0.64.0
• 0.63.0
• 0.62.0
• 0.60.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0

public interface ResponseMetaDataOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCurrencyCode()

public abstract 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.

optional string currency_code = 5;

Returns
Type	Description
String	The currencyCode.

getCurrencyCodeBytes()

public abstract ByteString getCurrencyCodeBytes()

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.

optional string currency_code = 5;

Returns
Type	Description
ByteString	The bytes for currencyCode.

getDataLossFromOtherRow()

public abstract boolean getDataLossFromOtherRow()

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

The metadata parameter dataLossFromOtherRow is populated based on the aggregated data table used in the report. The parameter will be accurately populated regardless of the filters and limits in the report.

For example, the (other) row could be dropped from the report because the request contains a filter on sessionSource = google. This parameter will still be populated if data loss from other row was present in the input aggregate data used to generate this report.

To learn more, see About the (other) row and data sampling.

bool data_loss_from_other_row = 3;

Returns
Type	Description
boolean	The dataLossFromOtherRow.

getEmptyReason()

public abstract String getEmptyReason()

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

optional string empty_reason = 7;

Returns
Type	Description
String	The emptyReason.

getEmptyReasonBytes()

public abstract ByteString getEmptyReasonBytes()

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

optional string empty_reason = 7;

Returns
Type	Description
ByteString	The bytes for emptyReason.

getSamplingMetadatas(int index)

public abstract SamplingMetadata getSamplingMetadatas(int index)

If this report results is sampled, this describes the percentage of events used in this report. One samplingMetadatas is populated for each date range. Each samplingMetadatas corresponds to a date range in order that date ranges were specified in the request.

However if the results are not sampled, this field will not be defined.

repeated .google.analytics.data.v1beta.SamplingMetadata sampling_metadatas = 9;

Parameter
Name	Description
index	int

Returns
Type	Description
SamplingMetadata

getSamplingMetadatasCount()

public abstract int getSamplingMetadatasCount()

If this report results is sampled, this describes the percentage of events used in this report. One samplingMetadatas is populated for each date range. Each samplingMetadatas corresponds to a date range in order that date ranges were specified in the request.

However if the results are not sampled, this field will not be defined.

repeated .google.analytics.data.v1beta.SamplingMetadata sampling_metadatas = 9;

Returns
Type	Description
int

getSamplingMetadatasList()

public abstract List<SamplingMetadata> getSamplingMetadatasList()

If this report results is sampled, this describes the percentage of events used in this report. One samplingMetadatas is populated for each date range. Each samplingMetadatas corresponds to a date range in order that date ranges were specified in the request.

However if the results are not sampled, this field will not be defined.

repeated .google.analytics.data.v1beta.SamplingMetadata sampling_metadatas = 9;

Returns
Type	Description
List<SamplingMetadata>

getSamplingMetadatasOrBuilder(int index)

public abstract SamplingMetadataOrBuilder getSamplingMetadatasOrBuilder(int index)

If this report results is sampled, this describes the percentage of events used in this report. One samplingMetadatas is populated for each date range. Each samplingMetadatas corresponds to a date range in order that date ranges were specified in the request.

However if the results are not sampled, this field will not be defined.

repeated .google.analytics.data.v1beta.SamplingMetadata sampling_metadatas = 9;

Parameter
Name	Description
index	int

Returns
Type	Description
SamplingMetadataOrBuilder

getSamplingMetadatasOrBuilderList()

public abstract List<? extends SamplingMetadataOrBuilder> getSamplingMetadatasOrBuilderList()

If this report results is sampled, this describes the percentage of events used in this report. One samplingMetadatas is populated for each date range. Each samplingMetadatas corresponds to a date range in order that date ranges were specified in the request.

However if the results are not sampled, this field will not be defined.

repeated .google.analytics.data.v1beta.SamplingMetadata sampling_metadatas = 9;

Returns
Type	Description
List<? extends com.google.analytics.data.v1beta.SamplingMetadataOrBuilder>

getSchemaRestrictionResponse()

public abstract ResponseMetaData.SchemaRestrictionResponse getSchemaRestrictionResponse()

Describes the schema restrictions actively enforced in creating this report. To learn more, see Access and data-restriction management.

optional .google.analytics.data.v1beta.ResponseMetaData.SchemaRestrictionResponse schema_restriction_response = 4;

Returns
Type	Description
ResponseMetaData.SchemaRestrictionResponse	The schemaRestrictionResponse.

getSchemaRestrictionResponseOrBuilder()

public abstract ResponseMetaData.SchemaRestrictionResponseOrBuilder getSchemaRestrictionResponseOrBuilder()

Describes the schema restrictions actively enforced in creating this report. To learn more, see Access and data-restriction management.

optional .google.analytics.data.v1beta.ResponseMetaData.SchemaRestrictionResponse schema_restriction_response = 4;

Returns
Type	Description
ResponseMetaData.SchemaRestrictionResponseOrBuilder

getSubjectToThresholding()

public abstract 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.

optional bool subject_to_thresholding = 8;

Returns
Type	Description
boolean	The subjectToThresholding.

getTimeZone()

public abstract 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".

optional string time_zone = 6;

Returns
Type	Description
String	The timeZone.

getTimeZoneBytes()

public abstract ByteString getTimeZoneBytes()

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

optional string time_zone = 6;

Returns
Type	Description
ByteString	The bytes for timeZone.

hasCurrencyCode()

public abstract boolean hasCurrencyCode()

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.

optional string currency_code = 5;

Returns
Type	Description
boolean	Whether the currencyCode field is set.

hasEmptyReason()

public abstract boolean hasEmptyReason()

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

optional string empty_reason = 7;

Returns
Type	Description
boolean	Whether the emptyReason field is set.

hasSchemaRestrictionResponse()

public abstract boolean hasSchemaRestrictionResponse()

Describes the schema restrictions actively enforced in creating this report. To learn more, see Access and data-restriction management.

optional .google.analytics.data.v1beta.ResponseMetaData.SchemaRestrictionResponse schema_restriction_response = 4;

Returns
Type	Description
boolean	Whether the schemaRestrictionResponse field is set.

hasSubjectToThresholding()

public abstract boolean hasSubjectToThresholding()

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.

optional bool subject_to_thresholding = 8;

Returns
Type	Description
boolean	Whether the subjectToThresholding field is set.

hasTimeZone()

public abstract boolean hasTimeZone()

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

optional string time_zone = 6;

Returns
Type	Description
boolean	Whether the timeZone field is set.