Service Tag Manager

Le service Google Tag Manager permet à un utilisateur autorisé d'accéder aux données de l'API Tag Manager. Ce service permet aux utilisateurs de Tag Manager de gérer les comptes, les conteneurs, les environnements, les versions, les espaces de travail, les dossiers, les variables, les déclencheurs, les balises et les autorisations des utilisateurs Tag Manager.

Référence

Pour en savoir plus sur ce service, consultez la documentation de référence de l'API Tag Manager V2.

Comme tous les services avancés d'Apps Script, le service Tag Manager utilise les mêmes objets, méthodes et paramètres que l'API publique. Pour en savoir plus, consultez la section Détermination des signatures de méthode.

Pour signaler des problèmes et obtenir d'autres informations d'assistance, consultez le Centre d'aide Google Tag Manager.

Exemple de code

L'exemple de code ci-dessous montre comment utiliser quelques fonctionnalités du service Tag Manager.

Crée une version de conteneur avec une variable, un déclencheur et une balise.

L'exemple de code ci-dessous utilise l'API Tag Manager V2 pour créer d'abord un conteneur avec un nom associé à un code temporel avec la date actuelle afin d'augmenter ses chances d'être unique. L'exemple crée ensuite un espace de travail avec une variable de valeur aléatoire et un déclencheur qui se déclenche pour toute vue de page. Ensuite, l'exemple utilise le déclencheur pour créer une balise de pixel arbitraire qui déclenche un pixel sur //example.com avec un cache-buster ajouté à la fin de l'URL. Enfin, l'exemple crée une version de conteneur avec les entités ci-dessus, consigne la version et la renvoie pour une utilisation ultérieure.

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

Publie une version de conteneur et affiche un aperçu rapide de la version préliminaire actuelle du conteneur.

L'exemple de code ci-dessous utilise la version 2 de l'API Tag Manager pour accepter une version de conteneur qui peut avoir été créée dans l'exemple ci-dessus, et pour récupérer les ID de compte, de conteneur et de version à partir de la version. L'exemple utilise ces ID pour publier une version de conteneur en ligne. Enfin, l'exemple crée un aperçu rapide d'un nouvel espace de travail et consigne l'aperçu rapide.

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

Crée et réautorise un environnement utilisateur.

L'exemple de code ci-dessous utilise la version 2 de l'API Tag Manager pour accepter une version de conteneur et extraire les ID de compte, de conteneur et de version. L'exemple utilise ces ID pour créer un environnement utilisateur qui pointe vers la version du conteneur d'entrée et consigne l'environnement utilisateur. L'exemple se termine par l'enregistrement d'un environnement utilisateur réautorisé.

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

Enregistre tous les e-mails et les autorisations d'accès aux conteneurs d'un compte.

L'exemple de code ci-dessous utilise l'API Tag Manager V2 pour obtenir la liste de toutes les autorisations d'un compte Tag Manager. L'exemple consigne ensuite l'adresse e-mail de l'utilisateur, l'ID du conteneur et les types d'autorisations d'accès au conteneur pour chaque entrée.

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