Nur Ausgabe. Ressourcenname für diese CustomDimension-Ressource. Format: properties/{property}/customDimensions/{customDimension}
parameterName
string
Erforderlich. Nicht veränderbar. Name des Tagging-Parameters für diese benutzerdefinierte Dimension.
Bei einer Dimension auf Nutzerebene ist das der Name der Nutzereigenschaft. Bei einer Dimension auf Ereignisebene ist das der Name des Ereignisparameters.
Bei einer Dimension auf Artikelebene ist das der Parametername im Array „E-Commerce-Artikel“.
Darf nur alphanumerische Zeichen und Unterstriche enthalten, die mit einem Buchstaben beginnen. Maximale Länge: 24 Zeichen für Dimensionen auf Nutzerebene und 40 Zeichen für ereignisbezogene Dimensionen.
displayName
string
Erforderlich. Anzeigename für diese benutzerdefinierte Dimension, wie in der Analytics-Benutzeroberfläche angezeigt. Darf 82 Zeichen lang sein, alphanumerische Zeichen plus Leerzeichen und Unterstriche beginnend mit einem Buchstaben. Ältere, vom System generierte Anzeigenamen können eckige Klammern enthalten. Aktualisierungen dieses Feldes lassen jedoch keine eckigen Klammern zu.
description
string
Optional. Beschreibung dieser benutzerdefinierten Dimension. Max. 150 Zeichen.
[[["Leicht verständlich","easyToUnderstand","thumb-up"],["Mein Problem wurde gelöst","solvedMyProblem","thumb-up"],["Sonstiges","otherUp","thumb-up"]],[["Benötigte Informationen nicht gefunden","missingTheInformationINeed","thumb-down"],["Zu umständlich/zu viele Schritte","tooComplicatedTooManySteps","thumb-down"],["Nicht mehr aktuell","outOfDate","thumb-down"],["Problem mit der Übersetzung","translationIssue","thumb-down"],["Problem mit Beispielen/Code","samplesCodeIssue","thumb-down"],["Sonstiges","otherDown","thumb-down"]],["Zuletzt aktualisiert: 2025-07-26 (UTC)."],[[["\u003cp\u003e\u003ccode\u003eCustomDimension\u003c/code\u003e resource allows defining custom dimensions with properties like name, display name, description, scope, and ads personalization settings.\u003c/p\u003e\n"],["\u003cp\u003eThe scope of a \u003ccode\u003eCustomDimension\u003c/code\u003e can be event, user, or item, dictating which data it's associated with.\u003c/p\u003e\n"],["\u003cp\u003eYou can manage \u003ccode\u003eCustomDimensions\u003c/code\u003e through methods like create, get, list, update, and archive to control your analytics data granularity.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eCustomDimensions\u003c/code\u003e utilize tagging parameters (e.g., event parameter name, user property name) to collect and organize specific data points.\u003c/p\u003e\n"]]],["Custom dimensions are defined with properties like `name`, `parameterName`, `displayName`, `description`, `scope`, and `disallowAdsPersonalization`. The `parameterName` is a tagging parameter, limited to 24-40 characters, while `displayName` is an 82-character label. `Scope` can be event, user, or item. Available methods for `CustomDimension` include `archive`, `create`, `get`, `list`, and `patch`, enabling actions such as creating, retrieving, and updating custom dimension resources.\n"],null,["# REST Resource: properties.customDimensions\n\n- [Resource: CustomDimension](#CustomDimension)\n - [JSON representation](#CustomDimension.SCHEMA_REPRESENTATION)\n- [DimensionScope](#DimensionScope)\n- [Methods](#METHODS_SUMMARY)\n\nResource: CustomDimension\n-------------------------\n\nA definition for a CustomDimension.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"parameterName\": string, \"displayName\": string, \"description\": string, \"scope\": enum (/analytics/devguides/config/admin/v1/rest/v1beta/properties.customDimensions#DimensionScope), \"disallowAdsPersonalization\": boolean } ``` |\n\n| Fields ||\n|------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} |\n| `parameterName` | `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. |\n| `displayName` | `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. |\n| `description` | `string` Optional. Description for this custom dimension. Max length of 150 characters. |\n| `scope` | `enum (`[DimensionScope](/analytics/devguides/config/admin/v1/rest/v1beta/properties.customDimensions#DimensionScope)`)` Required. Immutable. The scope of this dimension. |\n| `disallowAdsPersonalization` | `boolean` 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. |\n\nDimensionScope\n--------------\n\nValid values for the scope of this dimension.\n\n| Enums ||\n|-------------------------------|-------------------------------------|\n| `DIMENSION_SCOPE_UNSPECIFIED` | Scope unknown or not specified. |\n| `EVENT` | Dimension scoped to an event. |\n| `USER` | Dimension scoped to a user. |\n| `ITEM` | Dimension scoped to eCommerce items |\n\n| Methods ------- ||\n|-----------------------------------------------------------------------------------------------------|-------------------------------------------|\n| ### [archive](/analytics/devguides/config/admin/v1/rest/v1beta/properties.customDimensions/archive) | Archives a CustomDimension on a property. |\n| ### [create](/analytics/devguides/config/admin/v1/rest/v1beta/properties.customDimensions/create) | Creates a CustomDimension. |\n| ### [get](/analytics/devguides/config/admin/v1/rest/v1beta/properties.customDimensions/get) | Lookup for a single CustomDimension. |\n| ### [list](/analytics/devguides/config/admin/v1/rest/v1beta/properties.customDimensions/list) | Lists CustomDimensions on a property. |\n| ### [patch](/analytics/devguides/config/admin/v1/rest/v1beta/properties.customDimensions/patch) | Updates a CustomDimension on a property. |"]]