فقط خروجی نام منبع برای این منبع CustomDimension. قالب: خواص/{property}/customDimensions/{customDimension}
parameterName
string
مورد نیاز. تغییرناپذیر. برچسب گذاری نام پارامتر برای این بعد سفارشی.
اگر این یک بعد با محدوده کاربر است، این نام ویژگی کاربر است. اگر این یک بعد با دامنه رویداد است، این نام پارامتر رویداد است.
اگر این یک بعد با دامنه مورد است، این نام پارامتر موجود در آرایه اقلام تجارت الکترونیک است.
ممکن است فقط شامل نویسه‌های حروف عددی و زیرخط باشد که با یک حرف شروع می‌شوند. حداکثر طول 24 نویسه برای ابعاد با محدوده کاربر، 40 نویسه برای ابعاد با محدوده رویداد.
displayName
string
مورد نیاز. نام نمایشی برای این بعد سفارشی همانطور که در رابط کاربری Analytics نشان داده شده است. حداکثر طول 82 کاراکتر، حروف عددی به اضافه فاصله و خط زیر که با یک حرف شروع می شود. نام‌های نمایشی تولید شده توسط سیستم قدیمی ممکن است دارای کروشه باشد، اما به‌روزرسانی‌های این فیلد هرگز اجازه ایجاد براکت را نمی‌دهد.
description
string
اختیاری. توضیحات برای این بعد سفارشی. حداکثر طول 150 کاراکتر
تاریخ آخرین به‌روزرسانی 2025-07-24 به‌وقت ساعت هماهنگ جهانی.
[[["درک آسان","easyToUnderstand","thumb-up"],["مشکلم را برطرف کرد","solvedMyProblem","thumb-up"],["غیره","otherUp","thumb-up"]],[["اطلاعاتی که نیاز دارم وجود ندارد","missingTheInformationINeed","thumb-down"],["بیشازحد پیچیده/ مراحل بسیار زیاد","tooComplicatedTooManySteps","thumb-down"],["قدیمی","outOfDate","thumb-down"],["مشکل ترجمه","translationIssue","thumb-down"],["مشکل کد / نمونهها","samplesCodeIssue","thumb-down"],["غیره","otherDown","thumb-down"]],["تاریخ آخرین به‌روزرسانی 2025-07-24 به‌وقت ساعت هماهنگ جهانی."],[[["\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. |"]]
