Class: Google::Analytics::Data::V1beta::ResponseMetaData

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/analytics/data/v1beta/data.rb

Overview

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

Defined Under Namespace

Classes: SchemaRestrictionResponse

Instance Attribute Summary collapse

Instance Attribute Details

#currency_code ⇒ ::String

Returns 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:

  • (::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.



718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
 
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 718

class ResponseMetaData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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).
  # @!attribute [rw] active_metric_restrictions
  #   @return [::Array<::Google::Analytics::Data::V1beta::ResponseMetaData::SchemaRestrictionResponse::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`.
  class SchemaRestrictionResponse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A metric actively restricted in creating the report.
    # @!attribute [rw] metric_name
    #   @return [::String]
    #     The name of the restricted metric.
    # @!attribute [rw] restricted_metric_types
    #   @return [::Array<::Google::Analytics::Data::V1beta::RestrictedMetricType>]
    #     The reason for this metric's restriction.
    class ActiveMetricRestriction
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#data_loss_from_other_row ⇒ ::Boolean

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

Returns:

  • (::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.



718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
 
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 718

class ResponseMetaData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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).
  # @!attribute [rw] active_metric_restrictions
  #   @return [::Array<::Google::Analytics::Data::V1beta::ResponseMetaData::SchemaRestrictionResponse::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`.
  class SchemaRestrictionResponse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A metric actively restricted in creating the report.
    # @!attribute [rw] metric_name
    #   @return [::String]
    #     The name of the restricted metric.
    # @!attribute [rw] restricted_metric_types
    #   @return [::Array<::Google::Analytics::Data::V1beta::RestrictedMetricType>]
    #     The reason for this metric's restriction.
    class ActiveMetricRestriction
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#empty_reason ⇒ ::String

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

Returns:

  • (::String) —

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



718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
 
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 718

class ResponseMetaData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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).
  # @!attribute [rw] active_metric_restrictions
  #   @return [::Array<::Google::Analytics::Data::V1beta::ResponseMetaData::SchemaRestrictionResponse::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`.
  class SchemaRestrictionResponse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A metric actively restricted in creating the report.
    # @!attribute [rw] metric_name
    #   @return [::String]
    #     The name of the restricted metric.
    # @!attribute [rw] restricted_metric_types
    #   @return [::Array<::Google::Analytics::Data::V1beta::RestrictedMetricType>]
    #     The reason for this metric's restriction.
    class ActiveMetricRestriction
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#sampling_metadatas ⇒ ::Array<::Google::Analytics::Data::V1beta::SamplingMetadata>

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

Returns:

  • (::Array<::Google::Analytics::Data::V1beta::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.



718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
 
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 718

class ResponseMetaData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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).
  # @!attribute [rw] active_metric_restrictions
  #   @return [::Array<::Google::Analytics::Data::V1beta::ResponseMetaData::SchemaRestrictionResponse::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`.
  class SchemaRestrictionResponse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A metric actively restricted in creating the report.
    # @!attribute [rw] metric_name
    #   @return [::String]
    #     The name of the restricted metric.
    # @!attribute [rw] restricted_metric_types
    #   @return [::Array<::Google::Analytics::Data::V1beta::RestrictedMetricType>]
    #     The reason for this metric's restriction.
    class ActiveMetricRestriction
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#schema_restriction_response ⇒ ::Google::Analytics::Data::V1beta::ResponseMetaData::SchemaRestrictionResponse

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

Returns:



718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
 
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 718

class ResponseMetaData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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).
  # @!attribute [rw] active_metric_restrictions
  #   @return [::Array<::Google::Analytics::Data::V1beta::ResponseMetaData::SchemaRestrictionResponse::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`.
  class SchemaRestrictionResponse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A metric actively restricted in creating the report.
    # @!attribute [rw] metric_name
    #   @return [::String]
    #     The name of the restricted metric.
    # @!attribute [rw] restricted_metric_types
    #   @return [::Array<::Google::Analytics::Data::V1beta::RestrictedMetricType>]
    #     The reason for this metric's restriction.
    class ActiveMetricRestriction
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#subject_to_thresholding ⇒ ::Boolean

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

Returns:

  • (::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.



718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
 
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 718

class ResponseMetaData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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).
  # @!attribute [rw] active_metric_restrictions
  #   @return [::Array<::Google::Analytics::Data::V1beta::ResponseMetaData::SchemaRestrictionResponse::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`.
  class SchemaRestrictionResponse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A metric actively restricted in creating the report.
    # @!attribute [rw] metric_name
    #   @return [::String]
    #     The name of the restricted metric.
    # @!attribute [rw] restricted_metric_types
    #   @return [::Array<::Google::Analytics::Data::V1beta::RestrictedMetricType>]
    #     The reason for this metric's restriction.
    class ActiveMetricRestriction
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#time_zone ⇒ ::String

Returns 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:

  • (::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".



718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
 
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 718

class ResponseMetaData
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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).
  # @!attribute [rw] active_metric_restrictions
  #   @return [::Array<::Google::Analytics::Data::V1beta::ResponseMetaData::SchemaRestrictionResponse::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`.
  class SchemaRestrictionResponse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A metric actively restricted in creating the report.
    # @!attribute [rw] metric_name
    #   @return [::String]
    #     The name of the restricted metric.
    # @!attribute [rw] restricted_metric_types
    #   @return [::Array<::Google::Analytics::Data::V1beta::RestrictedMetricType>]
    #     The reason for this metric's restriction.
    class ActiveMetricRestriction
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end