Serviço TagManager

O serviço Gerenciador de tags do Google oferece acesso aos dados da API Tag Manager para um usuário autorizado Esse serviço permite que os usuários do Gerenciador de tags gerenciem: contas, contêineres, ambientes, versões, espaços de trabalho, pastas, variáveis, acionadores, tags e permissões de usuário.

Referência

Para informações detalhadas sobre esse serviço, consulte a documentação de referência para API Tag Manager V2.

Assim como todos os serviços avançados no Apps Script, o serviço do Gerenciador de tags usa os mesmos objetos, métodos e parâmetros que a API pública. Para mais informações, consulte Como as assinaturas de método são determinadas.

Para denunciar problemas e encontrar outras opções de suporte, consulte a Central de Ajuda do Gerenciador de tags do Google.

Código de amostra

O código de amostra abaixo demonstra como usar alguns recursos do serviço do Gerenciador de tags.

Cria uma versão de contêiner com uma variável, acionador e tag.

O código de amostra abaixo usa a API Tag Manager V2 para criar um contêiner com um nome que contém a data atual para melhorar as chances de ser exclusivo. Depois, a amostra cria um espaço de trabalho com uma variável de valor aleatória e um acionador que dispara em caso de visualização de página. Em seguida, a amostra usa o acionador para criar uma tag de pixel arbitrário que dispara um pixel para //example.com com um inibidor de cache anexo ao final do URL. Por fim, a amostra cria uma versão de contêiner com as entidades acima, registra a versão e devolve para uso posterior.

advanced/tagManager.gs
/**
 * Creates a container version for a particular account
 * with the input accountPath.
 * @param {string} accountPath The account path.
 * @return {string} The tag manager container version.
 */
function createContainerVersion(accountPath) {
  const date = new Date();
  // Creates a container in the account, using the current timestamp to make
  // sure the container is unique.
  try {
    const container = TagManager.Accounts.Containers.create(
        {
          'name': 'appscript tagmanager container ' + date.getTime(),
          'usageContext': ['WEB']
        },
        accountPath);
    const containerPath = container.path;
    // Creates a workspace in the container to track entity changes.
    const workspace = TagManager.Accounts.Containers.Workspaces.create(
        {'name': 'appscript workspace', 'description': 'appscript workspace'},
        containerPath);
    const workspacePath = workspace.path;
    // Creates a random value variable.
    const variable = TagManager.Accounts.Containers.Workspaces.Variables.create(
        {'name': 'apps script variable', 'type': 'r'},
        workspacePath);
    // Creates a trigger that fires on any page view.
    const trigger = TagManager.Accounts.Containers.Workspaces.Triggers.create(
        {'name': 'apps script trigger', 'type': 'PAGEVIEW'},
        workspacePath);
    // Creates a arbitary pixel that fires the tag on all page views.
    const tag = TagManager.Accounts.Containers.Workspaces.Tags.create(
        {
          'name': 'apps script tag',
          'type': 'img',
          'liveOnly': false,
          'parameter': [
            {'type': 'boolean', 'key': 'useCacheBuster', 'value': 'true'}, {
              'type': 'template',
              'key': 'cacheBusterQueryParam',
              'value': 'gtmcb'
            },
            {'type': 'template', 'key': 'url', 'value': '//example.com'}
          ],
          'firingTriggerId': [trigger.triggerId]
        },
        workspacePath);
    // Creates a container version with the variabe, trigger, and tag.
    const version = TagManager.Accounts.Containers.Workspaces
        .create_version(
            {'name': 'apps script version'}, workspacePath)
        .containerVersion;
    console.log(version);
    return version;
  } catch (e) {
    // TODO (Developer) - Handle exception
    console.log('Failed with error: %s', e.error);
  }
}

Publica uma versão de contêiner e exibe o rascunho do contêiner atual.

O código de amostra abaixo usa a API Tag Manager V2 para aceitar uma versão de contêiner que pode ter sido criada no exemplo acima e recupera os códigos da conta, do contêiner e da versão. A amostra usa esses códigos para publicar uma versão ativa do contêiner. Por fim, a amostra cria e registra uma visualização do novo espaço de trabalho.

