Versões de contêineres

Container Versions de um contêiner. Uma versão de contêiner pode ser considerada uma cópia imutável (instantâneo) da configuração de um contêiner em um determinado ponto no tempo. Gerar uma nova versão usando o método create criará uma versão baseada na configuração atual, ou seja, nas macros, nas regras e nas tags do contêiner. O método restore restaurará a configuração do contêiner utilizando a versão especificada, e o método update permite atualizar os campos name e notes de uma versão. Para buscar a versão publicada no momento, use o método get e especifique published para containerVersionId.

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

Representações de recursos

Representa um Container Version do Gerenciador de tags do Google.

{
  "accountId": string,
  "containerId": string,
  "containerVersionId": string,
  "name": string,
  "deleted": boolean,
  "notes": string,
  "container": accounts.containers Resource,
  "macro": [
    {
      "accountId": string,
      "containerId": string,
      "macroId": string,
      "name": string,
      "type": string,
      "notes": string,
      "scheduleStartMs": long,
      "scheduleEndMs": long,
      "parameter": [
        {
          "type": string,
          "key": string,
          "value": string,
          "list": [
            (Parameter)
          ],
          "map": [
            (Parameter)
          ]
        }
      ],
      "enablingRuleId": [
        string
      ],
      "disablingRuleId": [
        string
      ],
      "fingerprint": string,
      "parentFolderId": string
    }
  ],
  "rule": [
    {
      "accountId": string,
      "containerId": string,
      "ruleId": string,
      "name": string,
      "notes": string,
      "condition": [
        {
          "type": string,
          "parameter": [
            {
              "type": string,
              "key": string,
              "value": string,
              "list": [
                (Parameter)
              ],
              "map": [
                (Parameter)
              ]
            }
          ]
        }
      ],
      "fingerprint": string
    }
  ],
  "tag": [
    accounts.containers.tags Resource
  ],
  "trigger": [
    accounts.containers.triggers Resource
  ],
  "variable": [
    accounts.containers.variables Resource
  ],
  "folder": [
    accounts.containers.folders Resource
  ],
  "fingerprint": string
}
Nome da propriedade Valor Descrição Observações
accountId string Código do Account do GTM.
container nested object Contêiner de origem dessa versão.
containerId string Código do Container do GTM.
containerVersionId string containerVersionId identifica o Container Version do GTM de forma única.
deleted boolean Valor "true" que indica que essa versão do contêiner foi excluída.
fingerprint string Impressão digital do Container Version do GTM, conforme processada no momento do armazenamento. Esse valor é reprocessado sempre que a versão do contêiner é modificada.
folder[] list Pastas no contêiner de origem dessa versão.
macro[] list Macros no contêiner de origem dessa versão.
macro[].accountId string Código do Account do GTM.
macro[].containerId string Código do Container do GTM.
macro[].disablingRuleId[] list Apenas para contêineres de dispositivos móveis: uma lista de códigos de regras para macros condicionais de desativação. A macro será ativada se uma das regras de ativação tiver o valor "true" e todas as regras de desativação apresentarem o valor "false". Tratado como um conjunto não ordenado.
macro[].enablingRuleId[] list Apenas para contêineres para dispositivos móveis: uma lista de códigos de regras para macros condicionais de ativação. A macro será ativada se uma das regras de ativação tiver o valor "true" e todas as regras de desativação tiverem o valor "false". Tratado como um conjunto não ordenado.
macro[].fingerprint string Impressão digital do Macro do GTM, conforme processado no momento do armazenamento. Esse valor é reprocessado sempre que a macro é modificada.
macro[].macroId string Código do Macro que identifica o Macro do GTM de forma única.
macro[].name string Nome de exibição da macro.
macro[].notes string Observações para o usuário sobre como aplicar essa macro no contêiner.
macro[].parameter[] list Parâmetros da macro.
macro[].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
macro[].parameter[].list[] list Parâmetros dessa lista (as chaves são ignoradas). gravável
macro[].parameter[].map[] list Parâmetros desse mapa (é necessário ter chaves únicas). gravável
macro[].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


Os valores aceitos são:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
gravável
macro[].parameter[].value string Valor de um parâmetro (pode conter referências de variáveis, como "{{myVariable}}"), conforme apropriado para o tipo especificado. gravável
macro[].parentFolderId string Código da pasta pai.
macro[].scheduleEndMs long Data e hora de término em milissegundos para agendar uma macro.
macro[].scheduleStartMs long Data e hora de início em milissegundos para agendar uma macro.
macro[].type string Tipo de Macro do GTM.
name string Nome de exibição da versão do contêiner. gravável
notes string Observações para os usuários sobre como aplicar essa versão de contêiner no contêiner. gravável
rule[] list Regras no contêiner de origem dessa versão.
rule[].accountId string Código do Account do GTM.
rule[].condition[] list Lista de condições que compõem essa regra (operador "AND" implícito entre elas).
rule[].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 indiferente a maiúsculas, inclua um parâmetro booleano ignore_case definido como true. Se a correspondência não for especificada nem definida como outro valor, ela diferenciará maiúsculas de minúsculas.
  • Para negar um operador, inclua um parâmetro booleano negate definido como true.
gravável
rule[].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
rule[].condition[].parameter[].list[] list Parâmetros dessa lista (as chaves são ignoradas). gravável
rule[].condition[].parameter[].map[] list Parâmetros desse mapa (é necessário ter chaves únicas). gravável
rule[].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


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

Os valores aceitos são:
  • "contains"
  • "cssSelector"
  • "endsWith"
  • "equals"
  • "greater"
  • "greaterOrEquals"
  • "less"
  • "lessOrEquals"
  • "matchRegex"
  • "startsWith"
  • "urlMatches"
gravável
rule[].containerId string Código do Container do GTM.
rule[].fingerprint string Impressão digital do Rule do GTM, conforme processada no armazenamento. Esse valor é reprocessado sempre que a regra é modificada.
rule[].name string Nome de exibição da regra.
rule[].notes string Observações para o usuário sobre como aplicar essa regra no contêiner.
rule[].ruleId string Código do Rule que identifica a regra do GTM de forma única.
tag[] list Tags no contêiner de origem dessa versão.
trigger[] list Acionadores no contêiner de origem dessa versão.
variable[] list Variáveis no contêiner de origem dessa versão.

Métodos

create
Cria uma versão de contêiner.
delete
Exclui uma versão de contêiner.
get
Recebe uma versão de contêiner.
list
Lista todas as versões de contêineres de um contêiner do GTM.
publish
Publica uma versão de contêiner.
restore
Restaura uma versão de contêiner. Substitui a configuração atual do contêiner (incluindo variáveis, acionadores e tags). A operação não tem efeito na versão veiculada (ou seja, a versão publicada).
undelete
Cancela a exclusão de uma versão de contêiner.
update
Atualiza uma versão de contêiner.