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

Данные API менеджера, включая учетные записи, контейнеры и права доступа пользователей.

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

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

Ссылка

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

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

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

Пример кода

Приведенный ниже пример кода демонстрирует использование некоторых функций сервиса Tag Manager.

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

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

advanced/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 Tag Manager V2 для приема версии контейнера, которая могла быть создана в предыдущем примере, и получения идентификаторов учетной записи, контейнера и версии из этой версии. Пример использует эти идентификаторы для публикации версии контейнера в режиме реального времени. Наконец, пример создает краткий предварительный просмотр нового рабочего пространства и записывает его в лог.

advanced/tagManager.gs

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

/**
 * 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 pathParts = version.path.split("/");
    const containerPath = pathParts.slice(0, 4).join("/");
    // 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 Tag Manager V2 для приема версии контейнера и извлечения идентификаторов учетной записи, контейнера и версии. В примере эти идентификаторы используются для создания пользовательской среды, которая указывает на входную версию контейнера и регистрирует пользовательскую среду. В конце примера регистрируется повторно авторизованная пользовательская среда.

advanced/tagManager.gs

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

/**
 * 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 pathParts = version.path.split("/");
    const containerPath = pathParts.slice(0, 4).join("/");
    // 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 Tag Manager V2 для получения списка всех разрешений в учетной записи Tag Manager. Затем пример выводит в консоль адрес электронной почты пользователя, идентификатор контейнера и типы разрешений доступа к контейнеру для каждой записи.

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