Coba server MCP untuk Google Analytics. Instal dari
GitHub, dan lihat
pengumuman untuk mengetahui detail selengkapnya.
REST Resource: properties.customDimensions
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Resource: CustomDimension
Definisi untuk CustomDimension.
Representasi JSON |
{
"name": string,
"parameterName": string,
"displayName": string,
"description": string,
"scope": enum (DimensionScope ),
"disallowAdsPersonalization": boolean
} |
Kolom |
name |
string
Hanya output. Nama resource untuk resource CustomDimension ini. Format: properties/{property}/customDimensions/{customDimension}
|
parameterName |
string
Wajib. Tidak dapat diubah. Nama parameter pemberian tag untuk dimensi kustom ini. Jika ini adalah dimensi cakupan pengguna, ini adalah nama properti pengguna. Jika ini adalah dimensi cakupan peristiwa, ini adalah nama parameter peristiwa. Jika ini adalah dimensi cakupan item, berarti ini adalah nama parameter yang ditemukan dalam array item e-Commerce. Hanya dapat berisi karakter alfanumerik dan garis bawah, yang dimulai dengan huruf. Panjang maksimum 24 karakter untuk dimensi cakupan pengguna, 40 karakter untuk dimensi cakupan peristiwa.
|
displayName |
string
Wajib. Nama tampilan untuk dimensi kustom ini seperti yang ditampilkan di UI Analytics. Panjang maksimal 82 karakter, alfanumerik plus spasi dan garis bawah yang dimulai dengan huruf. Nama tampilan lama yang dibuat sistem dapat berisi tanda kurung siku, tetapi pembaruan pada kolom ini tidak akan mengizinkan tanda kurung siku.
|
description |
string
Opsional. Deskripsi untuk dimensi kustom ini. Panjang maksimal 150 karakter.
|
scope |
enum (DimensionScope )
Wajib. Tidak dapat diubah. Cakupan dimensi ini.
|
disallowAdsPersonalization |
boolean
Opsional. Jika ditetapkan ke true, menetapkan dimensi ini sebagai NPA dan mengecualikannya dari personalisasi iklan. Saat ini, fungsi ini hanya didukung oleh dimensi kustom cakupan pengguna.
|
DimensionScope
Nilai yang valid untuk cakupan dimensi ini.
Enum |
DIMENSION_SCOPE_UNSPECIFIED |
Cakupan tidak diketahui atau tidak ditentukan. |
EVENT |
Dimensi yang dicakupkan ke peristiwa. |
USER |
Dimensi yang dicakupkan ke pengguna. |
ITEM |
Dimensi yang dicakupkan ke item e-commerce |
Metode |
|
Mengarsipkan CustomDimension pada properti. |
|
Membuat CustomDimension. |
|
Cari satu CustomDimension. |
|
Mencantumkan CustomDimensions pada properti. |
|
Memperbarui CustomDimension pada properti. |
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2025-07-26 UTC.
[null,null,["Terakhir diperbarui pada 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. |"]]