CustomDimension is a JSON Structure definition published by Google Analytics, describing 6 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/google-analytics/refs/heads/main/json-structure/admin-api-custom-dimension-structure.json",
"name": "CustomDimension",
"description": "A definition for a CustomDimension.",
"type": "object",
"properties": {
"description": {
"description": "Optional. Description for this custom dimension. Max length of 150 characters.",
"type": "string"
},
"disallowAdsPersonalization": {
"description": "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.",
"type": "boolean"
},
"displayName": {
"description": "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.",
"type": "string"
},
"name": {
"description": "Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}",
"readOnly": true,
"type": "string"
},
"parameterName": {
"description": "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.",
"type": "string"
},
"scope": {
"description": "Required. Immutable. The scope of this dimension.",
"enum": [
"DIMENSION_SCOPE_UNSPECIFIED",
"EVENT",
"USER",
"ITEM"
],
"type": "string"
}
}
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.