Servicio de TagManager

El servicio de Google Tag Manager proporciona acceso a los datos de la API de Tag Manager a un usuario autorizado. Este servicio permite a los usuarios de Tag Manager administrar las cuentas, los contenedores, los entorno, las versiones, los espacios de trabajo, las carpetas, las variables, los activadores, las etiquetas y los permisos del usuario de Tag Manager.

Referencia

Para obtener información detallada sobre este servicio, consulta la documentación de referencia de la API de Tag Manager V2.

Al igual que todos los servicios avanzados de Apps Script, el servicio de Tag Manager usa los mismos objetos, métodos y parámetros que la API pública. Para obtener más información, consulta Cómo se determinan las firmas de métodos.

Para informar problemas y obtener otra asistencia, consulta el Centro de ayuda de Google Tag Manager.

Código de muestra

En el siguiente código de muestra, se muestra cómo usar algunas funciones del servicio de Tag Manager.

Crea una versión del contenedor con una variable, un activador y una etiqueta.

En el siguiente código de muestra, se usa la API de Tag Manager v2 para crear primero un contenedor con un nombre que tenga una marca de tiempo con la fecha actual para aumentar las probabilidades de que sea único. Luego, la muestra crea un espacio de trabajo con una variable de valor aleatorio y un activador que se activa para cualquier vista de página. A continuación, la muestra usa el activador para crear una etiqueta de píxeles arbitraria que activa un píxel en //example.com con un generador de prevención de almacenamiento en caché agregado al final de la URL. Por último, la muestra crea una versión de contenedor con las entidades anteriores, registra la versión y la muestra para usarla más adelante.

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

Publica una versión del contenedor y muestra una vista previa rápida del borrador actual del contenedor.

En la siguiente muestra de código, se usa la API de Tag Manager v2 para aceptar una versión de contenedor que se pudo haber creado en el ejemplo anterior y recuperar los IDs de la cuenta, el contenedor y la versión. En la muestra, se usan estos IDs para publicar una versión del contenedor en vivo para todo el mundo. Por último, la muestra crea una vista previa rápida de un lugar de trabajo nuevo y registra la vista previa rápida.

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

Crea y vuelve a autorizar un entorno de usuario.

En la siguiente muestra de código, se usa la API de Tag Manager V2 para aceptar una versión de contenedor y extraer los IDs de la cuenta, el contenedor y la versión. En el ejemplo, se usan estos IDs para crear un entorno de usuario que apunte a la versión del contenedor de entrada y registre el entorno de usuario. El ejemplo concluye con el registro de un entorno de usuario reautorizado.

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

Registra todos los correos electrónicos y los permisos de acceso a los contenedores dentro de una cuenta.

En el siguiente código de muestra, se usa la API de Tag Manager V2 para encontrar una lista de todos los permisos dentro de una cuenta de Tag Manager. Luego, la muestra registra la dirección de correo electrónico del usuario, el ID del contenedor y los tipos de permisos de acceso al contenedor para cada entrada.

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