Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13286594.5 KB
properties

Creates a CustomDimension.

post/v1beta/{+parent}/customDimensions

Path parameters

parentstring required

Required. Example format: properties/1234

Request body

namestring

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

displayNamestring

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.

parameterNamestring

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.

descriptionstring

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

scope'DIMENSION_SCOPE_UNSPECIFIED' | 'EVENT' | 'USER' | 'ITEM'

Required. Immutable. The scope of this dimension.

disallowAdsPersonalizationboolean

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.

Response

Successful response