This dimension's name. Useable in Dimension's name. For example, eventName.
uiName
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.
deprecatedApiNames[]
string
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-19 UTC."],[[["\u003cp\u003eThis document outlines the JSON representation of a dimension within Google Analytics, detailing its structure and the purpose of each field.\u003c/p\u003e\n"],["\u003cp\u003eA dimension is described by its API name, UI name, description, any deprecated API names, whether it's a custom definition, and its category.\u003c/p\u003e\n"],["\u003cp\u003eThe provided JSON schema can be used to understand how dimension data is structured and accessed within the Google Analytics system.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can leverage this information to programmatically interact with and utilize dimensions for analysis and reporting purposes.\u003c/p\u003e\n"]]],["The core content describes the structure of a dimension using a JSON representation. Key components include `apiName` (the dimension's programmatic name), `uiName` (its display name), and `description`. It also details `deprecatedApiNames` for managing name changes, `customDefinition` to identify user-defined dimensions, and `category` for grouping. These fields provide information for both technical and user-facing identification and use of the dimension.\n"],null,["# DimensionMetadata\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n\nExplains a dimension.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"apiName\": string, \"uiName\": string, \"description\": string, \"deprecatedApiNames\": [ string ], \"customDefinition\": boolean, \"category\": string } ``` |\n\n| Fields ||\n|----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `api``Name` | `string` This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For example, `eventName`. |\n| `ui``Name` | `string` This dimension's name within the Google Analytics user interface. For example, `Event name`. |\n| `description` | `string` Description of how this dimension is used and calculated. |\n| `deprecated``Api``Names[]` | `string` 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`. |\n| `custom``Definition` | `boolean` True if the dimension is custom to this property. This includes user, event, \\& item scoped custom dimensions; to learn more about custom dimensions, see \u003chttps://support.google.com/analytics/answer/14240153\u003e. This also include custom channel groups; to learn more about custom channel groups, see \u003chttps://support.google.com/analytics/answer/13051316\u003e. |\n| `category` | `string` The display name of the category that this dimension belongs to. Similar dimensions and metrics are categorized together. |"]]
