Google Analytics Admin V1alpha Client - Class CustomDimension (0.16.0)

Reference documentation and code samples for the Google Analytics Admin V1alpha Client class CustomDimension.

A definition for a CustomDimension.

Generated from protobuf message google.analytics.admin.v1alpha.CustomDimension

Namespace

Google \ Analytics \ Admin \ V1alpha

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}

↳ parameter_name string

Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. If this is an item-scoped dimension, then this is the parameter name found in the eCommerce items array. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions.

↳ display_name string

Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.

↳ description string

Optional. Description for this custom dimension. Max length of 150 characters.

↳ scope int

Required. Immutable. The scope of this dimension.

↳ disallow_ads_personalization bool

Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions.

getName

Output only. Resource name for this CustomDimension resource.

Format: properties/{property}/customDimensions/{customDimension}

Returns
TypeDescription
string

setName

Output only. Resource name for this CustomDimension resource.

Format: properties/{property}/customDimensions/{customDimension}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getParameterName

Required. Immutable. Tagging parameter name for this custom dimension.

If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. If this is an item-scoped dimension, then this is the parameter name found in the eCommerce items array. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions.

Returns
TypeDescription
string

setParameterName

Required. Immutable. Tagging parameter name for this custom dimension.

If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. If this is an item-scoped dimension, then this is the parameter name found in the eCommerce items array. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDisplayName

Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.

Returns
TypeDescription
string

setDisplayName

Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDescription

Optional. Description for this custom dimension. Max length of 150 characters.

Returns
TypeDescription
string

setDescription

Optional. Description for this custom dimension. Max length of 150 characters.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getScope

Required. Immutable. The scope of this dimension.

Returns
TypeDescription
int

setScope

Required. Immutable. The scope of this dimension.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getDisallowAdsPersonalization

Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization.

This is currently only supported by user-scoped custom dimensions.

Returns
TypeDescription
bool

setDisallowAdsPersonalization

Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization.

This is currently only supported by user-scoped custom dimensions.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this