Reference documentation and code samples for the Google Analytics Data V1alpha Client class DimensionMetadata.
Explains a dimension.
Generated from protobuf message google.analytics.data.v1alpha.DimensionMetadata
Namespace
Google \ Analytics \ Data \ V1alphaMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ api_name
↳ 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
string[]
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
.
↳ custom_definition
bool
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 .
↳ category
string
The display name of the category that this dimension belongs to. Similar dimensions and metrics are categorized together.
↳ sections
int[]
Specifies the Google Analytics sections this dimension applies to.
getApiName
This dimension's name. Usable in Dimension
's name
. For
example, eventName
.
string
setApiName
This dimension's name. Usable in Dimension
's name
. For
example, eventName
.
var
string
$this
getUiName
This dimension's name within the Google Analytics user interface. For
example, Event name
.
string
setUiName
This dimension's name within the Google Analytics user interface. For
example, Event name
.
var
string
$this
getDescription
Description of how this dimension is used and calculated.
string
setDescription
Description of how this dimension is used and calculated.
var
string
$this
getDeprecatedApiNames
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
.
setDeprecatedApiNames
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
.
var
string[]
$this
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
setCustomDefinition
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 .
var
bool
$this
getCategory
The display name of the category that this dimension belongs to. Similar dimensions and metrics are categorized together.
string
setCategory
The display name of the category that this dimension belongs to. Similar dimensions and metrics are categorized together.
var
string
$this
getSections
Specifies the Google Analytics sections this dimension applies to.
setSections
Specifies the Google Analytics sections this dimension applies to.
var
int[]
$this
