Layanan TagManager

Layanan Google Tag Manager menyediakan akses ke data Tag Manager API untuk pengguna yang diotorisasi. Layanan ini memungkinkan pengguna Tag Manager mengelola akun, penampung, lingkungan, versi, ruang kerja, folder, variabel, pemicu, tag, dan izin pengguna Tag Manager.

Referensi

Untuk mengetahui informasi selengkapnya tentang layanan ini, lihat dokumentasi referensi untuk Tag Manager API V2.

Seperti semua layanan lanjutan di Apps Script, layanan Tag Manager menggunakan objek, metode, dan parameter yang sama dengan API publik. Untuk informasi selengkapnya, lihat Cara menentukan tanda tangan metode.

Untuk melaporkan masalah dan menemukan dukungan lainnya, lihat pusat bantuan Google Tag Manager.

Kode contoh

Kode contoh di bawah menunjukkan cara menggunakan beberapa fitur layanan Tag Manager.

Membuat versi penampung dengan variabel, pemicu, dan tag.

Contoh kode di bawah menggunakan Tag Manager API V2 untuk membuat penampung terlebih dahulu dengan nama yang diberi stempel waktu dengan tanggal saat ini untuk meningkatkan peluangnya menjadi unik. Kemudian, sampel akan membuat ruang kerja dengan variabel nilai acak, dan pemicu yang diaktifkan untuk setiap kunjungan halaman. Selanjutnya, contoh ini menggunakan pemicu untuk membuat tag piksel arbitrer yang memicu piksel ke //example.com dengan cache buster yang ditambahkan ke akhir URL. Terakhir, contoh membuat versi penampung dengan entity di atas, mencatat versi tersebut ke dalam log, dan menampilkannya untuk digunakan nanti.

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

Memublikasikan versi penampung dan melihat pratinjau cepat draf penampung saat ini.

Contoh kode di bawah menggunakan Tag Manager API V2 untuk menerima versi penampung yang mungkin telah dibuat dalam contoh di atas, dan mengambil ID akun, penampung, dan versi dari versi tersebut. Contoh ini menggunakan ID ini untuk memublikasikan versi penampung secara live ke seluruh dunia. Terakhir, contoh ini membuat pratinjau cepat ruang kerja baru dan mencatat pratinjau cepat ke dalam log.

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

Membuat dan memberikan otorisasi ulang pada lingkungan pengguna.

Contoh kode di bawah menggunakan Tag Manager API V2 untuk menerima versi penampung dan mengekstrak ID akun, penampung, dan versi. Contoh ini menggunakan ID ini untuk membuat lingkungan pengguna yang mengarah ke versi penampung input dan mencatat lingkungan pengguna ke dalam log. Contoh ini ditutup dengan mencatat lingkungan pengguna yang diberi otorisasi ulang.

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

Mencatat semua email dan izin akses penampung dalam akun.

Kode contoh di bawah menggunakan Tag Manager API V2 untuk menemukan daftar semua izin dalam akun Tag Manager. Kemudian, sampel tersebut akan mencatat alamat email pengguna, ID penampung, dan jenis izin akses penampung untuk setiap entri.

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