Tag Manager-Dienst

Über den Google Tag Manager-Dienst erhalten autorisierte Nutzer Zugriff auf Daten der Tag Manager API. Mit diesem Dienst können Tag Manager-Nutzer Konten, containers, Umgebungen, versions, Arbeitsbereiche, Ordner, Variablen, Trigger, Tags und Nutzerberechtigungen in Tag Manager verwalten.

Referenz

Ausführliche Informationen zu diesem Dienst finden Sie in der Referenzdokumentation zur Tag Manager API Version 2.

Wie alle erweiterten Dienste in Apps Script verwendet auch der Tag Manager die gleichen Objekte, Methoden und Parameter wie die öffentliche API. Weitere Informationen finden Sie unter So werden Methodensignaturen ermittelt.

In der Google Tag Manager-Hilfe erfahren Sie, wie Sie Probleme melden und weiteren Support erhalten.

Beispielcode

Der folgende Beispielcode zeigt, wie einige Funktionen des Tag Manager-Dienstes verwendet werden.

Erstellt eine Containerversion mit einer Variablen, einem Trigger und einem Tag.

Im folgenden Beispielcode wird mithilfe der Tag Manager API Version 2 zuerst ein Container mit einem Namen erstellt, dessen Zeitstempel das aktuelle Datum enthält. Dadurch wird die Wahrscheinlichkeit erhöht, dass er eindeutig ist. Im Beispiel wird dann ein Arbeitsbereich mit einer zufälligen Wertvariablen und einem Trigger erstellt, der für jeden Seitenaufruf ausgelöst wird. Als Nächstes wird im Beispiel der Trigger verwendet, um ein beliebiges Pixel-Tag zu erstellen, das ein Pixel in //example.com auslöst, wobei ein Cache-Buster an das Ende der URL angehängt ist. Zuletzt wird im Beispiel eine Containerversion mit den oben genannten Entitäten erstellt, die Version protokolliert und zur späteren Verwendung zurückgegeben.

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

Es wird eine Containerversion veröffentlicht und eine Vorschau des aktuellen Containerentwurfs angezeigt.

Im folgenden Beispielcode wird die Tag Manager API Version 2 verwendet, um eine Containerversion zu akzeptieren, die im obigen Beispiel erstellt wurde, und um die Konto-, Container- und Versions-IDs der Version abzurufen. Im Beispiel werden diese IDs verwendet, um eine Containerversion online zu veröffentlichen. Im letzten Beispiel wird eine schnelle Vorschau eines neuen Arbeitsbereichs erstellt und die schnelle Vorschau protokolliert.

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

Erstellt eine Nutzerumgebung und autorisiert sie noch einmal.

Im folgenden Beispielcode wird die Tag Manager API Version 2 verwendet, um eine Containerversion zu akzeptieren und die Konto-, Container- und Versions-IDs zu extrahieren. Im Beispiel werden diese IDs verwendet, um eine Nutzerumgebung zu erstellen, die auf die Version des Eingabecontainers verweist und die Nutzerumgebung protokolliert. Das Beispiel endet mit dem Logging einer neu autorisierten Nutzerumgebung.

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

Protokolliert alle E-Mails und Zugriffsberechtigungen für Container innerhalb eines Kontos.

Im folgenden Beispielcode wird mithilfe der Tag Manager API Version 2 eine Liste aller Berechtigungen in einem Tag Manager-Konto abgerufen. Im Beispiel werden dann die E-Mail-Adresse des Nutzers, die Container-ID und die Arten der Containerzugriffsberechtigungen für jeden Eintrag protokolliert.

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