Tag Manager-Dienst

Der Google Tag Manager-Dienst bietet Zugriff auf Tag Manager API-Daten für einen autorisierten Nutzer. Mit diesem Dienst können Tag Manager-Nutzer Tag Manager-Konten, Container, Umgebungen, Versionen, Arbeitsbereiche, Ordner, Variablen, Auslöser, Tags und Nutzerberechtigungen verwalten.

Referenz

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

Wie alle erweiterten Dienste in Apps Script verwendet der Tag Manager-Dienst dieselben Objekte, Methoden und Parameter wie die öffentliche API. Weitere Informationen finden Sie unter Methodensignaturen ermitteln.

Wenn Sie Probleme melden oder weitere Unterstützung erhalten möchten, lesen Sie die Google Tag Manager-Hilfe.

Beispielcode

Der folgende Beispielcode zeigt, wie Sie einige Funktionen des Tag Manager-Dienstes verwenden.

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

Im folgenden Beispielcode wird die Tag Manager API V2 verwendet, um zuerst einen Container mit einem Namen zu erstellen, der mit dem aktuellen Datum versehen ist, um die Wahrscheinlichkeit zu erhöhen, dass er eindeutig ist. Im Beispiel wird dann ein Arbeitsbereich mit einer Variablen für einen zufälligen Wert und einem Trigger erstellt, der bei jedem Seitenaufruf ausgelöst wird. Als Nächstes wird im Beispiel mit dem Trigger ein beliebiges Pixel-Tag erstellt, mit dem ein Pixel an //example.com gesendet wird. Am Ende der URL wird ein Cache-Buster angehängt. Zuletzt wird im Beispiel eine Containerversion mit den oben genannten Einheiten erstellt, die Version wird 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);
  }
}

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

Im folgenden Beispielcode wird die Tag Manager API V2 verwendet, um eine Containerversion zu akzeptieren, die möglicherweise im obigen Beispiel erstellt wurde, und die Konto-, Container- und Versions-IDs aus der Version abzurufen. Im Beispiel werden diese IDs verwendet, um eine Containerversion zu veröffentlichen. Schließlich wird eine kurze Vorschau eines neuen Arbeitsbereichs erstellt und 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 und reautorisiert eine Nutzerumgebung.

Im folgenden Beispielcode wird die Tag Manager API V2 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 Eingabecontainerversion verweist, und die Nutzerumgebung wird protokolliert. Das Beispiel endet mit der Protokollierung einer Umgebung mit neu autorisierten Nutzern.

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 Containerzugriffsberechtigungen in einem Konto.

Im folgenden Beispielcode wird die Tag Manager API V2 verwendet, um eine Liste aller Berechtigungen in einem Tag Manager-Konto zu finden. Im Beispiel werden dann die E‑Mail-Adresse des Nutzers, die Container-ID und die Arten von 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);
  }
}