Tags

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

Representações de recursos

Representa um Tag do Gerenciador de tags do Google.

{
  "path": string,
  "accountId": string,
  "containerId": string,
  "workspaceId": string,
  "tagId": string,
  "name": string,
  "type": string,
  "firingRuleId": [
    string
  ],
  "blockingRuleId": [
    string
  ],
  "liveOnly": boolean,
  "priority": {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ],
    "isWeakReference": boolean
  },
  "notes": string,
  "scheduleStartMs": long,
  "scheduleEndMs": long,
  "parameter": [
    {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    }
  ],
  "fingerprint": string,
  "firingTriggerId": [
    string
  ],
  "blockingTriggerId": [
    string
  ],
  "setupTag": [
    {
      "tagName": string,
      "stopOnSetupFailure": boolean
    }
  ],
  "teardownTag": [
    {
      "tagName": string,
      "stopTeardownOnFailure": boolean
    }
  ],
  "parentFolderId": string,
  "tagFiringOption": string,
  "tagManagerUrl": string,
  "paused": boolean,
  "monitoringMetadata": {
    "type": string,
    "key": string,
    "value": string,
    "list": [
      (Parameter)
    ],
    "map": [
      (Parameter)
    ],
    "isWeakReference": boolean
  },
  "monitoringMetadataTagNameKey": string,
  "consentSettings": {
    "consentStatus": string,
    "consentType": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ],
      "isWeakReference": boolean
    }
  }
}
Nome da propriedade Valor Descrição Observações
accountId string Código do Account do GTM.
blockingRuleId[] list Códigos de regras de bloqueio. Se uma das regras listadas forem avaliadas como "true", a tag não será disparada. gravável
blockingTriggerId[] list Códigos dos acionadores de bloqueio. Se um dos acionadores listados forem avaliadas como "true", a tag não será disparada. gravável
consentSettings nested object Configurações de consentimento de uma tag. gravável
consentSettings.consentStatus string O status de consentimento da tag. Se definido como NEEDED, o ambiente de execução verificará se os tipos de consentimento especificados pelo campo consent_type foram concedidos.

Estes são os valores aceitáveis:
  • "needed"
  • "notNeeded"
  • "notSet"
consentSettings.consentType nested object O tipo de consentimento a ser verificado durante o disparo de tags se o estado de consentimento for NECESSÁRIO. Esse parâmetro precisa ser do tipo LIST, em que cada item da lista é do tipo STRING.
consentSettings.consentType.isWeakReference boolean Indica se um parâmetro de tipo de referência é ou não referenciado de forma forte ou fraca. Usado apenas por Transformações. gravável
consentSettings.consentType.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
consentSettings.consentType.list[] list Parâmetros dessa lista (as chaves são ignoradas). gravável
consentSettings.consentType.map[] list Parâmetros desse mapa (é necessário ter chaves únicas). gravável
consentSettings.consentType.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


Estes são os valores aceitáveis:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
gravável
consentSettings.consentType.value string Valor de um parâmetro (pode conter referências de variáveis, como ""), conforme apropriado para o tipo especificado. gravável
containerId string Código do Container do GTM.
fingerprint string Impressão digital do Tag do GTM, conforme processada no momento do armazenamento. Esse valor é reprocessado sempre que a tag do contêiner é modificada.
firingRuleId[] list IDs de regra de disparo. Uma tag é disparada quando uma das regras listadas têm o valor "true" e todos os blockingRuleIds (se especificados) têm o valor "false". gravável
firingTriggerId[] list IDs de acionador de disparo. Uma tag é disparada quando um dos acionadores listados têm o valor "true" e todos os blockingTriggerIds (se especificados) têm o valor "false". gravável
liveOnly boolean Se definida como "true", essa tag só será disparada no ambiente ativo (não no modo de visualização ou depuração). gravável
monitoringMetadata nested object Um mapa de pares de chave-valor de metadados da tag a serem incluídos nos dados do evento para monitoramento de tags. Observações:
  • Esse parâmetro precisa ser do tipo MAP.
  • Cada parâmetro no mapa é do tipo TEMPLATE, mas não pode conter referências de variáveis.
