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

Inherits:

Object

• Object
• Google::Analytics::Data::V1beta::ResponseMetaData

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

• #currency_code ⇒ ::String

  The currency code used in this report.

• #data_loss_from_other_row ⇒ ::Boolean

  If true, indicates some buckets of dimension combinations are rolled into "(other)" row.

• #empty_reason ⇒ ::String

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

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

  If this report results is sampled, this describes the percentage of events used in this report.

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

  Describes the schema restrictions actively enforced in creating this report.

• #subject_to_thresholding ⇒ ::Boolean

  If subjectToThresholding is true, this report is subject to thresholding and only returns data that meets the minimum aggregation thresholds.

• #time_zone ⇒ ::String

  The property's current timezone.

Instance Attribute Details

#currency_code ⇒ ::String

# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 761

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

# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 761

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

# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 761

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>

# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 761

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

# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 761

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

# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 761

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

# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 761

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