Google Analytics için MCP sunucusunu deneyin.
GitHub'dan yükleyin ve daha fazla bilgi için
duyuruyu inceleyin.
REST Resource: properties.customDimensions
Koleksiyonlar ile düzeninizi koruyun
İçeriği tercihlerinize göre kaydedin ve kategorilere ayırın.
Kaynak: CustomDimension
CustomDimension'ın tanımı.
JSON gösterimi |
{
"name": string,
"parameterName": string,
"displayName": string,
"description": string,
"scope": enum (DimensionScope ),
"disallowAdsPersonalization": boolean
} |
Alanlar |
name |
string
Yalnızca çıkış. Bu CustomDimension kaynağının kaynak adı. Biçim: özellikler/{property}/customDimensions/{customDimension}
|
parameterName |
string
Zorunlu. Sabit. Bu özel boyut için etiketleme parametresi adı. Bu, kullanıcı kapsamlı bir boyutsa kullanıcı özelliğinin adıdır. Etkinlik kapsamlı bir boyutsa etkinlik parametresinin adıdır. Bu, öğe kapsamlı bir boyutsa e-Ticaret öğeleri dizisinde bulunan parametre adıdır. Harfle başlayan yalnızca alfanümerik karakterler ve alt çizgi karakterleri içerebilir. Kullanıcı kapsamlı boyutlar için maksimum 24 karakter, etkinlik kapsamlı boyutlar için 40 karakterdir.
|
displayName |
string
Zorunlu. Bu özel boyut için, Analytics kullanıcı arayüzünde gösterilen görünen ad. Maksimum 82 karakter, alfanümerik artı boşluk ve harfle başlayan alt çizgi. Sistem tarafından oluşturulan eski görünen adlar köşeli parantez içerebilir ancak bu alanda yapılacak güncellemeler hiçbir zaman köşeli parantezlere izin vermez.
|
description |
string
İsteğe bağlı. Bu özel boyutun açıklaması. En fazla 150 karakter.
|
scope |
enum (DimensionScope )
Zorunlu. Sabit. Bu boyutun kapsamı.
|
disallowAdsPersonalization |
boolean
İsteğe bağlı. Doğru değerine ayarlanırsa bu boyutu NPA olarak ayarlar ve reklam kişiselleştirmeden hariç tutar. Bu özellik, şu anda yalnızca kullanıcı kapsamlı özel boyutlar tarafından desteklenmektedir.
|
DimensionScope
Bu boyutun kapsamı için geçerli değerler.
Sıralamalar |
DIMENSION_SCOPE_UNSPECIFIED |
Kapsam bilinmiyor veya belirtilmedi. |
EVENT |
Boyut, bir etkinliğe ayarlandı. |
USER |
Boyut, kullanıcı olarak ayarlandı. |
ITEM |
Kapsamı e-ticaret öğeleri için olan boyut |
Yöntemler |
|
Bir özellikteki CustomDimension'ı arşivler. |
|
Bir Özel Boyut oluşturur. |
|
Tek bir CustomDimension arayın. |
|
Bir mülkte CustomDimensions'ı listeler. |
|
Bir mülkteki CustomDimension'ı günceller. |
Aksi belirtilmediği sürece bu sayfanın içeriği Creative Commons Atıf 4.0 Lisansı altında ve kod örnekleri Apache 2.0 Lisansı altında lisanslanmıştır. Ayrıntılı bilgi için Google Developers Site Politikaları'na göz atın. Java, Oracle ve/veya satış ortaklarının tescilli ticari markasıdır.
Son güncelleme tarihi: 2025-07-26 UTC.
[null,null,["Son güncelleme tarihi: 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. |"]]