Package com.google.analytics.data.v1beta

Interface ResponseMetaDataOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ResponseMetaData, ResponseMetaData.Builder
@Generated public interface ResponseMetaDataOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCurrencyCode()
    The currency code used in this report.
    com.google.protobuf.ByteString
    getCurrencyCodeBytes()
    The currency code used in this report.
    boolean
    getDataLossFromOtherRow()
    If true, indicates some buckets of dimension combinations are rolled into "(other)" row.
    String
    getEmptyReason()
    If empty reason is specified, the report is empty for this reason.
    com.google.protobuf.ByteString
    getEmptyReasonBytes()
    If empty reason is specified, the report is empty for this reason.
    SamplingMetadata
    getSamplingMetadatas(int index)
    If this report results is [sampled](https://support.google.com/analytics/answer/13331292), this describes the percentage of events used in this report.
    int
    getSamplingMetadatasCount()
    If this report results is [sampled](https://support.google.com/analytics/answer/13331292), this describes the percentage of events used in this report.
    List<SamplingMetadata>
    getSamplingMetadatasList()
    If this report results is [sampled](https://support.google.com/analytics/answer/13331292), this describes the percentage of events used in this report.
    SamplingMetadataOrBuilder
    getSamplingMetadatasOrBuilder(int index)
    If this report results is [sampled](https://support.google.com/analytics/answer/13331292), this describes the percentage of events used in this report.
    List<? extends SamplingMetadataOrBuilder>
    getSamplingMetadatasOrBuilderList()
    If this report results is [sampled](https://support.google.com/analytics/answer/13331292), this describes the percentage of events used in this report.
    ResponseMetaData.SchemaRestrictionResponse
    getSchemaRestrictionResponse()
    Describes the schema restrictions actively enforced in creating this report.
    ResponseMetaData.SchemaRestrictionResponseOrBuilder
    getSchemaRestrictionResponseOrBuilder()
    Describes the schema restrictions actively enforced in creating this report.
    boolean
    getSubjectToThresholding()
    If `subjectToThresholding` is true, this report is subject to thresholding and only returns data that meets the minimum aggregation thresholds.
    String
    getTimeZone()
    The property's current timezone.
    com.google.protobuf.ByteString
    getTimeZoneBytes()
    The property's current timezone.
    boolean
    hasCurrencyCode()
    The currency code used in this report.
    boolean
    hasEmptyReason()
    If empty reason is specified, the report is empty for this reason.
    boolean
    hasSchemaRestrictionResponse()
    Describes the schema restrictions actively enforced in creating this report.
    boolean
    hasSubjectToThresholding()
    If `subjectToThresholding` is true, this report is subject to thresholding and only returns data that meets the minimum aggregation thresholds.
    boolean
    hasTimeZone()
    The property's current timezone.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getDataLossFromOtherRow

      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](https://support.google.com/analytics/answer/13208658#reports).
      bool data_loss_from_other_row = 3;
      Returns:
      The dataLossFromOtherRow.

    • hasSchemaRestrictionResponse

      boolean hasSchemaRestrictionResponse()
       Describes the schema restrictions actively enforced in creating this
 report. To learn more, see [Access and data-restriction
 management](https://support.google.com/analytics/answer/10851388).
      optional .google.analytics.data.v1beta.ResponseMetaData.SchemaRestrictionResponse schema_restriction_response = 4;
      Returns:
      Whether the schemaRestrictionResponse field is set.

    • getSchemaRestrictionResponse

      ResponseMetaData.SchemaRestrictionResponse getSchemaRestrictionResponse()
       Describes the schema restrictions actively enforced in creating this
 report. To learn more, see [Access and data-restriction
 management](https://support.google.com/analytics/answer/10851388).
      optional .google.analytics.data.v1beta.ResponseMetaData.SchemaRestrictionResponse schema_restriction_response = 4;
      Returns:
      The schemaRestrictionResponse.

    • getSchemaRestrictionResponseOrBuilder

      ResponseMetaData.SchemaRestrictionResponseOrBuilder getSchemaRestrictionResponseOrBuilder()
       Describes the schema restrictions actively enforced in creating this
 report. To learn more, see [Access and data-restriction
 management](https://support.google.com/analytics/answer/10851388).
      optional .google.analytics.data.v1beta.ResponseMetaData.SchemaRestrictionResponse schema_restriction_response = 4;

    • hasCurrencyCode

      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:
      Whether the currencyCode field is set.

    • getCurrencyCode

      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:
      The currencyCode.

    • getCurrencyCodeBytes

      com.google.protobuf.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:
      The bytes for currencyCode.

    • hasTimeZone

      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:
      Whether the timeZone field is set.

    • getTimeZone

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

    • getTimeZoneBytes

      com.google.protobuf.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:
      The bytes for timeZone.

    • hasEmptyReason

      boolean hasEmptyReason()
       If empty reason is specified, the report is empty for this reason.
      optional string empty_reason = 7;
      Returns:
      Whether the emptyReason field is set.

    • getEmptyReason

      String getEmptyReason()
       If empty reason is specified, the report is empty for this reason.
      optional string empty_reason = 7;
      Returns:
      The emptyReason.

    • getEmptyReasonBytes

      com.google.protobuf.ByteString getEmptyReasonBytes()
       If empty reason is specified, the report is empty for this reason.
      optional string empty_reason = 7;
      Returns:
      The bytes for emptyReason.

    • hasSubjectToThresholding

      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](https://support.google.com/analytics/answer/9383630).
      optional bool subject_to_thresholding = 8;
      Returns:
      Whether the subjectToThresholding field is set.

    • getSubjectToThresholding

      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](https://support.google.com/analytics/answer/9383630).
      optional bool subject_to_thresholding = 8;
      Returns:
      The subjectToThresholding.

    • getSamplingMetadatasList

      List<SamplingMetadata> getSamplingMetadatasList()
       If this report results is
 [sampled](https://support.google.com/analytics/answer/13331292), 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;

    • getSamplingMetadatas

      SamplingMetadata getSamplingMetadatas(int index)
       If this report results is
 [sampled](https://support.google.com/analytics/answer/13331292), 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;

    • getSamplingMetadatasCount

      int getSamplingMetadatasCount()
       If this report results is
 [sampled](https://support.google.com/analytics/answer/13331292), 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;

    • getSamplingMetadatasOrBuilderList

      List<? extends SamplingMetadataOrBuilder> getSamplingMetadatasOrBuilderList()
       If this report results is
 [sampled](https://support.google.com/analytics/answer/13331292), 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;

    • getSamplingMetadatasOrBuilder

      SamplingMetadataOrBuilder getSamplingMetadatasOrBuilder(int index)
       If this report results is
 [sampled](https://support.google.com/analytics/answer/13331292), 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;