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 a custom dimension for this property.
getApiName
This dimension's name. Useable in Dimension
's name
. For
example, eventName
.
string
setApiName
This dimension's name. Useable 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 a custom dimension for this property.
bool
setCustomDefinition
True if the dimension is a custom dimension for this property.
var
bool
$this
