Reference documentation and code samples for the Google Analytics Admin V1beta Client class CustomDimension.
A definition for a CustomDimension.
Generated from protobuf message google.analytics.admin.v1beta.CustomDimension
Namespace
Google \ Analytics \ Admin \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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 | |
|---|---|
| Type | Description |
string |
|
setName
Output only. Resource name for this CustomDimension resource.
Format: properties/{property}/customDimensions/{customDimension}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. Description for this custom dimension. Max length of 150 characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. Description for this custom dimension. Max length of 150 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getScope
Required. Immutable. The scope of this dimension.
| Returns | |
|---|---|
| Type | Description |
int |
|
setScope
Required. Immutable. The scope of this dimension.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|