- 0.62.0 (latest)
- 0.61.0
- 0.59.0
- 0.58.0
- 0.57.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
public interface CustomDimensionOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getDescription()
public abstract String getDescription()Optional. Description for this custom dimension. Max length of 150 characters.
string description = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String | The description. |
getDescriptionBytes()
public abstract ByteString getDescriptionBytes()Optional. Description for this custom dimension. Max length of 150 characters.
string description = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for description. |
getDisallowAdsPersonalization()
public abstract 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 | |
|---|---|
| Type | Description |
boolean | The disallowAdsPersonalization. |
getDisplayName()
public abstract 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 | |
|---|---|
| Type | Description |
String | The displayName. |
getDisplayNameBytes()
public abstract 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 | |
|---|---|
| Type | Description |
ByteString | The bytes for displayName. |
getName()
public abstract String getName()Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String | The name. |
getNameBytes()
public abstract ByteString getNameBytes()Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for name. |
getParameterName()
public abstract 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 | |
|---|---|
| Type | Description |
String | The parameterName. |
getParameterNameBytes()
public abstract 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 | |
|---|---|
| Type | Description |
ByteString | The bytes for parameterName. |
getScope()
public abstract 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 | |
|---|---|
| Type | Description |
CustomDimension.DimensionScope | The scope. |
getScopeValue()
public abstract 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 | |
|---|---|
| Type | Description |
int | The enum numeric value on the wire for scope. |