- 0.64.0 (latest)
- 0.63.0
- 0.62.0
- 0.60.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.48.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.35.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
public static final class DimensionMetadata.Builder extends GeneratedMessageV3.Builder<DimensionMetadata.Builder> implements DimensionMetadataOrBuilderExplains a dimension.
Protobuf type google.analytics.data.v1beta.DimensionMetadata
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > DimensionMetadata.BuilderImplements
DimensionMetadataOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllDeprecatedApiNames(Iterable<String> values)
public DimensionMetadata.Builder addAllDeprecatedApiNames(Iterable<String> values) Still usable but deprecated names for this dimension. If populated, this
dimension is available by either apiName or one of deprecatedApiNames
for a period of time. After the deprecation period, the dimension will be
available only by apiName.
repeated string deprecated_api_names = 4;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The deprecatedApiNames to add. |
| Returns | |
|---|---|
| Type | Description |
DimensionMetadata.Builder |
This builder for chaining. |
addDeprecatedApiNames(String value)
public DimensionMetadata.Builder addDeprecatedApiNames(String value) Still usable but deprecated names for this dimension. If populated, this
dimension is available by either apiName or one of deprecatedApiNames
for a period of time. After the deprecation period, the dimension will be
available only by apiName.
repeated string deprecated_api_names = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe deprecatedApiNames to add. |
| Returns | |
|---|---|
| Type | Description |
DimensionMetadata.Builder |
This builder for chaining. |
addDeprecatedApiNamesBytes(ByteString value)
public DimensionMetadata.Builder addDeprecatedApiNamesBytes(ByteString value) Still usable but deprecated names for this dimension. If populated, this
dimension is available by either apiName or one of deprecatedApiNames
for a period of time. After the deprecation period, the dimension will be
available only by apiName.
repeated string deprecated_api_names = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the deprecatedApiNames to add. |
| Returns | |
|---|---|
| Type | Description |
DimensionMetadata.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public DimensionMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
DimensionMetadata.Builder |
|
build()
public DimensionMetadata build()| Returns | |
|---|---|
| Type | Description |
DimensionMetadata |
|
buildPartial()
public DimensionMetadata buildPartial()| Returns | |
|---|---|
| Type | Description |
DimensionMetadata |
|
clear()
public DimensionMetadata.Builder clear()| Returns | |
|---|---|
| Type | Description |
DimensionMetadata.Builder |
|
clearApiName()
public DimensionMetadata.Builder clearApiName() This dimension's name. Useable in Dimension's name. For
example, eventName.
string api_name = 1;
| Returns | |
|---|---|
| Type | Description |
DimensionMetadata.Builder |
This builder for chaining. |
clearCategory()
public DimensionMetadata.Builder clearCategory()The display name of the category that this dimension belongs to. Similar dimensions and metrics are categorized together.
string category = 7;
| Returns | |
|---|---|
| Type | Description |
DimensionMetadata.Builder |
This builder for chaining. |
clearCustomDefinition()
public DimensionMetadata.Builder clearCustomDefinition()True if the dimension is custom to this property. This includes user, event, & item scoped custom dimensions; to learn more about custom dimensions, see https://support.google.com/analytics/answer/14240153. This also include custom channel groups; to learn more about custom channel groups, see https://support.google.com/analytics/answer/13051316.
bool custom_definition = 5;
| Returns | |
|---|---|
| Type | Description |
DimensionMetadata.Builder |
This builder for chaining. |
clearDeprecatedApiNames()
public DimensionMetadata.Builder clearDeprecatedApiNames() Still usable but deprecated names for this dimension. If populated, this
dimension is available by either apiName or one of deprecatedApiNames
for a period of time. After the deprecation period, the dimension will be
available only by apiName.
repeated string deprecated_api_names = 4;
| Returns | |
|---|---|
| Type | Description |
DimensionMetadata.Builder |
This builder for chaining. |
clearDescription()
public DimensionMetadata.Builder clearDescription()Description of how this dimension is used and calculated.
string description = 3;
| Returns | |
|---|---|
| Type | Description |
DimensionMetadata.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public DimensionMetadata.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
DimensionMetadata.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public DimensionMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
DimensionMetadata.Builder |
|
clearUiName()
public DimensionMetadata.Builder clearUiName() This dimension's name within the Google Analytics user interface. For
example, Event name.
string ui_name = 2;
| Returns | |
|---|---|
| Type | Description |
DimensionMetadata.Builder |
This builder for chaining. |
clone()
public DimensionMetadata.Builder clone()| Returns | |
|---|---|
| Type | Description |
DimensionMetadata.Builder |
|
getApiName()
public String getApiName() This dimension's name. Useable in Dimension's name. For
example, eventName.
string api_name = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The apiName. |
getApiNameBytes()
public ByteString getApiNameBytes() This dimension's name. Useable in Dimension's name. For
example, eventName.
string api_name = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for apiName. |
getCategory()
public String getCategory()The display name of the category that this dimension belongs to. Similar dimensions and metrics are categorized together.
string category = 7;
| Returns | |
|---|---|
| Type | Description |
String |
The category. |
getCategoryBytes()
public ByteString getCategoryBytes()The display name of the category that this dimension belongs to. Similar dimensions and metrics are categorized together.
string category = 7;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for category. |
getCustomDefinition()
public boolean getCustomDefinition()True if the dimension is custom to this property. This includes user, event, & item scoped custom dimensions; to learn more about custom dimensions, see https://support.google.com/analytics/answer/14240153. This also include custom channel groups; to learn more about custom channel groups, see https://support.google.com/analytics/answer/13051316.
bool custom_definition = 5;
| Returns | |
|---|---|
| Type | Description |
boolean |
The customDefinition. |
getDefaultInstanceForType()
public DimensionMetadata getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
DimensionMetadata |
|
getDeprecatedApiNames(int index)
public String getDeprecatedApiNames(int index) Still usable but deprecated names for this dimension. If populated, this
dimension is available by either apiName or one of deprecatedApiNames
for a period of time. After the deprecation period, the dimension will be
available only by apiName.
repeated string deprecated_api_names = 4;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The deprecatedApiNames at the given index. |
getDeprecatedApiNamesBytes(int index)
public ByteString getDeprecatedApiNamesBytes(int index) Still usable but deprecated names for this dimension. If populated, this
dimension is available by either apiName or one of deprecatedApiNames
for a period of time. After the deprecation period, the dimension will be
available only by apiName.
repeated string deprecated_api_names = 4;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the deprecatedApiNames at the given index. |
getDeprecatedApiNamesCount()
public int getDeprecatedApiNamesCount() Still usable but deprecated names for this dimension. If populated, this
dimension is available by either apiName or one of deprecatedApiNames
for a period of time. After the deprecation period, the dimension will be
available only by apiName.
repeated string deprecated_api_names = 4;
| Returns | |
|---|---|
| Type | Description |
int |
The count of deprecatedApiNames. |
getDeprecatedApiNamesList()
public ProtocolStringList getDeprecatedApiNamesList() Still usable but deprecated names for this dimension. If populated, this
dimension is available by either apiName or one of deprecatedApiNames
for a period of time. After the deprecation period, the dimension will be
available only by apiName.
repeated string deprecated_api_names = 4;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the deprecatedApiNames. |
getDescription()
public String getDescription()Description of how this dimension is used and calculated.
string description = 3;
| Returns | |
|---|---|
| Type | Description |
String |
The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()Description of how this dimension is used and calculated.
string description = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for description. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getUiName()
public String getUiName() This dimension's name within the Google Analytics user interface. For
example, Event name.
string ui_name = 2;
| Returns | |
|---|---|
| Type | Description |
String |
The uiName. |
getUiNameBytes()
public ByteString getUiNameBytes() This dimension's name within the Google Analytics user interface. For
example, Event name.
string ui_name = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for uiName. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(DimensionMetadata other)
public DimensionMetadata.Builder mergeFrom(DimensionMetadata other)| Parameter | |
|---|---|
| Name | Description |
other |
DimensionMetadata |
| Returns | |
|---|---|
| Type | Description |
DimensionMetadata.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public DimensionMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
DimensionMetadata.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public DimensionMetadata.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
DimensionMetadata.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final DimensionMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
DimensionMetadata.Builder |
|
setApiName(String value)
public DimensionMetadata.Builder setApiName(String value) This dimension's name. Useable in Dimension's name. For
example, eventName.
string api_name = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe apiName to set. |
| Returns | |
|---|---|
| Type | Description |
DimensionMetadata.Builder |
This builder for chaining. |
setApiNameBytes(ByteString value)
public DimensionMetadata.Builder setApiNameBytes(ByteString value) This dimension's name. Useable in Dimension's name. For
example, eventName.
string api_name = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for apiName to set. |
| Returns | |
|---|---|
| Type | Description |
DimensionMetadata.Builder |
This builder for chaining. |
setCategory(String value)
public DimensionMetadata.Builder setCategory(String value)The display name of the category that this dimension belongs to. Similar dimensions and metrics are categorized together.
string category = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe category to set. |
| Returns | |
|---|---|
| Type | Description |
DimensionMetadata.Builder |
This builder for chaining. |
setCategoryBytes(ByteString value)
public DimensionMetadata.Builder setCategoryBytes(ByteString value)The display name of the category that this dimension belongs to. Similar dimensions and metrics are categorized together.
string category = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for category to set. |
| Returns | |
|---|---|
| Type | Description |
DimensionMetadata.Builder |
This builder for chaining. |
setCustomDefinition(boolean value)
public DimensionMetadata.Builder setCustomDefinition(boolean value)True if the dimension is custom to this property. This includes user, event, & item scoped custom dimensions; to learn more about custom dimensions, see https://support.google.com/analytics/answer/14240153. This also include custom channel groups; to learn more about custom channel groups, see https://support.google.com/analytics/answer/13051316.
bool custom_definition = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe customDefinition to set. |
| Returns | |
|---|---|
| Type | Description |
DimensionMetadata.Builder |
This builder for chaining. |
setDeprecatedApiNames(int index, String value)
public DimensionMetadata.Builder setDeprecatedApiNames(int index, String value) Still usable but deprecated names for this dimension. If populated, this
dimension is available by either apiName or one of deprecatedApiNames
for a period of time. After the deprecation period, the dimension will be
available only by apiName.
repeated string deprecated_api_names = 4;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe deprecatedApiNames to set. |
| Returns | |
|---|---|
| Type | Description |
DimensionMetadata.Builder |
This builder for chaining. |
setDescription(String value)
public DimensionMetadata.Builder setDescription(String value)Description of how this dimension is used and calculated.
string description = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe description to set. |
| Returns | |
|---|---|
| Type | Description |
DimensionMetadata.Builder |
This builder for chaining. |
setDescriptionBytes(ByteString value)
public DimensionMetadata.Builder setDescriptionBytes(ByteString value)Description of how this dimension is used and calculated.
string description = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for description to set. |
| Returns | |
|---|---|
| Type | Description |
DimensionMetadata.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public DimensionMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
DimensionMetadata.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public DimensionMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
DimensionMetadata.Builder |
|
setUiName(String value)
public DimensionMetadata.Builder setUiName(String value) This dimension's name within the Google Analytics user interface. For
example, Event name.
string ui_name = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe uiName to set. |
| Returns | |
|---|---|
| Type | Description |
DimensionMetadata.Builder |
This builder for chaining. |
setUiNameBytes(ByteString value)
public DimensionMetadata.Builder setUiNameBytes(ByteString value) This dimension's name within the Google Analytics user interface. For
example, Event name.
string ui_name = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for uiName to set. |
| Returns | |
|---|---|
| Type | Description |
DimensionMetadata.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final DimensionMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
DimensionMetadata.Builder |
|