REST Resource: properties.customDimensions

संसाधन: CustomDimension

कस्टम डाइमेंशन की परिभाषा.

JSON के काेड में दिखाना 
{
  "name": string,
  "parameterName": string,
  "displayName": string,
  "description": string,
  "scope": enum (DimensionScope),
  "disallowAdsPersonalization": boolean
}
फ़ील्ड
name

string

सिर्फ़ आउटपुट के लिए. इस कस्टम डाइमेंशन संसाधन के लिए संसाधन का नाम. फ़ॉर्मैट: properties/{property}/customDimensions/{customDimension}
parameterName

string

ज़रूरी है. इम्यूटेबल. इस कस्टम डाइमेंशन के लिए, टैगिंग पैरामीटर का नाम.

अगर यह उपयोगकर्ता के स्कोप वाला डाइमेंशन है, तो यह उपयोगकर्ता प्रॉपर्टी का नाम है. अगर यह इवेंट के दायरे वाला डाइमेंशन है, तो यह इवेंट पैरामीटर का नाम है.

अगर यह आइटम के स्कोप वाला डाइमेंशन है, तो यह ई-कॉमर्स आइटम कलेक्शन में मौजूद पैरामीटर का नाम है.

इसमें सिर्फ़ अक्षर, अंक, और अंडरस्कोर हो सकते हैं. साथ ही, यह किसी अक्षर से शुरू होना चाहिए. उपयोगकर्ता के स्कोप वाले डाइमेंशन के लिए, नाम की ज़्यादा से ज़्यादा लंबाई 24 वर्ण होनी चाहिए. वहीं, इवेंट के स्कोप वाले डाइमेंशन के लिए, नाम की ज़्यादा से ज़्यादा लंबाई 40 वर्ण होनी चाहिए.
displayName

string

ज़रूरी है. इस कस्टम डाइमेंशन का डिसप्ले नेम, जैसा कि Analytics के यूज़र इंटरफ़ेस (यूआई) में दिखाया गया है. ज़्यादा से ज़्यादा 82 वर्ण, अक्षर और अंक के साथ-साथ स्पेस और अंडरस्कोर. लेगसी सिस्टम से जनरेट किए गए डिसप्ले नेम में स्क्वेयर ब्रैकेट हो सकते हैं. हालांकि, इस फ़ील्ड में अपडेट करने पर, स्क्वेयर ब्रैकेट की अनुमति कभी नहीं दी जाएगी.
description

string

ज़रूरी नहीं. इस कस्टम डाइमेंशन के बारे में जानकारी. ज़्यादा से ज़्यादा 150 वर्ण.
scope

enum (DimensionScope)

ज़रूरी है. इम्यूटेबल. इस डाइमेंशन का दायरा.
disallowAdsPersonalization

boolean

ज़रूरी नहीं. अगर इस वैल्यू को 'सही' पर सेट किया जाता है, तो इस डाइमेंशन को एनपीए के तौर पर सेट किया जाता है और इसे दिलचस्पी के मुताबिक विज्ञापन दिखाने की सुविधा से बाहर रखा जाता है.

फ़िलहाल, यह सुविधा सिर्फ़ उपयोगकर्ता के स्कोप वाले कस्टम डाइमेंशन के साथ काम करती है.

DimensionScope

इस डाइमेंशन के दायरे के लिए मान्य वैल्यू.

Enums
DIMENSION_SCOPE_UNSPECIFIED दायरा अज्ञात है या उसकी जानकारी नहीं दी गई है.
EVENT इवेंट के स्कोप वाला डाइमेंशन.
USER उपयोगकर्ता के स्कोप वाला डाइमेंशन.
ITEM ई-कॉमर्स आइटम के स्कोप वाला डाइमेंशन

तरीके

archive

 किसी प्रॉपर्टी पर मौजूद कस्टम डाइमेंशन को संग्रहित करता है.

create

 कस्टम डाइमेंशन बनाता है.

get

 किसी एक कस्टम डाइमेंशन के लिए लुकअप.

list

 किसी प्रॉपर्टी पर मौजूद कस्टम डाइमेंशन की सूची बनाता है.

patch

 यह किसी प्रॉपर्टी पर कस्टम डाइमेंशन को अपडेट करता है.