Agradecemos seu interesse na nova documentação da plataforma de tags do Google. Este site está na versão Beta pública. (Feedback)

Zones

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Para ver uma lista de métodos desse recurso, consulte o final desta página.

Representações de recursos

Representa o conteúdo de um Zone do Gerenciador de tags do Google.

{
  "path": string,
  "accountId": string,
  "containerId": string,
  "workspaceId": string,
  "zoneId": string,
  "name": string,
  "fingerprint": string,
  "tagManagerUrl": string,
  "notes": string,
  "childContainer": [
    {
      "publicId": string,
      "nickname": string
    }
  ],
  "boundary": {
    "condition": [
      {
        "type": string,
        "parameter": [
          {
            "type": string,
            "key": string,
            "value": string,
            "list": [
              (Parameter)
            ],
            "map": [
              (Parameter)
            ]
          }
        ]
      }
    ],
    "customEvaluationTriggerId": [
      string
    ]
  },
  "typeRestriction": {
    "enable": boolean,
    "whitelistedTypeId": [
      string
    ]
  }
}
Nome da propriedade Valor Descrição Observações
accountId string ID do Account do GTM.
boundary nested object Limite deste Zone.
boundary.condition[] list Condições que, juntas, formam o limite.
boundary.condition[].parameter[] list Lista de parâmetros nomeados (chave/valor), dependendo do tipo de condição. Observações:
  • No caso dos operadores binários, inclua os parâmetros arg0 e arg1 para especificar os operandos esquerdo e direito, respectivamente.
  • No momento, o operando esquerdo (arg0) precisa ser uma referência a uma variável.
  • Para correspondência de regex que não diferencia maiúsculas de minúsculas, inclua um parâmetro booleano ignore_case definido como true. Se não for especificada nem definida como outro valor, a correspondência diferenciará maiúsculas de minúsculas.
  • Para negar um operador, inclua um parâmetro booleano negate definido como true.
gravável
boundary.condition[].parameter[].key string Chave nomeada que identifica um parâmetro de forma única. Obrigatório para parâmetros de nível superior, bem como para valores de mapa. Ignorado para valores de lista. gravável
boundary.condition[].parameter[].list[] list Parâmetros dessa lista (as chaves são ignoradas). gravável
boundary.condition[].parameter[].map[] list Parâmetros desse mapa (é necessário ter chaves únicas). gravável
boundary.condition[].parameter[].type string Tipo de parâmetro. Os valores válidos são:
  • boolean: o valor representa um booleano, exibido como "true" ou "false"
  • integer: o valor representa um número inteiro assinado com 64 bits e de formato decimal
  • list: uma lista de parâmetros precisa ser especificada
  • map: um mapa de parâmetros precisa ser especificado
  • template: o valor representa qualquer texto e inclui referências de variáveis, mesmo aquelas que podem retornar tipos que não são strings
  • trigger_reference: o valor representa um acionador, que é informado como o ID do acionador
  • tag_reference: o valor indica uma tag, representada como o nome da tag


Os valores aceitáveis são os seguintes:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
gravável
boundary.condition[].parameter[].value string Valor de um parâmetro (pode conter referências de variáveis, como ""), conforme apropriado para o tipo especificado. gravável
boundary.condition[].type string Tipo de operador para essa condição.

Os valores aceitáveis são:
  • "conditionTypeUnspecified"
  • "contains"
  • "cssSelector"
  • "endsWith"
  • "equals"
  • "greater"
  • "greaterOrEquals"
  • "less"
  • "lessOrEquals"
  • "matchRegex"
  • "startsWith"
  • "urlMatches"
gravável
boundary.customEvaluationTriggerId[] list Códigos de acionadores de avaliação personalizados. Uma zona avalia as condições do limite dela quando um dos acionadores listados tem o valor "true".
childContainer[] list Contêineres que são filhos desta zona.
childContainer[].nickname string Apelido da zona para o contêiner filho.
childContainer[].publicId string Código público do contêiner filho.
containerId string Código do Container do GTM.
fingerprint string Impressão digital do Zone do GTM, conforme processada no momento do armazenamento. Esse valor é reprocessado sempre que a zona é modificada.
name string Nome de exibição da zona.
notes string Observações para o usuário sobre como aplicar essa zona no contêiner.
path string Caminho relacionado à API do Zone do GTM.
tagManagerUrl string Link gerado automaticamente para a IU do Gerenciador de tags.
typeRestriction nested object Restrições de tipo deste Zone.
typeRestriction.enable boolean Valor "true" se as restrições de tipo foram ativadas para esta zona.
typeRestriction.whitelistedTypeId[] list Lista de códigos públicos de tipos que foram adicionados à lista de permissões para uso neste Zone.
workspaceId string Código do Workspace do GTM.
zoneId string Código do Zone que identifica de forma única o Zone do GTM.

Métodos

create
Cria uma zona do GTM.
delete
Exclui uma zona do GTM.
get
Recebe uma zona do GTM.
list
Lista todas as zonas do GTM de um espaço de trabalho do contêiner do GTM.
revert
Reverte as alterações de uma zona do GTM em um espaço de trabalho do GTM.
update
Atualiza uma zona do GTM.