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 \ V1betaMethods
__construct
Constructor.
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. 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 .
↳ schema_restriction_response
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
.
↳ sampling_metadatas
array< SamplingMetadata
>
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.
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
setDataLossFromOtherRow
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 .
var
bool
$this
getSchemaRestrictionResponse
Describes the schema restrictions actively enforced in creating this report. To learn more, see Access and data-restriction management .
hasSchemaRestrictionResponse
clearSchemaRestrictionResponse
setSchemaRestrictionResponse
Describes the schema restrictions actively enforced in creating this report. To learn more, see Access and data-restriction management .
$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 .
string
hasCurrencyCode
clearCurrencyCode
setCurrencyCode
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 .
var
string
$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".
string
hasTimeZone
clearTimeZone
setTimeZone
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".
var
string
$this
getEmptyReason
If empty reason is specified, the report is empty for this reason.
string
hasEmptyReason
clearEmptyReason
setEmptyReason
If empty reason is specified, the report is empty for this reason.
var
string
$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
.
bool
hasSubjectToThresholding
clearSubjectToThresholding
setSubjectToThresholding
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
.
var
bool
$this
getSamplingMetadatas
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.
setSamplingMetadatas
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.
$this
