REST Resource: properties.customDimensions

संसाधन: कस्टम डाइमेंशन

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

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

string

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

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

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