Package com.google.analytics.admin.v1alpha

Interface CustomMetricOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
CustomMetric, CustomMetric.Builder
@Generated public interface CustomMetricOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       Identifier. Resource name for this CustomMetric resource.
 Format: properties/{property}/customMetrics/{customMetric}
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Identifier. Resource name for this CustomMetric resource.
 Format: properties/{property}/customMetrics/{customMetric}
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The bytes for name.

    • getParameterName

      String getParameterName()
       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.
      string parameter_name = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The parameterName.

    • getParameterNameBytes

      com.google.protobuf.ByteString getParameterNameBytes()
       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.
      string parameter_name = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The bytes for parameterName.

    • getDisplayName

      String getDisplayName()
       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.
      string display_name = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
       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.
      string display_name = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for displayName.

    • getDescription

      String getDescription()
       Optional. Description for this custom dimension.
 Max length of 150 characters.
      string description = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       Optional. Description for this custom dimension.
 Max length of 150 characters.
      string description = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for description.

    • getMeasurementUnitValue

      int getMeasurementUnitValue()
       Required. The type for the custom metric's value.
      .google.analytics.admin.v1alpha.CustomMetric.MeasurementUnit measurement_unit = 5 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The enum numeric value on the wire for measurementUnit.

    • getMeasurementUnit

      CustomMetric.MeasurementUnit getMeasurementUnit()
       Required. The type for the custom metric's value.
      .google.analytics.admin.v1alpha.CustomMetric.MeasurementUnit measurement_unit = 5 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The measurementUnit.

    • getScopeValue

      int getScopeValue()
       Required. Immutable. The scope of this custom metric.
      .google.analytics.admin.v1alpha.CustomMetric.MetricScope scope = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The enum numeric value on the wire for scope.

    • getScope

      CustomMetric.MetricScope getScope()
       Required. Immutable. The scope of this custom metric.
      .google.analytics.admin.v1alpha.CustomMetric.MetricScope scope = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The scope.

    • getRestrictedMetricTypeList

      List<CustomMetric.RestrictedMetricType> getRestrictedMetricTypeList()
       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.
      repeated .google.analytics.admin.v1alpha.CustomMetric.RestrictedMetricType restricted_metric_type = 8 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      A list containing the restrictedMetricType.

    • getRestrictedMetricTypeCount

      int getRestrictedMetricTypeCount()
       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.
      repeated .google.analytics.admin.v1alpha.CustomMetric.RestrictedMetricType restricted_metric_type = 8 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The count of restrictedMetricType.

    • getRestrictedMetricType

      CustomMetric.RestrictedMetricType getRestrictedMetricType(int index)
       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.
      repeated .google.analytics.admin.v1alpha.CustomMetric.RestrictedMetricType restricted_metric_type = 8 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the element to return.
      Returns:
      The restrictedMetricType at the given index.

    • getRestrictedMetricTypeValueList

      List<Integer> getRestrictedMetricTypeValueList()
       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.
      repeated .google.analytics.admin.v1alpha.CustomMetric.RestrictedMetricType restricted_metric_type = 8 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      A list containing the enum numeric values on the wire for restrictedMetricType.

    • getRestrictedMetricTypeValue

      int getRestrictedMetricTypeValue(int index)
       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.
      repeated .google.analytics.admin.v1alpha.CustomMetric.RestrictedMetricType restricted_metric_type = 8 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of restrictedMetricType at the given index.