Package com.google.analytics.admin.v1alpha

Interface CustomDimensionOrBuilder

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

  • Method Details

    • getName

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

    • getNameBytes

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

    • getParameterName

      String getParameterName()
       Required. Immutable. Tagging parameter name for this custom dimension.

 If this is a user-scoped dimension, then this is the user property name.
 If this is an event-scoped dimension, then this is the event parameter
 name.

 If this is an item-scoped dimension, then this is the parameter
 name found in the eCommerce items array.

 May only contain alphanumeric and underscore characters, starting with a
 letter. Max length of 24 characters for user-scoped dimensions, 40
 characters for event-scoped dimensions.
      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 parameter name for this custom dimension.

 If this is a user-scoped dimension, then this is the user property name.
 If this is an event-scoped dimension, then this is the event parameter
 name.

 If this is an item-scoped dimension, then this is the parameter
 name found in the eCommerce items array.

 May only contain alphanumeric and underscore characters, starting with a
 letter. Max length of 24 characters for user-scoped dimensions, 40
 characters for event-scoped dimensions.
      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 dimension 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 dimension 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.

    • getScopeValue

      int getScopeValue()
       Required. Immutable. The scope of this dimension.
      .google.analytics.admin.v1alpha.CustomDimension.DimensionScope scope = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The enum numeric value on the wire for scope.

    • getScope

      CustomDimension.DimensionScope getScope()
       Required. Immutable. The scope of this dimension.
      .google.analytics.admin.v1alpha.CustomDimension.DimensionScope scope = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The scope.

    • getDisallowAdsPersonalization

      boolean getDisallowAdsPersonalization()
       Optional. If set to true, sets this dimension as NPA and excludes it from
 ads personalization.

 This is currently only supported by user-scoped custom dimensions.
      bool disallow_ads_personalization = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The disallowAdsPersonalization.