Class: Google::Analytics::Data::V1beta::MetricMetadata

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

Overview

Explains a metric.

Defined Under Namespace

Modules: BlockedReason

Instance Attribute Summary collapse

Instance Attribute Details

#api_name ⇒ ::String

Returns A metric name. Useable in Metric's name. For example, eventCount.

Returns:

  • (::String) —

    A metric name. Useable in Metric's name. For example, eventCount.



1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
 
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 1011

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

  # Justifications for why this metric is blocked.
  module BlockedReason
    # Will never be specified in API response.
    BLOCKED_REASON_UNSPECIFIED = 0

    # If present, your access is blocked to revenue related metrics for this
    # property, and this metric is revenue related.
    NO_REVENUE_METRICS = 1

    # If present, your access is blocked to cost related metrics for this
    # property, and this metric is cost related.
    NO_COST_METRICS = 2
  end
end

#blocked_reasons ⇒ ::Array<::Google::Analytics::Data::V1beta::MetricMetadata::BlockedReason>

Returns If reasons are specified, your access is blocked to this metric for this property. API requests from you to this property for this metric will succeed; however, the report will contain only zeros for this metric. API requests with metric filters on blocked metrics will fail. If reasons are empty, you have access to this metric.

To learn more, see Access and data-restriction management.

Returns:



1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
 
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 1011

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

  # Justifications for why this metric is blocked.
  module BlockedReason
    # Will never be specified in API response.
    BLOCKED_REASON_UNSPECIFIED = 0

    # If present, your access is blocked to revenue related metrics for this
    # property, and this metric is revenue related.
    NO_REVENUE_METRICS = 1

    # If present, your access is blocked to cost related metrics for this
    # property, and this metric is cost related.
    NO_COST_METRICS = 2
  end
end

#category ⇒ ::String

Returns The display name of the category that this metrics belongs to. Similar dimensions and metrics are categorized together.

Returns:

  • (::String) —

    The display name of the category that this metrics belongs to. Similar dimensions and metrics are categorized together.



1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
 
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 1011

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

  # Justifications for why this metric is blocked.
  module BlockedReason
    # Will never be specified in API response.
    BLOCKED_REASON_UNSPECIFIED = 0

    # If present, your access is blocked to revenue related metrics for this
    # property, and this metric is revenue related.
    NO_REVENUE_METRICS = 1

    # If present, your access is blocked to cost related metrics for this
    # property, and this metric is cost related.
    NO_COST_METRICS = 2
  end
end

#custom_definition ⇒ ::Boolean

Returns True if the metric is a custom metric for this property.

Returns:

  • (::Boolean) —

    True if the metric is a custom metric for this property.



1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
 
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 1011

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

  # Justifications for why this metric is blocked.
  module BlockedReason
    # Will never be specified in API response.
    BLOCKED_REASON_UNSPECIFIED = 0

    # If present, your access is blocked to revenue related metrics for this
    # property, and this metric is revenue related.
    NO_REVENUE_METRICS = 1

    # If present, your access is blocked to cost related metrics for this
    # property, and this metric is cost related.
    NO_COST_METRICS = 2
  end
end

#deprecated_api_names ⇒ ::Array<::String>

Returns Still usable but deprecated names for this metric. If populated, this metric is available by either apiName or one of deprecatedApiNames for a period of time. After the deprecation period, the metric will be available only by apiName.

Returns:

  • (::Array<::String>) —

    Still usable but deprecated names for this metric. If populated, this metric is available by either apiName or one of deprecatedApiNames for a period of time. After the deprecation period, the metric will be available only by apiName.



1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
 
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 1011

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

  # Justifications for why this metric is blocked.
  module BlockedReason
    # Will never be specified in API response.
    BLOCKED_REASON_UNSPECIFIED = 0

    # If present, your access is blocked to revenue related metrics for this
    # property, and this metric is revenue related.
    NO_REVENUE_METRICS = 1

    # If present, your access is blocked to cost related metrics for this
    # property, and this metric is cost related.
    NO_COST_METRICS = 2
  end
end

#description ⇒ ::String

Returns Description of how this metric is used and calculated.

Returns:

  • (::String) —

    Description of how this metric is used and calculated.



1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
 
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 1011

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

  # Justifications for why this metric is blocked.
  module BlockedReason
    # Will never be specified in API response.
    BLOCKED_REASON_UNSPECIFIED = 0

    # If present, your access is blocked to revenue related metrics for this
    # property, and this metric is revenue related.
    NO_REVENUE_METRICS = 1

    # If present, your access is blocked to cost related metrics for this
    # property, and this metric is cost related.
    NO_COST_METRICS = 2
  end
end

#expression ⇒ ::String

Returns The mathematical expression for this derived metric. Can be used in Metric's expression field for equivalent reports. Most metrics are not expressions, and for non-expressions, this field is empty.

Returns:

  • (::String) —

    The mathematical expression for this derived metric. Can be used in Metric's expression field for equivalent reports. Most metrics are not expressions, and for non-expressions, this field is empty.



1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
 
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 1011

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

  # Justifications for why this metric is blocked.
  module BlockedReason
    # Will never be specified in API response.
    BLOCKED_REASON_UNSPECIFIED = 0

    # If present, your access is blocked to revenue related metrics for this
    # property, and this metric is revenue related.
    NO_REVENUE_METRICS = 1

    # If present, your access is blocked to cost related metrics for this
    # property, and this metric is cost related.
    NO_COST_METRICS = 2
  end
end

#type ⇒ ::Google::Analytics::Data::V1beta::MetricType

Returns The type of this metric.

Returns:



1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
 
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 1011

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

  # Justifications for why this metric is blocked.
  module BlockedReason
    # Will never be specified in API response.
    BLOCKED_REASON_UNSPECIFIED = 0

    # If present, your access is blocked to revenue related metrics for this
    # property, and this metric is revenue related.
    NO_REVENUE_METRICS = 1

    # If present, your access is blocked to cost related metrics for this
    # property, and this metric is cost related.
    NO_COST_METRICS = 2
  end
end

#ui_name ⇒ ::String

Returns This metric's name within the Google Analytics user interface. For example, Event count.

Returns:

  • (::String) —

    This metric's name within the Google Analytics user interface. For example, Event count.



1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
 
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 1011

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

  # Justifications for why this metric is blocked.
  module BlockedReason
    # Will never be specified in API response.
    BLOCKED_REASON_UNSPECIFIED = 0

    # If present, your access is blocked to revenue related metrics for this
    # property, and this metric is revenue related.
    NO_REVENUE_METRICS = 1

    # If present, your access is blocked to cost related metrics for this
    # property, and this metric is cost related.
    NO_COST_METRICS = 2
  end
end