Send feedback
Class CustomDimension (0.32.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 0.32.0keyboard_arrow_down
public final class CustomDimension extends GeneratedMessageV3 implements CustomDimensionOrBuilder
A definition for a CustomDimension.
Protobuf type google.analytics.admin.v1alpha.CustomDimension
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int
DISALLOW_ADS_PERSONALIZATION_FIELD_NUMBER
public static final int DISALLOW_ADS_PERSONALIZATION_FIELD_NUMBER
Field Value
Type Description
int
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int
PARAMETER_NAME_FIELD_NUMBER
public static final int PARAMETER_NAME_FIELD_NUMBER
Field Value
Type Description
int
SCOPE_FIELD_NUMBER
public static final int SCOPE_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static CustomDimension getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static CustomDimension . Builder newBuilder ()
newBuilder(CustomDimension prototype)
public static CustomDimension . Builder newBuilder ( CustomDimension prototype )
public static CustomDimension parseDelimitedFrom ( InputStream input )
public static CustomDimension parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static CustomDimension parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CustomDimension parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static CustomDimension parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CustomDimension parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static CustomDimension parseFrom ( CodedInputStream input )
public static CustomDimension parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static CustomDimension parseFrom ( InputStream input )
public static CustomDimension parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static CustomDimension parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CustomDimension parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<CustomDimension> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public CustomDimension getDefaultInstanceForType ()
getDescription()
public 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 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 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 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 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()
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 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 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 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.
getParserForType()
public Parser<CustomDimension> getParserForType ()
Overrides
getScope()
public 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];
getScopeValue()
public 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.
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public CustomDimension . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CustomDimension . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public CustomDimension . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-10 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-10 UTC."],[],[]]