advanced/tagManager.gs
/**
 * Retrieves the container path from a container version path.
 * @param  {string} versionPath The version path.
 * @return {string}             The container path.
 */
function grabContainerPath(versionPath) {
  const pathParts = versionPath.split('/');
  return pathParts.slice(0, 4).join('/');
}

/**
 * Publishes a container version publically to the world and creates a quick
 * preview of the current container draft.
 * @param {object} version The container version.
 */
function publishVersionAndQuickPreviewDraft(version) {
  try {
    const containerPath = grabContainerPath(version.path);
    // Publish the input container version.
    TagManager.Accounts.Containers.Versions.publish(version.path);
    const workspace = TagManager.Accounts.Containers.Workspaces.create(
        {'name': 'appscript workspace', 'description': 'appscript workspace'},
        containerPath);
    const workspaceId = workspace.path;
    // Quick previews the current container draft.
    const quickPreview = TagManager.Accounts.Containers.Workspaces
        .quick_preview(workspace.path);
    console.log(quickPreview);
  } catch (e) {
    // TODO (Developer) - Handle exceptions
    console.log('Failed with error: $s', e.error);
  }
}

Cria e reautoriza um ambiente de usuário.

O código de amostra abaixo usa a API Tag Manager V2 para aceitar uma versão do contêiner e extrair os códigos da conta, do contêiner e da versão. A amostra usa esses códigos para criar um ambiente do usuário que indica a versão do contêiner de entrada e registra o ambiente. Por fim, a amostra registra um ambiente de usuário reautorizado.

advanced/tagManager.gs
/**
 * Retrieves the container path from a container version path.
 * @param  {string} versionPath The version path.
 * @return {string}             The container path.
 */
function grabContainerPath(versionPath) {
  const pathParts = versionPath.split('/');
  return pathParts.slice(0, 4).join('/');
}

/**
 * Creates and reauthorizes a user environment in a container that points
 * to a container version passed in as an argument.
 * @param {object} version The container version object.
 */
function createAndReauthorizeUserEnvironment(version) {
  try {
    // Creates a container version.
    const containerPath = grabContainerPath(version.path);
    // Creates a user environment that points to a container version.
    const environment = TagManager.Accounts.Containers.Environments.create(
        {
          'name': 'test_environment',
          'type': 'user',
          'containerVersionId': version.containerVersionId
        },
        containerPath);
    console.log('Original user environment: ' + environment);
    // Reauthorizes the user environment that points to a container version.
    TagManager.Accounts.Containers.Environments.reauthorize(
        {}, environment.path);
    console.log('Reauthorized user environment: ' + environment);
  } catch (e) {
    // TODO (Developer) - Handle exceptions
    console.log('Failed with error: $s', e.error);
  }
}

Registra todas as permissões de acesso a e-mail e contêiner em uma conta.

O código de amostra abaixo usa a API Tag Manager V2 para encontrar uma lista de todas as permissões em uma conta do Gerenciador de tags. Depois, a amostra registra o endereço de e-mail do usuário, o código do contêiner e os tipos de permissão de acesso do contêiner para cada entrada.

advanced/tagManager.gs
/**
 * Logs all emails and container access permission within an account.
 * @param {string} accountPath The account path.
 */
function logAllAccountUserPermissionsWithContainerAccess(accountPath) {
  try {
    const userPermissions =
      TagManager.Accounts.User_permissions.list(accountPath).userPermission;
    for (let i = 0; i < userPermissions.length; i++) {
      const userPermission = userPermissions[i];
      if ('emailAddress' in userPermission) {
        const containerAccesses = userPermission.containerAccess;
        for (let j = 0; j < containerAccesses.length; j++) {
          const containerAccess = containerAccesses[j];
          console.log(
              'emailAddress:' + userPermission.emailAddress +
            ' containerId:' + containerAccess.containerId +
            ' containerAccess:' + containerAccess.permission);
        }
      }
    }
  } catch (e) {
    // TODO (Developer) - Handle exceptions
    console.log('Failed with error: $s', e.error);
  }
}