gravável
monitoringMetadata.isWeakReference boolean Indica se um parâmetro de tipo de referência é ou não referenciado de forma forte ou fraca. Usado apenas por Transformações. gravável
monitoringMetadata.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
monitoringMetadata.list[] list Parâmetros dessa lista (as chaves são ignoradas). gravável
monitoringMetadata.map[] list Parâmetros desse mapa (é necessário ter chaves únicas). gravável
monitoringMetadata.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


Estes são os valores aceitáveis:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
gravável
monitoringMetadata.value string Valor de um parâmetro (pode conter referências de variáveis, como ""), conforme apropriado para o tipo especificado. gravável
monitoringMetadataTagNameKey string Se não estiver vazio, o nome de exibição da tag será incluído no mapa de metadados de monitoramento usando a chave especificada. gravável
name string Nome de exibição da tag. gravável
notes string Observações para os usuários sobre como aplicar essa tag no contêiner. gravável
parameter[] list Parâmetros da tag. gravável
parameter[].isWeakReference boolean Indica se um parâmetro de tipo de referência é ou não referenciado de forma forte ou fraca. Usado apenas por Transformações. gravável
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
parameter[].list[] list Parâmetros dessa lista (as chaves são ignoradas). gravável
parameter[].map[] list Parâmetros desse mapa (é necessário ter chaves únicas). gravável
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


Estes são os valores aceitáveis:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
gravável
parameter[].value string Valor de um parâmetro (pode conter referências de variáveis, como ""), conforme apropriado para o tipo especificado. gravável
parentFolderId string Código da pasta pai.
path string Caminho relacionado à API do Tag do GTM.
paused boolean Indica se a tag está pausada, o que a impede de ser disparada. gravável
priority nested object Prioridade numérica da tag definida pelo usuário. As tags são disparadas de forma assíncrona na ordem de prioridade. Tags com valor numérico maior são disparadas primeiro. A prioridade de uma tag pode ser um valor positivo ou negativo. O valor padrão é 0. gravável
priority.isWeakReference boolean Indica se um parâmetro de tipo de referência é ou não referenciado de forma forte ou fraca. Usado apenas por Transformações. gravável
priority.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
priority.list[] list Parâmetros dessa lista (as chaves são ignoradas). gravável
priority.map[] list Parâmetros desse mapa (é necessário ter chaves únicas). gravável
priority.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


Estes são os valores aceitáveis:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "tagReference"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
gravável
priority.value string Valor de um parâmetro (pode conter referências de variáveis, como ""), conforme apropriado para o tipo especificado. gravável
scheduleEndMs long Data e hora de término em milissegundos para agendar uma tag. gravável
scheduleStartMs long Data e hora de início em milissegundos para agendar uma tag. gravável
setupTag[] list Lista de tags de configuração. No momento, permitimos apenas uma.
setupTag[].stopOnSetupFailure boolean Quando o valor é "true", a tag principal é disparada apenas se a tag de configuração for disparada com sucesso. Quando o valor é "false", a tag principal é disparada seja qual for o status de disparo da tag de configuração.
setupTag[].tagName string O nome da tag de configuração.
tagFiringOption string Opção para disparar essa tag.

Os valores aceitáveis são:
  • "oncePerEvent"
  • "oncePerLoad"
  • "tagFiringOptionUnspecified"
  • "unlimited"
tagId string O Tag ID identifica de forma única o Tag do GTM.
tagManagerUrl string Link gerado automaticamente para a IU do Gerenciador de tags.
teardownTag[] list Lista de tags de desconstrução. No momento, permitimos apenas uma.
teardownTag[].stopTeardownOnFailure boolean Se o valor for "true", a tag de desconstrução é disparada apenas se a tag principal for disparada com sucesso. Quando o valor é "false", a tag de desconstrução é disparada seja qual for o status de disparo da tag principal.
teardownTag[].tagName string Nome da tag de desconstrução.
type string Tipo de Tag do GTM. gravável
workspaceId string Código do Workspace do GTM.

Métodos

create
Cria um Tag do GTM.
delete
Exclui um Tag do GTM.
get
Recebe um Tag do GTM.
list
Mostra todos os Tags do GTM de um Container.
revert
Reverte as mudanças de um Tag do GTM em um Workspace do GTM.
update
Atualiza um Tag do GTM.