Tag Manager API - पैरामीटर का रेफ़रंस

इस दस्तावेज़ में Tag Manager पैरामीटर ऑब्जेक्ट के मकसद और उसे दिखाने के मकसद के बारे में बताया गया है.

शुरुआती जानकारी

Tag Manager API की मदद से, टैग, नियम, और मैक्रो जैसे Tag Manager रिसॉर्स बनाए और मैनेज किए जा सकते हैं.

ज़्यादातर टैग और मैक्रो टाइप में अतिरिक्त पैरामीटर होते हैं, जो खास टैग या मैक्रो के लिए होते हैं. इन्हें संसाधन बनाते/अपडेट करते समय सेट किया जा सकता है. हर टैग और मैक्रो टाइप के लिए पैरामीटर (key, type पेयर) की सूची टैग डिक्शनरी रेफ़रंस और मैक्रो डिक्शनरी रेफ़रंस में दी गई है.

इन टैग या मैक्रो के खास पैरामीटर को कॉन्फ़िगर करने के लिए, एक पैरामीटर ऑब्जेक्ट को टैग या मैक्रो संसाधन की parameter प्रॉपर्टी की वैल्यू के तौर पर सेट किया जाता है.

पैरामीटर ऑब्जेक्ट

यहां दिया गया ऑब्जेक्ट, एक पैरामीटर ऑब्जेक्ट दिखाता है:

[
  {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ]
  }
]

type

कॉन्फ़िगर किए जा रहे टैग या मैक्रो का पैरामीटर टाइप.

जैसा कि नीचे टेबल में बताया गया है, type प्रॉपर्टी यह तय करेगी कि पैरामीटर ऑब्जेक्ट में value, list या map प्रॉपर्टी को शामिल करने की ज़रूरत है या नहीं.

उदाहरण के लिए, अगर type को boolean पर सेट किया गया है, तो value प्रॉपर्टी को पैरामीटर ऑब्जेक्ट में शामिल किया जाना चाहिए और true या false पर सेट किया जाना चाहिए.

वैल्यू	शामिल की जाने वाली अन्य प्रॉपर्टी	दूसरी प्रॉपर्टी को किस पर सेट करें
template	value	value कोई भी स्ट्रिंग होती है, जिसमें मैक्रो रेफ़रंस भी शामिल होते हैं, जैसे कि foo{{bar}}.
boolean	value	value, true या false है.
number	value	value एक पूर्णांक है.
list	list	list में शून्य या उससे ज़्यादा पैरामीटर होंगे. ऑर्डर का क्रम या इससे कोई फ़र्क़ नहीं पड़ सकता है. list में किसी भी पैरामीटर के key को अनदेखा कर दिया जाएगा.
map	map	map में शून्य या उससे ज़्यादा पैरामीटर होंगे. ऑर्डर से कोई फ़र्क़ नहीं पड़ता. map में किसी भी पैरामीटर का key यूनीक होना चाहिए.

key

कॉन्फ़िगर की जा रही टैग या मैक्रो की पैरामीटर कुंजी.

key फ़ील्ड का इस्तेमाल सेट किए जा रहे खास टैग या मैक्रो के पैरामीटर की पहचान करने के लिए किया जाता है. सभी पैरामीटर टाइप में key प्रॉपर्टी होनी चाहिए (list पैरामीटर को छोड़कर).

उदाहरण

कस्टम एचटीएमएल टैग के लिए एक पैरामीटर ऑब्जेक्ट, जिसमें एक template टाइप का पैरामीटर और दो boolean टाइप के पैरामीटर होते हैं:

"parameter": [
  {
    "key": "html",
    "type": "template",
    "value": "<script>alert('hello world')</script>"
  },
  {
    "key": "supportDocumentWrite",
    "type": "boolean",
    "value": "false"
  }
]

लुक-अप टेबल मैक्रो के लिए एक पैरामीटर ऑब्जेक्ट, जिसमें दो template टाइप के पैरामीटर और एक list टाइप पैरामीटर होता है:

"parameter": [
  {
    "type": "template",
    "key": "input",
    "value": "{{event}}"
  },
  {
    "type": "list",
    "key": "map",
    "list": [
      {
        "type": "map",
        "map": [
          {
            "type": "template",
            "key": "key",
            "value": "EventEqualsThis"
          },
          {
            "type": "template",
            "key": "value",
            "value": "ThenSetToThis"
          }
        ]
      }
    ]
  },
  {
    "type": "template",
    "key": "defaultValue",
    "value": "MyDefaultValue"
  }
]

फ़ंक्शन कॉल टैग के लिए एक पैरामीटर ऑब्जेक्ट, जिसमें एक template टाइप का पैरामीटर और एक map टाइप पैरामीटर होता है:

"parameter": [
  {
    "key": "functionName",
    "type": "template",
    "value": "fn"
  },
  {
    "key": "functionArgument",
    "map": [
      {
        "key": "argkey1",
        "type": "template",
        "value": "argval1"
      }
    ],
    "type": "map"
  }
]