REST Resource: accounts.containers.workspaces.tags

Recurso: tag

Representa um Tag do Gerenciador de tags do Google.

Representação JSON 
{
  "path": string,
  "accountId": string,
  "containerId": string,
  "workspaceId": string,
  "tagId": string,
  "name": string,
  "type": string,
  "liveOnly": boolean,
  "priority": {
    object (Parameter)
  },
  "notes": string,
  "scheduleStartMs": string,
  "scheduleEndMs": string,
  "parameter": [
    {
      object (Parameter)
    }
  ],
  "fingerprint": string,
  "firingTriggerId": [
    string
  ],
  "blockingTriggerId": [
    string
  ],
  "setupTag": [
    {
      object (SetupTag)
    }
  ],
  "teardownTag": [
    {
      object (TeardownTag)
    }
  ],
  "parentFolderId": string,
  "tagFiringOption": enum (TagFiringOption),
  "tagManagerUrl": string,
  "paused": boolean,
  "monitoringMetadata": {
    object (Parameter)
  },
  "monitoringMetadataTagNameKey": string,
  "consentSettings": {
    object (ConsentSetting)
  }
}
Campos
path

string

Caminho relacionado à API do Tag do GTM.
accountId

string

Código do Account do GTM.
containerId

string

Código do Container do GTM.
workspaceId

string

Código do Workspace do GTM.
tagId

string

Código do Tag que identifica de forma única o Tag do GTM.
name

string

Nome de exibição da tag.
type

string

Tipo de Tag do GTM.
liveOnly

boolean

Se definida como "true", essa tag só será disparada no ambiente ativo (não no modo de visualização ou depuração).
priority

object (Parameter)

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.
notes

string

Observações para os usuários sobre como aplicar essa tag no contêiner.
scheduleStartMs

string (int64 format)

Data e hora de início em milissegundos para agendar uma tag.
scheduleEndMs

string (int64 format)

Data e hora de término em milissegundos para agendar uma tag.
parameter[]

object (Parameter)

Parâmetros da tag.
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.
firingTriggerId[]

string

IDs de acionador de disparo. Uma tag é disparada quando um dos acionadores listados têm o valor "true" e todos os

blockingTriggerIds

(se houver algum especificado) são falsos.
blockingTriggerId[]

string

Códigos dos acionadores de bloqueio. Se um dos acionadores listados forem avaliadas como "true", a tag não será disparada.
setupTag[]

object (SetupTag)

Lista de tags de configuração. No momento, permitimos apenas uma.
teardownTag[]

object (TeardownTag)

Lista de tags de desconstrução. No momento, permitimos apenas uma.
parentFolderId

string

Código da pasta pai.
tagFiringOption

enum (TagFiringOption)

Opção para disparar essa tag.
tagManagerUrl

string

Link gerado automaticamente para a IU do Gerenciador de tags.
paused

boolean

Indica se a tag está pausada, o que a impede de ser disparada.
monitoringMetadata

object (Parameter)

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.
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.
consentSettings

object (ConsentSetting)

Configurações de consentimento de uma tag.

SetupTag

Representa uma referência a uma tag que é disparada antes de outra para configurar dependências.

Representação JSON 
{
  "tagName": string,
  "stopOnSetupFailure": boolean
}
Campos
tagName

string

O nome da tag de configuração.
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.

TeardownTag

Representa uma tag que é disparada após outra para remover dependências.

Representação JSON 
{
  "tagName": string,
  "stopTeardownOnFailure": boolean
}
Campos
tagName

string

Nome da tag de desconstrução.
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.

TagFiringOption

Enums
tagFiringOptionUnspecified
unlimited A tag pode ser disparada várias vezes por evento.
oncePerEvent A tag só pode ser acionada por evento, mas pode ser acionada várias vezes por carregamento (por exemplo, carregamento de app ou de página).
oncePerLoad A tag só pode ser disparada por carregamento (por exemplo, carregamento de app ou de página).

ConsentSetting

Representação JSON 
{
  "consentStatus": enum (ManualConsentOption),
  "consentType": {
    object (Parameter)
  }
}
Campos
consentStatus

enum (ManualConsentOption)

O status de consentimento da tag. Se definido como "NECESSÁRIO", o ambiente de execução vai verificar se os tipos de consentimento especificados pelo

consentType

campo foi concedido.
consentType

object (Parameter)

O tipo de consentimento a ser verificado durante o disparo de tags, se estiver no estado "NECESSÁRIO". Esse parâmetro precisa ser do tipo

LIST

em que cada item da lista é do tipo

STRING

.

ManualConsentOption

Enums
notSet Valor padrão em que o usuário não especificou nenhuma configuração.
notNeeded A tag não exige outras configurações de consentimento.
needed A tag exige configurações de consentimento adicionais.

Métodos

create

 Cria um Tag do GTM.

delete

 Exclui um Tag do GTM.

get

 Recebe um Tag do GTM.

list

 Lista todos os Tags do GTM de um Container.

revert

 Reverte as alterações em um Tag do GTM em um Workspace do GTM.

update

 Atualiza um Tag do GTM.