ট্যাগ ম্যানেজার API - প্যারামিটার রেফারেন্স

এই নথিটি ট্যাগ ম্যানেজার প্যারামিটার অবজেক্টের উদ্দেশ্য এবং উপস্থাপনা বর্ণনা করে।

ভূমিকা

ট্যাগ ম্যানেজার এপিআই আপনাকে ট্যাগ ম্যানেজার রিসোর্স যেমন ট্যাগ , নিয়ম এবং ম্যাক্রো তৈরি এবং পরিচালনা করতে দেয়।

বেশিরভাগ ট্যাগ এবং ম্যাক্রো ধরনের অতিরিক্ত প্যারামিটার রয়েছে যা ট্যাগ বা ম্যাক্রোর জন্য নির্দিষ্ট এবং সংস্থান তৈরি/আপডেট করার সময় সেট করা যেতে পারে। প্রতিটি ট্যাগ এবং ম্যাক্রো টাইপের প্যারামিটারের তালিকা ( 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
boolean value value true বা false হয়।
number value value একটি পূর্ণসংখ্যা।
list list list শূন্য বা তার বেশি পরামিতি থাকবে, অর্ডার কিছু নাও হতে পারে; list যেকোনো প্যারামিটারের key উপেক্ষা করা হবে।
map map map শূন্য বা তার বেশি প্যারামিটার থাকবে, অর্ডার কোন ব্যাপার না; map যেকোনো প্যারামিটারের key অনন্য হওয়া উচিত।

key

ট্যাগ বা ম্যাক্রোর প্যারামিটার কী কনফিগার করা হচ্ছে।

key ক্ষেত্রটি নির্দিষ্ট ট্যাগ বা ম্যাক্রোগুলির প্যারামিটার সনাক্ত করতে ব্যবহৃত হয় যা সেট করা হচ্ছে। সমস্ত পরামিতি ধরনের একটি key বৈশিষ্ট্য প্রয়োজন ( list পরামিতি ব্যতীত)।

উদাহরণ

একটি কাস্টম HTML ট্যাগের জন্য একটি প্যারামিটার অবজেক্ট, যার একটি 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"
  }
]