Interface ResponseMetaDataOrBuilder (0.40.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()

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.

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 and About Demographics and Interests.

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

optional string time_zone = 6;

Returns
Type	Description
`ByteString`	The bytes for timeZone.

hasCurrencyCode()

public abstract boolean hasCurrencyCode()

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

optional bool subject_to_thresholding = 8;

Returns
Type	Description
`boolean`	Whether the subjectToThresholding field is set.

hasTimeZone()

public abstract boolean hasTimeZone()

optional string time_zone = 6;

Returns
Type	Description
`boolean`	Whether the timeZone field is set.