REST Resource: accounts.containers.environments

Recurso: ambiente

Representa um Environment do Gerenciador de tags do Google. Um usuário pode criar, excluir e atualizar ambientes do tipo USER, mas apenas atualizar os campos enableDebug e url de ambientes de outros tipos.

Representação JSON
{
  "path": string,
  "accountId": string,
  "containerId": string,
  "environmentId": string,
  "type": enum (EnvironmentType),
  "fingerprint": string,
  "name": string,
  "description": string,
  "enableDebug": boolean,
  "url": string,
  "authorizationCode": string,
  "authorizationTimestamp": string,
  "tagManagerUrl": string,

  // Union field Link can be only one of the following:
  "containerVersionId": string,
  "workspaceId": string
  // End of list of possible types for union field Link.
}
Campos
path

string

Caminho relacionado à API do Environment do GTM.

accountId

string

Código do Account do GTM.

containerId

string

Código do Container do GTM.

environmentId

string

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

type

enum (EnvironmentType)

Tipo de ambiente.

fingerprint

string

Impressão digital do Environment do GTM, conforme processada no momento do armazenamento. Esse valor é reprocessado sempre que o ambiente é modificado.

name

string

Nome de exibição do ambiente. Pode ser definida ou alterada apenas em ambientes do tipo USER.

description

string

Descrição do ambiente. Pode ser definida ou alterada apenas em ambientes do tipo USER.

enableDebug

boolean

Define se a depuração ficará ativada ou desativada por padrão para o ambiente.

url

string

URL da página de visualização padrão do ambiente.

authorizationCode

string

Código de autorização do ambiente.

authorizationTimestamp

string (Timestamp format)

Data e hora da última atualização do código de autorização.

Usa o RFC 3339, em que a saída gerada é sempre normalizada em Z e usa dígitos fracionários 0, 3, 6 ou 9. Deslocamentos diferentes de "Z" também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

tagManagerUrl

string

Link gerado automaticamente para a IU do Gerenciador de tags.

containerVersionId

string

Representa um link para uma versão de contêiner.

workspaceId

string

Representa um link para uma visualização rápida de um espaço de trabalho.

EnvironmentType

Enums
user Indica um ambiente definido pelo usuário.
live Indica a versão atual do contêiner.
latest Indica a versão mais recente do contêiner.
workspace Ambiente gerenciado automaticamente que aponta para uma prévia ou versão criada por um espaço de trabalho.

Métodos

create

Cria um Environment do GTM.

delete

Exclui um Environment do GTM.

get

Recebe um Environment do GTM.

list

Lista todos os ambientes do GTM de um contêiner do GTM.

reauthorize

Gera novamente o código de autorização de um Environment do GTM.

update

Atualiza um Environment do GTM.