REST Resource: properties.customDimensions

संसाधन: CustomDimension

CustomDimension के लिए डेफ़िनिशन.

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

string

आइडेंटिफ़ायर. इस CustomDimension संसाधन का संसाधन नाम. फ़ॉर्मैट: properties/{property}/customDimensions/{customDimension}

parameterName

string

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

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

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

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

displayName

string

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

description

string

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

scope

enum (DimensionScope)

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

disallowAdsPersonalization

boolean

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

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

DimensionScope

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

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

तरीके

archive

यह किसी प्रॉपर्टी पर मौजूद CustomDimension को संग्रहित करता है.

create

इसकी मदद से CustomDimension बनाया जाता है.

get

किसी एक CustomDimension के लिए लुकअप.

list

किसी प्रॉपर्टी के CustomDimensions की सूची बनाता है.

patch

यह किसी प्रॉपर्टी पर CustomDimension को अपडेट करता है.