Google Analytics Data V1beta Client - Class DimensionMetadata (0.9.5)

Reference documentation and code samples for the Google Analytics Data V1beta Client class DimensionMetadata.

Explains a dimension.

Generated from protobuf message google.analytics.data.v1beta.DimensionMetadata

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ api_name string

This dimension's name. Useable in Dimension's name. 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 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.

↳ category string

The display name of the category that this dimension belongs to. Similar dimensions and metrics are categorized together.

getApiName

This dimension's name. Useable in Dimension's name. For example, eventName.

Returns
TypeDescription
string

setApiName

This dimension's name. Useable in Dimension's name. For example, eventName.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getUiName

This dimension's name within the Google Analytics user interface. For example, Event name.

Returns
TypeDescription
string

setUiName

This dimension's name within the Google Analytics user interface. For example, Event name.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDescription

Description of how this dimension is used and calculated.

Returns
TypeDescription
string

setDescription

Description of how this dimension is used and calculated.

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

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.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getCustomDefinition

True if the dimension is a custom dimension for this property.

Returns
TypeDescription
bool

setCustomDefinition

True if the dimension is a custom dimension for this property.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getCategory

The display name of the category that this dimension belongs to. Similar dimensions and metrics are categorized together.

Returns
TypeDescription
string

setCategory

The display name of the category that this dimension belongs to. Similar dimensions and metrics are categorized together.

Parameter
NameDescription
var string
Returns
TypeDescription
$this