ResponseMetaData

  • Response metadata provides additional information about report content.

  • The dataLossFromOtherRow field is a boolean indicating if some dimension combinations are rolled into an "(other)" row, which can occur in high cardinality reports.

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

JSON representation 
{
  "dataLossFromOtherRow": boolean,
  "samplingMetadatas": [
    {
      object (SamplingMetadata)
    }
  ],
  "section": enum (Section),
  "dataTruncationReasons": [
    {
      object (DataTruncationReason)
    }
  ],
  "schemaRestrictionResponse": {
    object (SchemaRestrictionResponse)
  },
  "currencyCode": string,
  "timeZone": string,
  "emptyReason": string,
  "subjectToThresholding": boolean
}
Fields
dataLossFromOtherRow

boolean

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.
samplingMetadatas[]

object (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.
section

enum (Section)

Identifies the type of data in the report.
dataTruncationReasons[]

object (DataTruncationReason)

If set, indicate there is data truncation in the report.
schemaRestrictionResponse

object (SchemaRestrictionResponse)

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

string

The currency code used in this report. Intended to be used in formatting currency metrics like purchaseRevenue for visualization. If currencyCode was specified in the request, this response parameter will echo the request parameter; otherwise, this response parameter is the property's current currencyCode.

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

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

string

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

boolean

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.

SchemaRestrictionResponse

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

JSON representation 
{
  "activeMetricRestrictions": [
    {
      object (ActiveMetricRestriction)
    }
  ]
}
Fields
activeMetricRestrictions[]

object (ActiveMetricRestriction)

All restrictions actively enforced in creating the report. For example, purchaseRevenue always has the restriction type REVENUE_DATA. However, this active response restriction is only populated if the user's custom role disallows access to REVENUE_DATA.

ActiveMetricRestriction

A metric actively restricted in creating the report.

JSON representation 
{
  "restrictedMetricTypes": [
    enum (RestrictedMetricType)
  ],
  "metricName": string
}
Fields
restrictedMetricTypes[]

enum (RestrictedMetricType)

The reason for this metric's restriction.
metricName

string

The name of the restricted metric.

RestrictedMetricType

Categories of data that you may be restricted from viewing on certain Google Analytics properties.

Enums
RESTRICTED_METRIC_TYPE_UNSPECIFIED Unspecified type.
COST_DATA Cost metrics such as adCost.
REVENUE_DATA Revenue metrics such as purchaseRevenue.

DataTruncationReason

Describes a reason for data truncation in the report.

JSON representation 
{
  "dataTruncationDateRanges": [
    {
      object (DataTruncationDateRange)
    }
  ],
  "dataTruncationType": enum (DataTruncationType),
  "dataTruncationMessage": string,
  "dataTruncationDate": string
}
Fields
dataTruncationDateRanges[]

object (DataTruncationDateRange)

The truncated date ranges.
dataTruncationType

enum (DataTruncationType)

The type of data truncation.
dataTruncationMessage

string

A descriptive message explaining the data truncation.
dataTruncationDate

string

The data truncation date in the format YYYY-MM-DD. Indicates data before this date is truncated.

DataTruncationType

The type of data truncation.

Enums
DATA_TRUNCATION_TYPE_UNSPECIFIED Unspecified type.
DATA_TRUNCATION_TYPE_RULES_BASED_MODELS Data is truncated in attribution report for rules-based models golden date.
DATA_TRUNCATION_TYPE_DATA_DRIVEN_ATTRIBUTION Data is truncated in attribution report for data driven attribution golden date.
DATA_TRUNCATION_TYPE_DV360 Data is truncated because DV360 policy does not permit data older than 2 years from being returned.
DATA_TRUNCATION_TYPE_CM360 Data is truncated because CM360 policy does not permit data older than 2 years from being returned.
DATA_TRUNCATION_TYPE_ITEM_SCOPED_ECOMMERCE_METRICS New item-scoped ecommerce metrics only have data after a specific date.
DATA_TRUNCATION_TYPE_EVENT_SCOPED_ECOMMERCE_METRICS New event-scoped ecommerce metrics only have data after a specific date.
DATA_TRUNCATION_TYPE_DATE_RANGE Query date range may not be fully served.
DATA_TRUNCATION_TYPE_PROPERTY Data truncated because the query attempts to read event data prior to its retention date.
DATA_TRUNCATION_TYPE_CONVERSIONS Data is truncated in conversions report.
DATA_TRUNCATION_TYPE_GOOGLE_ADS Data is truncated due to Google Ads 36 month retention policy.

DataTruncationDateRange

Define the truncated date range from startDate to endDate.

JSON representation 
{
  "startDate": string,
  "endDate": string
}
Fields
startDate

string

The start date in the format YYYY-MM-DD (inclusive).
endDate

string

The end date in the format YYYY-MM-DD (inclusive).