Служба диспетчера тегов

Служба Google Tag Manager предоставляет авторизованному пользователю доступ к данным Tag Manager API . Эта служба позволяет пользователям Диспетчера тегов управлять учетными записями Диспетчера тегов, контейнерами , средами , версиями , рабочими пространствами , папками , переменными , триггерами , тегами и разрешениями пользователей .

Примечание. Это расширенная услуга, которую необходимо включить перед использованием .

Ссылка

Подробную информацию об этом сервисе можно найти в справочной документации Tag Manager API V2 .

Как и все расширенные службы в Apps Script, служба Диспетчера тегов использует те же объекты, методы и параметры, что и общедоступный API. Дополнительные сведения см. в разделе Как определяются сигнатуры методов .

Чтобы сообщить о проблемах и получить другую поддержку, посетите Справочный центр Диспетчера тегов Google .

Пример кода

В приведенном ниже примере кода показано, как использовать некоторые функции службы Диспетчера тегов.

Создает версию контейнера с переменной, триггером и тегом.

В приведенном ниже примере кода используется API Диспетчера тегов версии 2 , чтобы сначала создать контейнер с именем, к которому привязана текущая дата, чтобы повысить вероятность его уникальности. Затем в образце создается рабочая область со случайной переменной и триггером, который срабатывает при любом просмотре страницы. Далее в примере используется триггер для создания произвольного тега пикселя, который запускает пиксель на //example.com с добавлением в конец URL-адреса средства очистки кеша. Наконец, в примере создается версия контейнера с указанными выше сущностями, регистрируется версия и возвращается ее для дальнейшего использования.

расширенный/tagManager.gs

Посмотреть на GitHub

/**
 * 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);
  }
}

Публикует версию контейнера и осуществляет быстрый предварительный просмотр текущего проекта контейнера.

В приведенном ниже примере кода используется API Диспетчера тегов версии 2 для принятия версии контейнера, который мог быть создан в приведенном выше примере, и получения идентификаторов учетной записи, контейнера и версии из этой версии. В образце эти идентификаторы используются для публикации версии контейнера в реальном времени по всему миру. Наконец, в примере создается быстрый предварительный просмотр новой рабочей области и протоколируется быстрый предварительный просмотр.

расширенный/tagManager.gs

Посмотреть на GitHub

/**
 * 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);
  }
}

Создает и повторно авторизует пользовательскую среду.

В приведенном ниже примере кода используется API Диспетчера тегов версии 2 для принятия версии контейнера и извлечения идентификаторов учетной записи, контейнера и версии. В образце эти идентификаторы используются для создания пользовательской среды, которая указывает на версию входного контейнера и регистрирует пользовательскую среду. Пример завершается регистрацией повторно авторизованной пользовательской среды.

расширенный/tagManager.gs

Посмотреть на GitHub

/**
 * 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);
  }
}

Регистрирует все электронные письма и разрешения на доступ к контейнерам в учетной записи.

В приведенном ниже примере кода используется API Диспетчера тегов версии 2 для поиска списка всех разрешений в учетной записи Диспетчера тегов. Затем в образце регистрируются адрес электронной почты пользователя, идентификатор контейнера и типы разрешений на доступ к контейнеру для каждой записи.

расширенный/tagManager.gs

Посмотреть на GitHub

/**
 * 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);
  }
}