Usługa Menedżera tagów

Usługa Menedżera tagów Google zapewnia dostęp do danych interfejsu API Menedżera tagów autoryzowanym użytkownikom. Umożliwia ona użytkownikom Menedżera tagów zarządzanie kontami, containers, środowiskami, versions, obszarami roboczymi, folderami, zmiennymi, regułami, tagami i uprawnieniami użytkowników.

Dokumentacja

Szczegółowe informacje o tej usłudze znajdziesz w dokumentacji interfejsu Tag Manager API V2.

Podobnie jak wszystkie usługi zaawansowane w Apps Script, usługa Menedżera tagów korzysta z tych samych obiektów, metod i parametrów co publiczny interfejs API. Więcej informacji znajdziesz w artykule Jak określane są podpisy metod.

Aby zgłosić problemy i znaleźć inną pomoc, odwiedź Centrum pomocy Menedżera tagów Google.

Przykładowy kod

Przykładowy kod poniżej pokazuje, jak korzystać z kilku funkcji usługi Menedżer tagów.

Tworzy wersję kontenera ze zmienną, regułą i tagiem.

Poniższy przykładowy kod korzysta z interfejsu Tag Manager API V2, aby najpierw utworzyć kontener z nazwą oznaczoną sygnaturą czasową bieżącą datą, co zwiększa szanse na jego unikalność. W przykładzie tworzony jest następnie obszar roboczy ze zmienną o losowej wartości oraz regułą uruchamianą przy każdym wyświetleniu strony. Następnie w przykładzie użyto reguły do utworzenia dowolnego tagu pikselowego, który uruchamia piksel do wywołania //example.com z elementem do omijania pamięci podręcznej dołączonym na końcu adresu URL. Na koniec przykład tworzy wersję kontenera z wymienionymi wyżej elementami, zapisuje wersję i zwraca ją do późniejszego użycia.

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

Publikuje wersję kontenera i umożliwia szybki podgląd bieżącej wersji roboczej kontenera.

Przykładowy kod poniżej używa interfejsu Tag Manager API V2, by zaakceptować wersję kontenera, która mogła zostać utworzona w przykładzie powyżej, i pobrać z niej identyfikatory konta, kontenera i wersji. Identyfikator wykorzystuje te identyfikatory do opublikowania wersji kontenera na całym świecie. Na koniec przykład tworzy szybki podgląd nowego obszaru roboczego i loguje szybki podgląd.

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

Tworzy i ponownie autoryzuje środowisko użytkownika.

Przykładowy kod poniżej za pomocą interfejsu Tag Manager API V2 akceptuje wersję kontenera oraz wyodrębnia identyfikatory konta, kontenera i wersji. W przykładzie użyto tych identyfikatorów do utworzenia środowiska użytkownika, które wskazuje na wejściową wersję kontenera i loguje środowisko użytkownika. Przykład kończy się zarejestrowaniem ponownie autoryzowanego środowiska użytkownika.

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

Rejestruje wszystkie e-maile i uprawnienia dostępu do kontenerów na koncie.

W przykładowym kodzie poniżej za pomocą interfejsu Tag Manager API V2 znajdziesz listę wszystkich uprawnień na koncie Menedżera tagów. W przykładzie zostanie zapisany adres e-mail użytkownika, identyfikator kontenera i typy uprawnień dostępu do kontenera dla każdego wpisu.

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