Class: Google::Analytics::Admin::V1alpha::CalculatedMetric

Inherits:

Object

• Object
• Google::Analytics::Admin::V1alpha::CalculatedMetric

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/analytics/admin/v1alpha/resources.rb

Overview

A definition for a calculated metric.

Defined Under Namespace

Modules: MetricUnit, RestrictedMetricType

Instance Attribute Summary

• #calculated_metric_id ⇒ ::String readonly

  Output only.

• #description ⇒ ::String

  Optional.

• #display_name ⇒ ::String

  Required.

• #formula ⇒ ::String

  Required.

• #invalid_metric_reference ⇒ ::Boolean readonly

  Output only.

• #metric_unit ⇒ ::Google::Analytics::Admin::V1alpha::CalculatedMetric::MetricUnit

  Required.

• #name ⇒ ::String readonly

  Output only.

• #restricted_metric_type ⇒ ::Array<::Google::Analytics::Admin::V1alpha::CalculatedMetric::RestrictedMetricType> readonly

  Output only.

Instance Attribute Details

#calculated_metric_id ⇒ ::String (readonly)

# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 1220

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

  # Possible types of representing the calculated metric's value.
  module MetricUnit
    # MetricUnit unspecified or missing.
    METRIC_UNIT_UNSPECIFIED = 0

    # This metric uses default units.
    STANDARD = 1

    # This metric measures a currency.
    CURRENCY = 2

    # This metric measures feet.
    FEET = 3

    # This metric measures miles.
    MILES = 4

    # This metric measures meters.
    METERS = 5

    # This metric measures kilometers.
    KILOMETERS = 6

    # This metric measures milliseconds.
    MILLISECONDS = 7

    # This metric measures seconds.
    SECONDS = 8

    # This metric measures minutes.
    MINUTES = 9

    # This metric measures hours.
    HOURS = 10
  end

  # Labels that mark the data in calculated metric used in conjunction with
  # user roles that restrict access to cost and/or revenue metrics.
  module RestrictedMetricType
    # Type unknown or unspecified.
    RESTRICTED_METRIC_TYPE_UNSPECIFIED = 0

    # Metric reports cost data.
    COST_DATA = 1

    # Metric reports revenue data.
    REVENUE_DATA = 2
  end
end

#description ⇒ ::String

# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 1220

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

  # Possible types of representing the calculated metric's value.
  module MetricUnit
    # MetricUnit unspecified or missing.
    METRIC_UNIT_UNSPECIFIED = 0

    # This metric uses default units.
    STANDARD = 1

    # This metric measures a currency.
    CURRENCY = 2

    # This metric measures feet.
    FEET = 3

    # This metric measures miles.
    MILES = 4

    # This metric measures meters.
    METERS = 5

    # This metric measures kilometers.
    KILOMETERS = 6

    # This metric measures milliseconds.
    MILLISECONDS = 7

    # This metric measures seconds.
    SECONDS = 8

    # This metric measures minutes.
    MINUTES = 9

    # This metric measures hours.
    HOURS = 10
  end

  # Labels that mark the data in calculated metric used in conjunction with
  # user roles that restrict access to cost and/or revenue metrics.
  module RestrictedMetricType
    # Type unknown or unspecified.
    RESTRICTED_METRIC_TYPE_UNSPECIFIED = 0

    # Metric reports cost data.
    COST_DATA = 1

    # Metric reports revenue data.
    REVENUE_DATA = 2
  end
end

#display_name ⇒ ::String

# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 1220

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

  # Possible types of representing the calculated metric's value.
  module MetricUnit
    # MetricUnit unspecified or missing.
    METRIC_UNIT_UNSPECIFIED = 0

    # This metric uses default units.
    STANDARD = 1

    # This metric measures a currency.
    CURRENCY = 2

    # This metric measures feet.
    FEET = 3

    # This metric measures miles.
    MILES = 4

    # This metric measures meters.
    METERS = 5

    # This metric measures kilometers.
    KILOMETERS = 6

    # This metric measures milliseconds.
    MILLISECONDS = 7

    # This metric measures seconds.
    SECONDS = 8

    # This metric measures minutes.
    MINUTES = 9

    # This metric measures hours.
    HOURS = 10
  end

  # Labels that mark the data in calculated metric used in conjunction with
  # user roles that restrict access to cost and/or revenue metrics.
  module RestrictedMetricType
    # Type unknown or unspecified.
    RESTRICTED_METRIC_TYPE_UNSPECIFIED = 0

    # Metric reports cost data.
    COST_DATA = 1

    # Metric reports revenue data.
    REVENUE_DATA = 2
  end
end

#formula ⇒ ::String

# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 1220

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

  # Possible types of representing the calculated metric's value.
  module MetricUnit
    # MetricUnit unspecified or missing.
    METRIC_UNIT_UNSPECIFIED = 0

    # This metric uses default units.
    STANDARD = 1

    # This metric measures a currency.
    CURRENCY = 2

    # This metric measures feet.
    FEET = 3

    # This metric measures miles.
    MILES = 4

    # This metric measures meters.
    METERS = 5

    # This metric measures kilometers.
    KILOMETERS = 6

    # This metric measures milliseconds.
    MILLISECONDS = 7

    # This metric measures seconds.
    SECONDS = 8

    # This metric measures minutes.
    MINUTES = 9

    # This metric measures hours.
    HOURS = 10
  end

  # Labels that mark the data in calculated metric used in conjunction with
  # user roles that restrict access to cost and/or revenue metrics.
  module RestrictedMetricType
    # Type unknown or unspecified.
    RESTRICTED_METRIC_TYPE_UNSPECIFIED = 0

    # Metric reports cost data.
    COST_DATA = 1

    # Metric reports revenue data.
    REVENUE_DATA = 2
  end
