Class: Google::Analytics::Admin::V1alpha::CustomMetric

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

Overview

A definition for a custom metric.

Defined Under Namespace

Modules: MeasurementUnit, MetricScope, RestrictedMetricType

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ ::String

Returns Optional. Description for this custom dimension. Max length of 150 characters.

Returns:

  • (::String) —

    Optional. Description for this custom dimension. Max length of 150 characters.



1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
 
# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 1052

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

  # Possible types of representing the custom metric's value.
  #
  # Currency representation may change in the future, requiring a breaking API
  # change.
  module MeasurementUnit
    # MeasurementUnit unspecified or missing.
    MEASUREMENT_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 meters.
    METERS = 4

    # This metric measures kilometers.
    KILOMETERS = 5

    # This metric measures miles.
    MILES = 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

  # The scope of this metric.
  module MetricScope
    # Scope unknown or not specified.
    METRIC_SCOPE_UNSPECIFIED = 0

    # Metric scoped to an event.
    EVENT = 1
  end

  # Labels that mark the data in this custom metric as data that should be
  # restricted to specific users.
  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

Returns Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.

Returns:

  • (::String) —

    Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.



1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
 
# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 1052

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

  # Possible types of representing the custom metric's value.
  #
  # Currency representation may change in the future, requiring a breaking API
  # change.
  module MeasurementUnit
    # MeasurementUnit unspecified or missing.
    MEASUREMENT_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 meters.
    METERS = 4

    # This metric measures kilometers.
    KILOMETERS = 5

    # This metric measures miles.
    MILES = 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

  # The scope of this metric.
  module MetricScope
    # Scope unknown or not specified.
    METRIC_SCOPE_UNSPECIFIED = 0

    # Metric scoped to an event.
    EVENT = 1
  end

  # Labels that mark the data in this custom metric as data that should be
  # restricted to specific users.
  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

#measurement_unit ⇒ ::Google::Analytics::Admin::V1alpha::CustomMetric::MeasurementUnit

Returns Required. The type for the custom metric’s value.

Returns:



1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
 
# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 1052

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

  # Possible types of representing the custom metric's value.
  #
  # Currency representation may change in the future, requiring a breaking API
  # change.
  module MeasurementUnit
    # MeasurementUnit unspecified or missing.
    MEASUREMENT_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 meters.
    METERS = 4

    # This metric measures kilometers.
    KILOMETERS = 5

    # This metric measures miles.
    MILES = 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

  # The scope of this metric.
  module MetricScope
    # Scope unknown or not specified.
    METRIC_SCOPE_UNSPECIFIED = 0

    # Metric scoped to an event.
    EVENT = 1
  end

  # Labels that mark the data in this custom metric as data that should be
  # restricted to specific users.
  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)

Returns Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}.

Returns:

  • (::String) —

    Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}



1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
 
# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 1052

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

  # Possible types of representing the custom metric's value.
  #
  # Currency representation may change in the future, requiring a breaking API
  # change.
  module MeasurementUnit
    # MeasurementUnit unspecified or missing.
    MEASUREMENT_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 meters.
    METERS = 4

    # This metric measures kilometers.
    KILOMETERS = 5

    # This metric measures miles.
    MILES = 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

  # The scope of this metric.
  module MetricScope
    # Scope unknown or not specified.
    METRIC_SCOPE_UNSPECIFIED = 0

    # Metric scoped to an event.
    EVENT = 1
  end

  # Labels that mark the data in this custom metric as data that should be
  # restricted to specific users.
  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

#parameter_name ⇒ ::String

Returns Required. Immutable. Tagging name for this custom metric.

If this is an event-scoped metric, then this is the event parameter name.

May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics.

Returns:

  • (::String) —

    Required. Immutable. Tagging name for this custom metric.

    If this is an event-scoped metric, then this is the event parameter name.

    May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics.



1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
 
# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 1052

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

  # Possible types of representing the custom metric's value.
  #
  # Currency representation may change in the future, requiring a breaking API
  # change.
  module MeasurementUnit
    # MeasurementUnit unspecified or missing.
    MEASUREMENT_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 meters.
    METERS = 4

    # This metric measures kilometers.
    KILOMETERS = 5

    # This metric measures miles.
    MILES = 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

  # The scope of this metric.
  module MetricScope
    # Scope unknown or not specified.
    METRIC_SCOPE_UNSPECIFIED = 0

    # Metric scoped to an event.
    EVENT = 1
  end

  # Labels that mark the data in this custom metric as data that should be
  # restricted to specific users.
  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::CustomMetric::RestrictedMetricType>

Returns Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit.

Returns:



1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
 
# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 1052

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

  # Possible types of representing the custom metric's value.
  #
  # Currency representation may change in the future, requiring a breaking API
  # change.
  module MeasurementUnit
    # MeasurementUnit unspecified or missing.
    MEASUREMENT_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 meters.
    METERS = 4

    # This metric measures kilometers.
    KILOMETERS = 5

    # This metric measures miles.
    MILES = 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

  # The scope of this metric.
  module MetricScope
    # Scope unknown or not specified.
    METRIC_SCOPE_UNSPECIFIED = 0

    # Metric scoped to an event.
    EVENT = 1
  end

  # Labels that mark the data in this custom metric as data that should be
  # restricted to specific users.
  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

#scope ⇒ ::Google::Analytics::Admin::V1alpha::CustomMetric::MetricScope

Returns Required. Immutable. The scope of this custom metric.

Returns:



1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
 
# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 1052

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

  # Possible types of representing the custom metric's value.
  #
  # Currency representation may change in the future, requiring a breaking API
  # change.
  module MeasurementUnit
    # MeasurementUnit unspecified or missing.
    MEASUREMENT_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 meters.
    METERS = 4

    # This metric measures kilometers.
    KILOMETERS = 5

    # This metric measures miles.
    MILES = 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

  # The scope of this metric.
  module MetricScope
    # Scope unknown or not specified.
    METRIC_SCOPE_UNSPECIFIED = 0

    # Metric scoped to an event.
    EVENT = 1
  end

  # Labels that mark the data in this custom metric as data that should be
  # restricted to specific users.
  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