Prueba el servidor de MCP para Google Analytics. Instala desde
GitHub y consulta el
anuncio para obtener más detalles.
REST Resource: properties.customDimensions
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Recurso: CustomDimension
Es una definición de CustomDimension.
Representación JSON |
{
"name": string,
"parameterName": string,
"displayName": string,
"description": string,
"scope": enum (DimensionScope ),
"disallowAdsPersonalization": boolean
} |
Campos |
name |
string
Solo salida. Nombre del recurso para este recurso CustomDimension. Formato: properties/{property}/customDimensions/{customDimension}
|
parameterName |
string
Obligatorio. Inmutable. Es el nombre del parámetro de etiquetado de esta dimensión personalizada. Si esta es una dimensión centrada en el usuario, este es el nombre de la propiedad del usuario. Si esta es una dimensión centrada en el evento, este es el nombre del parámetro del evento. Si esta es una dimensión centrada en el artículo, este es el nombre del parámetro que se encuentra en el array de artículos de comercio electrónico. Solo puede contener caracteres alfanuméricos y guiones bajos, que comiencen con una letra. La longitud máxima es de 24 caracteres para las dimensiones centradas en el usuario y 40 caracteres para las dimensiones centradas en el evento.
|
displayName |
string
Obligatorio. Es el nombre visible de esta dimensión personalizada como se muestra en la IU de Analytics. Debe tener una longitud máxima de 82 caracteres, con caracteres alfanuméricos más espacios y guiones bajos que comiencen con una letra. Los nombres visibles heredados que genera el sistema pueden contener corchetes, pero las actualizaciones de este campo nunca permitirán los corchetes.
|
description |
string
Opcional. Es la descripción de esta dimensión personalizada. Debe tener una longitud máxima de 150 caracteres.
|
scope |
enum (DimensionScope )
Obligatorio. Inmutable. Es el alcance de esta dimensión.
|
disallowAdsPersonalization |
boolean
Opcional. Si se establece como verdadera, establece esta dimensión como NPA y la excluye de la personalización de anuncios. Actualmente, esto solo se admite en dimensiones personalizadas centradas en el usuario.
|
DimensionScope
Valores válidos para el alcance de esta dimensión.
Enumeraciones |
DIMENSION_SCOPE_UNSPECIFIED |
Alcance desconocido o no especificado. |
EVENT |
Es la dimensión centrada en un evento. |
USER |
Es la dimensión centrada en un usuario. |
ITEM |
Dimensión centrada en los artículos de comercio electrónico |
Métodos |
|
Archiva una CustomDimension en una propiedad. |
|
Crea una CustomDimension. |
|
Se busca para una sola CustomDimension. |
|
Muestra una lista de CustomDimensions en una propiedad. |
|
Actualiza una CustomDimension en una propiedad. |
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-26 (UTC)
[null,null,["Última actualización: 2025-07-26 (UTC)"],[[["\u003cp\u003e\u003ccode\u003eCustomDimension\u003c/code\u003e resource allows defining custom dimensions with specific parameters like name, display name, description, scope, and whether it's excluded from ads personalization.\u003c/p\u003e\n"],["\u003cp\u003eThe scope of a custom dimension can be \u003ccode\u003eEVENT\u003c/code\u003e, \u003ccode\u003eUSER\u003c/code\u003e, or \u003ccode\u003eITEM\u003c/code\u003e, determining the level at which the dimension is applied.\u003c/p\u003e\n"],["\u003cp\u003eYou can manage custom dimensions using methods like \u003ccode\u003ecreate\u003c/code\u003e, \u003ccode\u003eget\u003c/code\u003e, \u003ccode\u003elist\u003c/code\u003e, \u003ccode\u003eupdate\u003c/code\u003e, and \u003ccode\u003earchive\u003c/code\u003e to control their lifecycle within your Google Analytics 4 property.\u003c/p\u003e\n"],["\u003cp\u003eCustom dimensions can be user-scoped, event-scoped or item-scoped, each with specific requirements for the parameter name used.\u003c/p\u003e\n"],["\u003cp\u003eThe JSON representation of a \u003ccode\u003eCustomDimension\u003c/code\u003e includes fields for essential properties, allowing programmatic management of custom dimensions.\u003c/p\u003e\n"]]],["Custom dimensions are defined with properties like `name`, `parameterName`, `displayName`, `description`, `scope`, and `disallowAdsPersonalization`. The `parameterName` is a tagging parameter, while `scope` defines if it's for events, users, or items. Actions include creating, getting, listing, patching, and archiving a custom dimension. The `DimensionScope` can be `EVENT`, `USER`, or `ITEM`. `disallowAdsPersonalization` excludes the dimension from ads personalization and is only supported for user-scoped custom dimensions.\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/v1alpha/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/v1alpha/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/v1alpha/properties.customDimensions/archive) | Archives a CustomDimension on a property. |\n| ### [create](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.customDimensions/create) | Creates a CustomDimension. |\n| ### [get](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.customDimensions/get) | Lookup for a single CustomDimension. |\n| ### [list](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.customDimensions/list) | Lists CustomDimensions on a property. |\n| ### [patch](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.customDimensions/patch) | Updates a CustomDimension on a property. |"]]