Variables

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

Representações de recursos

Representa um Variable do Gerenciador de tags do Google.

{
  "path": string,
  "accountId": string,
  "containerId": string,
  "workspaceId": string,
  "variableId": string,
  "name": string,
  "type": string,
  "notes": string,
  "scheduleStartMs": long,
  "scheduleEndMs": long,
  "parameter": [
    {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ]
    }
  ],
  "enablingTriggerId": [
    string
  ],
  "disablingTriggerId": [
    string
  ],
  "fingerprint": string,
  "parentFolderId": string,
  "tagManagerUrl": string,
  "formatValue": {
    "caseConversionType": string,
    "convertNullToValue": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ]
    },
    "convertUndefinedToValue": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ]
    },
    "convertTrueToValue": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ]
    },
    "convertFalseToValue": {
      "type": string,
      "key": string,
      "value": string,
      "list": [
        (Parameter)
      ],
      "map": [
        (Parameter)
      ]
    }
  }
}
Nome da propriedade Valor Descrição Observações
accountId string Código do Account do GTM.
containerId string Código do Container do GTM.
disablingTriggerId[] list Apenas para contêineres de dispositivos móveis: uma lista de códigos de acionadores para variáveis condicionais de desativação. A variável será ativada se um dos acionadores de ativação tiver o valor "true" e todos os acionadores de desativação apresentarem o valor "false". Tratado como um conjunto não ordenado. gravável
enablingTriggerId[] list Apenas para contêineres para dispositivos móveis: uma lista de códigos de acionadores para variáveis condicionais de ativação. A variável será ativada se um dos acionadores de ativação tiver o valor "true" e todos os acionadores de desativação apresentarem o valor "false". Tratado como um conjunto não ordenado. gravável
fingerprint string Impressão digital do Variable do GTM, conforme processada no armazenamento. Esse valor é reprocessado sempre que a variável do contêiner é modificada.
formatValue nested object Opção para converter um valor de variável em outro valor.
formatValue.caseConversionType string Opção para converter um valor de variável do tipo string em letras minúsculas ou maiúsculas.

Os valores aceitáveis são:
  • "lowercase"
  • "none"
  • "uppercase"
formatValue.convertFalseToValue nested object Valor a ser convertido se um valor de variável for falso.
formatValue.convertFalseToValue.key string Chave nomeada que identifica um parâmetro de forma exclusiva. Obrigatório para parâmetros de nível superior, bem como para valores de mapa. Ignorado para valores de lista. gravável
formatValue.convertFalseToValue.list[] list Parâmetros dessa lista (as chaves são ignoradas). gravável
formatValue.convertFalseToValue.map[] list Parâmetros desse mapa (é necessário ter chaves únicas). gravável
formatValue.convertFalseToValue.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 com o código do acionador em questão


Os valores aceitos são:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
gravável
formatValue.convertFalseToValue.value string Valor de um parâmetro (pode conter referências de variáveis, como "{{myVariable}}"), conforme apropriado para o tipo especificado. gravável
formatValue.convertNullToValue nested object Valor a ser convertido se um valor de variável for nulo.
formatValue.convertNullToValue.key string Chave nomeada que identifica um parâmetro de forma exclusiva. Obrigatório para parâmetros de nível superior, bem como para valores de mapa. Ignorado para valores de lista. gravável
formatValue.convertNullToValue.list[] list Parâmetros dessa lista (as chaves são ignoradas). gravável
formatValue.convertNullToValue.map[] list Parâmetros desse mapa (é necessário ter chaves únicas). gravável
formatValue.convertNullToValue.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 com o código do acionador em questão


Os valores aceitos são:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
gravável
formatValue.convertNullToValue.value string Valor de um parâmetro (pode conter referências de variáveis, como "{{myVariable}}"), conforme apropriado para o tipo especificado. gravável
formatValue.convertTrueToValue nested object Valor a ser convertido se um valor de variável for "true".
formatValue.convertTrueToValue.key string Chave nomeada que identifica um parâmetro de forma exclusiva. Obrigatório para parâmetros de nível superior, bem como para valores de mapa. Ignorado para valores de lista. gravável
formatValue.convertTrueToValue.list[] list Parâmetros dessa lista (as chaves são ignoradas). gravável
formatValue.convertTrueToValue.map[] list Parâmetros desse mapa (é necessário ter chaves únicas). gravável
formatValue.convertTrueToValue.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 com o código do acionador em questão


Os valores aceitos são:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
gravável
formatValue.convertTrueToValue.value string Valor de um parâmetro (pode conter referências de variáveis, como "{{myVariable}}"), conforme apropriado para o tipo especificado. gravável
formatValue.convertUndefinedToValue nested object Valor a ser convertido se um valor de variável for indefinido.
formatValue.convertUndefinedToValue.key string Chave nomeada que identifica um parâmetro de forma exclusiva. Obrigatório para parâmetros de nível superior, bem como para valores de mapa. Ignorado para valores de lista. gravável
formatValue.convertUndefinedToValue.list[] list Parâmetros dessa lista (as chaves são ignoradas). gravável
formatValue.convertUndefinedToValue.map[] list Parâmetros desse mapa (é necessário ter chaves únicas). gravável
formatValue.convertUndefinedToValue.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 com o código do acionador em questão


Os valores aceitos são:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
gravável
formatValue.convertUndefinedToValue.value string Valor de um parâmetro (pode conter referências de variáveis, como "{{myVariable}}"), conforme apropriado para o tipo especificado. gravável
name string Nome de exibição da variável. gravável
notes string Observações para os usuários sobre como aplicar essa variável no contêiner. gravável
parameter[] list Parâmetros da variável. 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 com o código do acionador em questão


Os valores aceitos são:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
  • "triggerReference"
  • "typeUnspecified"
gravável
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
parentFolderId string Código da pasta pai.
path string Caminho relacionado à API do Variable do GTM.
scheduleEndMs long Data e hora de término em milissegundos para agendar uma variável. gravável
scheduleStartMs long Data e hora de início em milissegundos para agendar uma variável. gravável
tagManagerUrl string Link gerado automaticamente para a IU do Gerenciador de tags.
type string Tipo de Variable do GTM. gravável
variableId string Código que identifica o Variable do GTM de forma exclusiva.
workspaceId string Código do Workspace do GTM.

Métodos

create
Cria um Variable do GTM.
delete
Exclui um Variable do GTM.
get
Recebe um Variable do GTM.
list
Lista todos os Variables do GTM de um Container.
revert
Reverte as alterações em um Variable do GTM em Workspace do GTM.
update
Atualiza um Variable do GTM.