Essayez le serveur MCP pour Google Analytics. Installez-le depuis
GitHub et consultez l'
annonce pour en savoir plus.
REST Resource: properties.customDimensions
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Ressource: CustomDimension
Définition d'un CustomDimension.
Représentation JSON |
{
"name": string,
"parameterName": string,
"displayName": string,
"description": string,
"scope": enum (DimensionScope ),
"disallowAdsPersonalization": boolean
} |
Champs |
name |
string
Uniquement en sortie. Nom de ressource pour cette ressource CustomDimension. Format: Properties/{property}/customDimensions/{customDimension}
|
parameterName |
string
Obligatoire. Immuable. Nom du paramètre de taggage pour cette dimension personnalisée. S'il s'agit d'une dimension de portée utilisateur, il s'agit du nom de la propriété utilisateur. S'il s'agit d'une dimension de portée événement, il s'agit du nom du paramètre d'événement. S'il s'agit d'une dimension de portée article, il s'agit du nom du paramètre figurant dans le tableau "Articles d'e-commerce". Le nom ne doit contenir que des caractères alphanumériques et des traits de soulignement, et commencer par une lettre. Longueur maximale : 24 caractères pour les dimensions de portée utilisateur, 40 caractères pour les dimensions de portée événement.
|
displayName |
string
Obligatoire. Nom à afficher pour cette dimension personnalisée, comme indiqué dans l'interface utilisateur d'Analytics. Longueur maximale de 82 caractères, caractères alphanumériques, espaces et traits de soulignement commençant par une lettre. Les anciens noms à afficher générés par le système peuvent contenir des crochets, mais les modifications apportées à ce champ ne les autoriseront jamais.
|
description |
string
Facultatif. Description de cette dimension personnalisée. Longueur maximale : 150 caractères.
|
scope |
enum (DimensionScope )
Obligatoire. Immuable. Champ d'application de cette dimension.
|
disallowAdsPersonalization |
boolean
Facultatif. Si elle est définie sur "True", cette dimension est définie sur "ANP" et l'exclut de la personnalisation des annonces. Pour l'instant, cette option n'est compatible qu'avec les dimensions personnalisées de portée utilisateur.
|
DimensionScope
Valeurs valides pour la portée de cette dimension.
Enums |
DIMENSION_SCOPE_UNSPECIFIED |
Champ d'application inconnu ou non spécifié. |
EVENT |
Dimension appliquée à un événement. |
USER |
Dimension appliquée à un utilisateur. |
ITEM |
Dimension appliquée aux articles d'e-commerce |
Méthodes |
|
Archive un CustomDimension sur une propriété. |
|
Crée un CustomDimension. |
|
Recherche d'une seule dimension personnalisée. |
|
Liste "CustomDimensions" sur une propriété. |
|
Met à jour une dimension personnalisée sur une propriété. |
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/26 (UTC).
[null,null,["Dernière mise à jour le 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. |"]]