end

#invalid_metric_reference ⇒ ::Boolean (readonly)

# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 1220

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

  # Possible types of representing the calculated metric's value.
  module MetricUnit
    # MetricUnit unspecified or missing.
    METRIC_UNIT_UNSPECIFIED = 0

    # This metric uses default units.
    STANDARD = 1

    # This metric measures a currency.
    CURRENCY = 2

    # This metric measures feet.
    FEET = 3

    # This metric measures miles.
    MILES = 4

    # This metric measures meters.
    METERS = 5

    # This metric measures kilometers.
    KILOMETERS = 6

    # This metric measures milliseconds.
    MILLISECONDS = 7

    # This metric measures seconds.
    SECONDS = 8

    # This metric measures minutes.
    MINUTES = 9

    # This metric measures hours.
    HOURS = 10
  end

  # Labels that mark the data in calculated metric used in conjunction with
  # user roles that restrict access to cost and/or revenue metrics.
  module RestrictedMetricType
    # Type unknown or unspecified.
    RESTRICTED_METRIC_TYPE_UNSPECIFIED = 0

    # Metric reports cost data.
    COST_DATA = 1

    # Metric reports revenue data.
    REVENUE_DATA = 2
  end
end

#metric_unit ⇒ ::Google::Analytics::Admin::V1alpha::CalculatedMetric::MetricUnit

# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 1220

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

  # Possible types of representing the calculated metric's value.
  module MetricUnit
    # MetricUnit unspecified or missing.
    METRIC_UNIT_UNSPECIFIED = 0

    # This metric uses default units.
    STANDARD = 1

    # This metric measures a currency.
    CURRENCY = 2

    # This metric measures feet.
    FEET = 3

    # This metric measures miles.
    MILES = 4

    # This metric measures meters.
    METERS = 5

    # This metric measures kilometers.
    KILOMETERS = 6

    # This metric measures milliseconds.
    MILLISECONDS = 7

    # This metric measures seconds.
    SECONDS = 8

    # This metric measures minutes.
    MINUTES = 9

    # This metric measures hours.
    HOURS = 10
  end

  # Labels that mark the data in calculated metric used in conjunction with
  # user roles that restrict access to cost and/or revenue metrics.
  module RestrictedMetricType
    # Type unknown or unspecified.
    RESTRICTED_METRIC_TYPE_UNSPECIFIED = 0

    # Metric reports cost data.
    COST_DATA = 1

    # Metric reports revenue data.
    REVENUE_DATA = 2
  end
end

#name ⇒ ::String (readonly)

# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 1220

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

  # Possible types of representing the calculated metric's value.
  module MetricUnit
    # MetricUnit unspecified or missing.
    METRIC_UNIT_UNSPECIFIED = 0

    # This metric uses default units.
    STANDARD = 1

    # This metric measures a currency.
    CURRENCY = 2

    # This metric measures feet.
    FEET = 3

    # This metric measures miles.
    MILES = 4

    # This metric measures meters.
    METERS = 5

    # This metric measures kilometers.
    KILOMETERS = 6

    # This metric measures milliseconds.
    MILLISECONDS = 7

    # This metric measures seconds.
    SECONDS = 8

    # This metric measures minutes.
    MINUTES = 9

    # This metric measures hours.
    HOURS = 10
  end

  # Labels that mark the data in calculated metric used in conjunction with
  # user roles that restrict access to cost and/or revenue metrics.
  module RestrictedMetricType
    # Type unknown or unspecified.
    RESTRICTED_METRIC_TYPE_UNSPECIFIED = 0

    # Metric reports cost data.
    COST_DATA = 1

    # Metric reports revenue data.
    REVENUE_DATA = 2
  end
end

#restricted_metric_type ⇒ ::Array<::Google::Analytics::Admin::V1alpha::CalculatedMetric::RestrictedMetricType> (readonly)

# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 1220

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

  # Possible types of representing the calculated metric's value.
  module MetricUnit
    # MetricUnit unspecified or missing.
    METRIC_UNIT_UNSPECIFIED = 0

    # This metric uses default units.
    STANDARD = 1

    # This metric measures a currency.
    CURRENCY = 2

    # This metric measures feet.
    FEET = 3

    # This metric measures miles.
    MILES = 4

    # This metric measures meters.
    METERS = 5

    # This metric measures kilometers.
    KILOMETERS = 6

    # This metric measures milliseconds.
    MILLISECONDS = 7

    # This metric measures seconds.
    SECONDS = 8

    # This metric measures minutes.
    MINUTES = 9

    # This metric measures hours.
    HOURS = 10
  end

  # Labels that mark the data in calculated metric used in conjunction with
  # user roles that restrict access to cost and/or revenue metrics.
  module RestrictedMetricType
    # Type unknown or unspecified.
    RESTRICTED_METRIC_TYPE_UNSPECIFIED = 0

    # Metric reports cost data.
    COST_DATA = 1

    # Metric reports revenue data.
    REVENUE_DATA = 2
  end
end