Google Analytics Data V1beta Client - Class ResponseMetaData (0.10.1)

Reference documentation and code samples for the Google Analytics Data V1beta Client class ResponseMetaData.

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

Generated from protobuf message google.analytics.data.v1beta.ResponseMetaData

Namespace

Google \ Analytics \ Data \ V1beta

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ data_loss_from_other_row`	`bool` If true, indicates some buckets of dimension combinations are rolled into "(other)" row. This can happen for high cardinality reports.
`↳ schema_restriction_response`	`Google\Analytics\Data\V1beta\ResponseMetaData\SchemaRestrictionResponse` Describes the schema restrictions actively enforced in creating this report. To learn more, see Access and data-restriction management.
`↳ currency_code`	`string` 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.
`↳ time_zone`	`string` 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".
`↳ empty_reason`	`string` If empty reason is specified, the report is empty for this reason.
`↳ subject_to_thresholding`	`bool` 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.

getDataLossFromOtherRow

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

Returns
Type	Description
`bool`

setDataLossFromOtherRow

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

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getSchemaRestrictionResponse

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

Returns
Type	Description
`Google\Analytics\Data\V1beta\ResponseMetaData\SchemaRestrictionResponse\|null`

hasSchemaRestrictionResponse

clearSchemaRestrictionResponse

setSchemaRestrictionResponse

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

Parameter
Name	Description
`var`	`Google\Analytics\Data\V1beta\ResponseMetaData\SchemaRestrictionResponse`

Returns
Type	Description
`$this`

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
Type	Description
`string`

hasCurrencyCode

clearCurrencyCode

setCurrencyCode

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

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
Type	Description
`string`

hasTimeZone

clearTimeZone

setTimeZone

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getEmptyReason

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

Returns
Type	Description
`string`

hasEmptyReason

clearEmptyReason

setEmptyReason

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

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.

Returns
Type	Description
`bool`

hasSubjectToThresholding

clearSubjectToThresholding

setSubjectToThresholding

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`