태그 관리자 API - 매개변수 참조

이 문서에서는 태그 관리자 매개변수 객체의 목적과 표현을 설명합니다.

소개

태그 관리자 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{{bar}}).
boolean	value	value는 true 또는 false입니다.
number	value	value는 정수입니다.
list	list	list에 0개 이상의 매개변수가 포함되며 순서는 중요하지 않을 수 있습니다. list에 있는 매개변수의 key는 무시됩니다.
map	map	map에는 0개 이상의 매개변수가 포함되며 순서는 중요하지 않습니다. map의 모든 매개변수에 있는 key는 고유해야 합니다.

key

구성 중인 태그 또는 변수의 매개변수 키입니다.

key 필드는 설정 중인 특정 태그 또는 변수의 매개변수를 식별하는 데 사용됩니다. 모든 매개변수 유형에는 key 속성이 필요합니다 (list 매개변수 제외).

예

template 유형 매개변수 1개와 boolean 유형 매개변수 2개를 포함하는 맞춤 HTML 태그의 매개변수 객체:

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

template 함수 매개변수 하나와 map 유형 매개변수 하나를 포함하는 함수 호출 태그의 매개변수 객체:

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