Interface DimensionMetadataOrBuilder (0.63.0)

Version 0.63.0

• 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 interface DimensionMetadataOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getApiName()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getDeprecatedApiNames(int index)

public abstract 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	int The index of the element to return.

Returns
Type	Description
String	The deprecatedApiNames at the given index.

getDeprecatedApiNamesBytes(int index)

public abstract 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	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the deprecatedApiNames at the given index.

getDeprecatedApiNamesCount()

public abstract 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 abstract List<String> 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
List<String>	A list containing the deprecatedApiNames.

getDescription()

public abstract String getDescription()

Description of how this dimension is used and calculated.

string description = 3;

Returns
Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Description of how this dimension is used and calculated.

string description = 3;

Returns
Type	Description
ByteString	The bytes for description.

getUiName()

public abstract 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 abstract 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.