Reference documentation and code samples for the Google Analytics Data V1beta Client class DimensionMetadata.
Explains a dimension.
Generated from protobuf messagegoogle.analytics.data.v1beta.DimensionMetadata
Namespace
Google \ Analytics \ Data \ V1beta
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ api_name
string
This dimension's name. Useable inDimension'sname. For example,eventName.
↳ ui_name
string
This dimension's name within the Google Analytics user interface. For example,Event name.
↳ description
string
Description of how this dimension is used and calculated.
↳ deprecated_api_names
array
Still usable but deprecated names for this dimension. If populated, this dimension is available by eitherapiNameor one ofdeprecatedApiNamesfor a period of time. After the deprecation period, the dimension will be available only byapiName.
The display name of the category that this dimension belongs to. Similar dimensions and metrics are categorized together.
getApiName
This dimension's name. Useable inDimension'sname. For
example,eventName.
Returns
Type
Description
string
setApiName
This dimension's name. Useable inDimension'sname. For
example,eventName.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getUiName
This dimension's name within the Google Analytics user interface. For
example,Event name.
Returns
Type
Description
string
setUiName
This dimension's name within the Google Analytics user interface. For
example,Event name.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDescription
Description of how this dimension is used and calculated.
Returns
Type
Description
string
setDescription
Description of how this dimension is used and calculated.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDeprecatedApiNames
Still usable but deprecated names for this dimension. If populated, this
dimension is available by eitherapiNameor one ofdeprecatedApiNamesfor a period of time. After the deprecation period, the dimension will be
available only byapiName.
Still usable but deprecated names for this dimension. If populated, this
dimension is available by eitherapiNameor one ofdeprecatedApiNamesfor a period of time. After the deprecation period, the dimension will be
available only byapiName.
[[["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-09-04 UTC."],[],[],null,["# Google Analytics Data V1beta Client - Class DimensionMetadata (0.22.3)\n\nVersion latestkeyboard_arrow_down\n\n- [0.22.3 (latest)](/php/docs/reference/analytics-data/latest/V1beta.DimensionMetadata)\n- [0.22.2](/php/docs/reference/analytics-data/0.22.2/V1beta.DimensionMetadata)\n- [0.21.1](/php/docs/reference/analytics-data/0.21.1/V1beta.DimensionMetadata)\n- [0.20.1](/php/docs/reference/analytics-data/0.20.1/V1beta.DimensionMetadata)\n- [0.19.0](/php/docs/reference/analytics-data/0.19.0/V1beta.DimensionMetadata)\n- [0.18.0](/php/docs/reference/analytics-data/0.18.0/V1beta.DimensionMetadata)\n- [0.17.1](/php/docs/reference/analytics-data/0.17.1/V1beta.DimensionMetadata)\n- [0.16.4](/php/docs/reference/analytics-data/0.16.4/V1beta.DimensionMetadata)\n- [0.14.0](/php/docs/reference/analytics-data/0.14.0/V1beta.DimensionMetadata)\n- [0.13.0](/php/docs/reference/analytics-data/0.13.0/V1beta.DimensionMetadata)\n- [0.12.0](/php/docs/reference/analytics-data/0.12.0/V1beta.DimensionMetadata)\n- [0.11.2](/php/docs/reference/analytics-data/0.11.2/V1beta.DimensionMetadata)\n- [0.10.1](/php/docs/reference/analytics-data/0.10.1/V1beta.DimensionMetadata)\n- [0.9.5](/php/docs/reference/analytics-data/0.9.5/V1beta.DimensionMetadata) \n| **Beta**\n|\n|\n| This library is covered by the [Pre-GA Offerings Terms](/terms/service-terms#1)\n| of the Terms of Service. Pre-GA libraries might have limited support,\n| and changes to pre-GA libraries might not be compatible with other pre-GA versions.\n| For more information, see the\n[launch stage descriptions](/products#product-launch-stages). \nReference documentation and code samples for the Google Analytics Data V1beta Client class DimensionMetadata.\n\nExplains a dimension.\n\nGenerated from protobuf message `google.analytics.data.v1beta.DimensionMetadata`\n\nNamespace\n---------\n\nGoogle \\\\ Analytics \\\\ Data \\\\ V1beta\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getApiName\n\nThis dimension's name. Useable in [Dimension](#Dimension)'s `name`. For\nexample, `eventName`.\n\n### setApiName\n\nThis dimension's name. Useable in [Dimension](#Dimension)'s `name`. For\nexample, `eventName`.\n\n### getUiName\n\nThis dimension's name within the Google Analytics user interface. For\nexample, `Event name`.\n\n### setUiName\n\nThis dimension's name within the Google Analytics user interface. For\nexample, `Event name`.\n\n### getDescription\n\nDescription of how this dimension is used and calculated.\n\n### setDescription\n\nDescription of how this dimension is used and calculated.\n\n### getDeprecatedApiNames\n\nStill usable but deprecated names for this dimension. If populated, this\ndimension is available by either `apiName` or one of `deprecatedApiNames`\nfor a period of time. After the deprecation period, the dimension will be\navailable only by `apiName`.\n\n### setDeprecatedApiNames\n\nStill usable but deprecated names for this dimension. If populated, this\ndimension is available by either `apiName` or one of `deprecatedApiNames`\nfor a period of time. After the deprecation period, the dimension will be\navailable only by `apiName`.\n\n### getCustomDefinition\n\nTrue if the dimension is custom to this property. This includes user,\nevent, \\& item scoped custom dimensions; to learn more about custom\ndimensions, see \u003chttps://support.google.com/analytics/answer/14240153\u003e. This\nalso include custom channel groups; to learn more about custom channel\ngroups, see \u003chttps://support.google.com/analytics/answer/13051316\u003e.\n\n### setCustomDefinition\n\nTrue if the dimension is custom to this property. This includes user,\nevent, \\& item scoped custom dimensions; to learn more about custom\ndimensions, see \u003chttps://support.google.com/analytics/answer/14240153\u003e. This\nalso include custom channel groups; to learn more about custom channel\ngroups, see \u003chttps://support.google.com/analytics/answer/13051316\u003e.\n\n### getCategory\n\nThe display name of the category that this dimension belongs to. Similar\ndimensions and metrics are categorized together.\n\n### setCategory\n\nThe display name of the category that this dimension belongs to. Similar\ndimensions and metrics are categorized together."]]
