Package com.google.analytics.data.v1alpha

Class ResponseMetaData

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.analytics.data.v1alpha.ResponseMetaData
All Implemented Interfaces:
ResponseMetaDataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ResponseMetaData extends com.google.protobuf.GeneratedMessage implements ResponseMetaDataOrBuilder
 Response's metadata carrying additional information about the report content.
Protobuf type google.analytics.data.v1alpha.ResponseMetaData
See Also:

  • Field Details

    • DATA_LOSS_FROM_OTHER_ROW_FIELD_NUMBER

      public static final int DATA_LOSS_FROM_OTHER_ROW_FIELD_NUMBER
      See Also:

    • SCHEMA_RESTRICTION_RESPONSE_FIELD_NUMBER

      public static final int SCHEMA_RESTRICTION_RESPONSE_FIELD_NUMBER
      See Also:

    • CURRENCY_CODE_FIELD_NUMBER

      public static final int CURRENCY_CODE_FIELD_NUMBER
      See Also:

    • TIME_ZONE_FIELD_NUMBER

      public static final int TIME_ZONE_FIELD_NUMBER
      See Also:

    • EMPTY_REASON_FIELD_NUMBER

      public static final int EMPTY_REASON_FIELD_NUMBER
      See Also:

    • SUBJECT_TO_THRESHOLDING_FIELD_NUMBER

      public static final int SUBJECT_TO_THRESHOLDING_FIELD_NUMBER
      See Also:

    • SAMPLING_METADATAS_FIELD_NUMBER

      public static final int SAMPLING_METADATAS_FIELD_NUMBER
      See Also:

    • SECTION_FIELD_NUMBER

      public static final int SECTION_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getDataLossFromOtherRow

      public 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;
      Specified by:
      getDataLossFromOtherRow in interface ResponseMetaDataOrBuilder
      Returns:
      The dataLossFromOtherRow.

    • hasSchemaRestrictionResponse

      public 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.v1alpha.ResponseMetaData.SchemaRestrictionResponse schema_restriction_response = 4;
      Specified by:
      hasSchemaRestrictionResponse in interface ResponseMetaDataOrBuilder
      Returns:
      Whether the schemaRestrictionResponse field is set.

    • getSchemaRestrictionResponse

      public 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.v1alpha.ResponseMetaData.SchemaRestrictionResponse schema_restriction_response = 4;
      Specified by:
      getSchemaRestrictionResponse in interface ResponseMetaDataOrBuilder
      Returns:
      The schemaRestrictionResponse.

    • getSchemaRestrictionResponseOrBuilder

      public 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.v1alpha.ResponseMetaData.SchemaRestrictionResponse schema_restriction_response = 4;
      Specified by:
      getSchemaRestrictionResponseOrBuilder in interface ResponseMetaDataOrBuilder

    • hasCurrencyCode

      public 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;
      Specified by:
      hasCurrencyCode in interface ResponseMetaDataOrBuilder
      Returns:
      Whether the currencyCode field is set.

    • getCurrencyCode

      public 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;
      Specified by:
      getCurrencyCode in interface ResponseMetaDataOrBuilder
      Returns:
      The currencyCode.

    • getCurrencyCodeBytes

      public 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;
      Specified by:
      getCurrencyCodeBytes in interface ResponseMetaDataOrBuilder
      Returns:
      The bytes for currencyCode.

    • hasTimeZone

      public 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;
      Specified by:
      hasTimeZone in interface ResponseMetaDataOrBuilder
      Returns:
      Whether the timeZone field is set.

    • getTimeZone

      public 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;
      Specified by:
      getTimeZone in interface ResponseMetaDataOrBuilder
      Returns:
      The timeZone.

    • getTimeZoneBytes

      public 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;
      Specified by:
      getTimeZoneBytes in interface ResponseMetaDataOrBuilder
      Returns:
      The bytes for timeZone.

    • hasEmptyReason

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

    • getEmptyReason

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

    • getEmptyReasonBytes

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

    • hasSubjectToThresholding

      public 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) and [About
 Demographics and
 Interests](https://support.google.com/analytics/answer/2799357).
      optional bool subject_to_thresholding = 8;
      Specified by:
      hasSubjectToThresholding in interface ResponseMetaDataOrBuilder
      Returns:
      Whether the subjectToThresholding field is set.

    • getSubjectToThresholding

      public 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) and [About
 Demographics and
 Interests](https://support.google.com/analytics/answer/2799357).
      optional bool subject_to_thresholding = 8;
      Specified by:
      getSubjectToThresholding in interface ResponseMetaDataOrBuilder
      Returns:
      The subjectToThresholding.

    • getSamplingMetadatasList

      public 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.v1alpha.SamplingMetadata sampling_metadatas = 9;
      Specified by:
      getSamplingMetadatasList in interface ResponseMetaDataOrBuilder

    • getSamplingMetadatasOrBuilderList

      public 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.v1alpha.SamplingMetadata sampling_metadatas = 9;
      Specified by:
      getSamplingMetadatasOrBuilderList in interface ResponseMetaDataOrBuilder

    • getSamplingMetadatasCount

      public 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.v1alpha.SamplingMetadata sampling_metadatas = 9;
      Specified by:
      getSamplingMetadatasCount in interface ResponseMetaDataOrBuilder

    • getSamplingMetadatas

      public 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.v1alpha.SamplingMetadata sampling_metadatas = 9;
      Specified by:
      getSamplingMetadatas in interface ResponseMetaDataOrBuilder

    • getSamplingMetadatasOrBuilder

      public 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.v1alpha.SamplingMetadata sampling_metadatas = 9;
      Specified by:
      getSamplingMetadatasOrBuilder in interface ResponseMetaDataOrBuilder

    • getSectionValue

      public int getSectionValue()
       Identifies the type of data in the report.
      .google.analytics.data.v1alpha.Section section = 10;
      Specified by:
      getSectionValue in interface ResponseMetaDataOrBuilder
      Returns:
      The enum numeric value on the wire for section.

    • getSection

      public Section getSection()
       Identifies the type of data in the report.
      .google.analytics.data.v1alpha.Section section = 10;
      Specified by:
      getSection in interface ResponseMetaDataOrBuilder
      Returns:
      The section.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ResponseMetaData parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ResponseMetaData parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ResponseMetaData parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ResponseMetaData parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ResponseMetaData parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ResponseMetaData parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ResponseMetaData parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ResponseMetaData parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ResponseMetaData parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ResponseMetaData parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ResponseMetaData parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ResponseMetaData parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ResponseMetaData.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ResponseMetaData.Builder newBuilder()

    • newBuilder

      public static ResponseMetaData.Builder newBuilder(ResponseMetaData prototype)

    • toBuilder

      public ResponseMetaData.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ResponseMetaData.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static ResponseMetaData getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ResponseMetaData> parser()

    • getParserForType

      public com.google.protobuf.Parser<ResponseMetaData> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public ResponseMetaData getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder