- 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 static final class CustomDimension.Builder extends GeneratedMessageV3.Builder<CustomDimension.Builder> implements CustomDimensionOrBuilderA definition for a CustomDimension.
Protobuf type google.analytics.admin.v1beta.CustomDimension
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CustomDimension.BuilderImplements
CustomDimensionOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CustomDimension.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
field | FieldDescriptor |
value | Object |
| Type | Description |
CustomDimension.Builder |
build()
public CustomDimension build()| Type | Description |
CustomDimension |
buildPartial()
public CustomDimension buildPartial()| Type | Description |
CustomDimension |
clear()
public CustomDimension.Builder clear()| Type | Description |
CustomDimension.Builder |
clearDescription()
public CustomDimension.Builder clearDescription()Optional. Description for this custom dimension. Max length of 150 characters.
string description = 4 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
CustomDimension.Builder | This builder for chaining. |
clearDisallowAdsPersonalization()
public CustomDimension.Builder clearDisallowAdsPersonalization()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];
| Type | Description |
CustomDimension.Builder | This builder for chaining. |
clearDisplayName()
public CustomDimension.Builder clearDisplayName()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];
| Type | Description |
CustomDimension.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public CustomDimension.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
field | FieldDescriptor |
| Type | Description |
CustomDimension.Builder |
clearName()
public CustomDimension.Builder clearName()Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
CustomDimension.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public CustomDimension.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
oneof | OneofDescriptor |
| Type | Description |
CustomDimension.Builder |
clearParameterName()
public CustomDimension.Builder clearParameterName()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. 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];
| Type | Description |
CustomDimension.Builder | This builder for chaining. |
clearScope()
public CustomDimension.Builder clearScope()Required. Immutable. The scope of this dimension.
.google.analytics.admin.v1beta.CustomDimension.DimensionScope scope = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Type | Description |
CustomDimension.Builder | This builder for chaining. |
clone()
public CustomDimension.Builder clone()| Type | Description |
CustomDimension.Builder |
getDefaultInstanceForType()
public CustomDimension getDefaultInstanceForType()| Type | Description |
CustomDimension |
getDescription()
public String getDescription()Optional. Description for this custom dimension. Max length of 150 characters.
string description = 4 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
String | The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()Optional. Description for this custom dimension. Max length of 150 characters.
string description = 4 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
ByteString | The bytes for description. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
Descriptor |
getDisallowAdsPersonalization()
public 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];
| Type | Description |
boolean | The disallowAdsPersonalization. |
getDisplayName()
public 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];
| Type | Description |
String | The displayName. |
getDisplayNameBytes()
public 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];
| Type | Description |
ByteString | The bytes for displayName. |
getName()
public String getName()Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
String | The name. |
getNameBytes()
public ByteString getNameBytes()Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
ByteString | The bytes for name. |
getParameterName()
public 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. 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];
| Type | Description |
String | The parameterName. |
getParameterNameBytes()
public 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. 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];
| Type | Description |
ByteString | The bytes for parameterName. |
getScope()
public CustomDimension.DimensionScope getScope()Required. Immutable. The scope of this dimension.
.google.analytics.admin.v1beta.CustomDimension.DimensionScope scope = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Type | Description |
CustomDimension.DimensionScope | The scope. |
getScopeValue()
public int getScopeValue()Required. Immutable. The scope of this dimension.
.google.analytics.admin.v1beta.CustomDimension.DimensionScope scope = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Type | Description |
int | The enum numeric value on the wire for scope. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
boolean |
mergeFrom(CustomDimension other)
public CustomDimension.Builder mergeFrom(CustomDimension other)| Name | Description |
other | CustomDimension |
| Type | Description |
CustomDimension.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public CustomDimension.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
CustomDimension.Builder |
| Type | Description |
IOException |
mergeFrom(Message other)
public CustomDimension.Builder mergeFrom(Message other)| Name | Description |
other | Message |
| Type | Description |
CustomDimension.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CustomDimension.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
unknownFields | UnknownFieldSet |
| Type | Description |
CustomDimension.Builder |
setDescription(String value)
public CustomDimension.Builder setDescription(String value)Optional. Description for this custom dimension. Max length of 150 characters.
string description = 4 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
value | StringThe description to set. |
| Type | Description |
CustomDimension.Builder | This builder for chaining. |
setDescriptionBytes(ByteString value)
public CustomDimension.Builder setDescriptionBytes(ByteString value)Optional. Description for this custom dimension. Max length of 150 characters.
string description = 4 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
value | ByteStringThe bytes for description to set. |
| Type | Description |
CustomDimension.Builder | This builder for chaining. |
setDisallowAdsPersonalization(boolean value)
public CustomDimension.Builder setDisallowAdsPersonalization(boolean value)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];
| Name | Description |
value | booleanThe disallowAdsPersonalization to set. |
| Type | Description |
CustomDimension.Builder | This builder for chaining. |
setDisplayName(String value)
public CustomDimension.Builder setDisplayName(String value)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];
| Name | Description |
value | StringThe displayName to set. |
| Type | Description |
CustomDimension.Builder | This builder for chaining. |
setDisplayNameBytes(ByteString value)
public CustomDimension.Builder setDisplayNameBytes(ByteString value)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];
| Name | Description |
value | ByteStringThe bytes for displayName to set. |
| Type | Description |
CustomDimension.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public CustomDimension.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
field | FieldDescriptor |
value | Object |
| Type | Description |
CustomDimension.Builder |
setName(String value)
public CustomDimension.Builder setName(String value)Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
value | StringThe name to set. |
| Type | Description |
CustomDimension.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public CustomDimension.Builder setNameBytes(ByteString value)Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Name | Description |
value | ByteStringThe bytes for name to set. |
| Type | Description |
CustomDimension.Builder | This builder for chaining. |
setParameterName(String value)
public CustomDimension.Builder setParameterName(String value)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. 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];
| Name | Description |
value | StringThe parameterName to set. |
| Type | Description |
CustomDimension.Builder | This builder for chaining. |
setParameterNameBytes(ByteString value)
public CustomDimension.Builder setParameterNameBytes(ByteString value)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. 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];
| Name | Description |
value | ByteStringThe bytes for parameterName to set. |
| Type | Description |
CustomDimension.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public CustomDimension.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Type | Description |
CustomDimension.Builder |
setScope(CustomDimension.DimensionScope value)
public CustomDimension.Builder setScope(CustomDimension.DimensionScope value)Required. Immutable. The scope of this dimension.
.google.analytics.admin.v1beta.CustomDimension.DimensionScope scope = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Name | Description |
value | CustomDimension.DimensionScopeThe scope to set. |
| Type | Description |
CustomDimension.Builder | This builder for chaining. |
setScopeValue(int value)
public CustomDimension.Builder setScopeValue(int value)Required. Immutable. The scope of this dimension.
.google.analytics.admin.v1beta.CustomDimension.DimensionScope scope = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Name | Description |
value | intThe enum numeric value on the wire for scope to set. |
| Type | Description |
CustomDimension.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final CustomDimension.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
unknownFields | UnknownFieldSet |
| Type | Description |
CustomDimension.Builder |