TagManager Hizmeti

Hesaplar, kapsayıcılar ve kullanıcı izinleri dahil olmak üzere Etiket Yöneticisi API verilerini yönetin.

Google Etiket Yöneticisi hizmeti, yetkili bir kullanıcı için Etiket Yöneticisi API verilerine erişim sağlar. Bu hizmet, Etiket Yöneticisi kullanıcılarının Etiket Yöneticisi hesaplarını, kapsayıcılarını, ortamlarını, sürümlerini, çalışma alanlarını, klasörlerini, değişkenlerini, tetikleyicilerini, etiketlerini ve kullanıcı izinlerini yönetmesine olanak tanır.

Bu, kullanımdan önce etkinleştirilmesi gereken gelişmiş bir hizmettir.

Referans

Bu hizmetle ilgili ayrıntılı bilgi için Etiket Yöneticisi API V2 referans belgelerine bakın.

Google Apps Komut Dosyası'ndaki tüm gelişmiş hizmetler gibi Etiket Yöneticisi hizmeti de herkese açık API ile aynı nesneleri, yöntemleri ve parametreleri kullanır. Daha fazla bilgi için Yöntem imzalarının nasıl belirlendiği başlıklı makaleyi inceleyin.

Sorunları bildirmek ve diğer destek seçeneklerini görmek için Google Etiket Yöneticisi Yardım Merkezi'ne bakın.

Örnek kod

Aşağıdaki örnek kodda, Tag Manager hizmetinin bazı özelliklerinin nasıl kullanılacağı gösterilmektedir.

Değişken, tetikleyici ve etiket içeren bir kapsayıcı sürümü oluşturur.

Aşağıdaki örnek kod, benzersiz olma olasılığını artırmak için önce geçerli tarihle zaman damgası eklenmiş bir ada sahip bir kapsayıcı oluşturmak üzere Etiket Yöneticisi API v2'yi kullanır. Ardından örnek, rastgele değer değişkeni içeren bir çalışma alanı ve herhangi bir sayfa görüntülemesi için tetiklenen bir tetikleyici oluşturur. Ardından, örnek, URL'nin sonuna bir önbellek engelleyici eklenmiş olarak //example.com pikselini tetikleyen rastgele bir piksel etiketi oluşturmak için tetikleyiciyi kullanır. Son olarak, örnek bu öğeleri içeren bir kapsayıcı sürümü oluşturur, sürümü günlüğe kaydeder ve daha sonra kullanılmak üzere döndürür.

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

Kapsayıcı sürümünü yayınlar ve mevcut kapsayıcı taslağını hızlıca önizler.

Aşağıdaki örnek kod, önceki örnekte oluşturulmuş olabilecek bir kapsayıcı sürümünü kabul etmek ve sürümden hesap, kapsayıcı ve sürüm kimliklerini almak için Etiket Yöneticisi API V2'yi kullanır. Örnek, bir kapsayıcı sürümünü tüm dünyada yayınlamak için bu kimlikleri kullanır. Son olarak, örnek yeni bir çalışma alanının hızlı önizlemesini oluşturur ve hızlı önizlemeyi günlüğe kaydeder.

advanced/tagManager.gs
/**
 * 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 pathParts = version.path.split("/");
    const containerPath = pathParts.slice(0, 4).join("/");
    // 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);
  }
}

Kullanıcı ortamı oluşturur ve yeniden yetkilendirir.

Aşağıdaki örnek kod, kapsayıcı sürümünü kabul etmek ve hesap, kapsayıcı ve sürüm kimliklerini ayıklamak için Etiket Yöneticisi API V2'yi kullanır. Örnek, giriş kapsayıcı sürümünü işaret eden ve kullanıcı ortamını kaydeden bir kullanıcı ortamı oluşturmak için bu kimlikleri kullanır. Örnek, yeniden yetkilendirilmiş bir kullanıcı ortamı kaydedilerek sonlandırılır.

advanced/tagManager.gs
/**
 * 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 pathParts = version.path.split("/");
    const containerPath = pathParts.slice(0, 4).join("/");
    // 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);
  }
}

Bir hesaptaki tüm e-postaları ve kapsayıcı erişim izinlerini günlüğe kaydeder.

Aşağıdaki örnek kod, bir Etiket Yöneticisi hesabındaki tüm izinlerin listesini bulmak için Etiket Yöneticisi API'si V2'yi kullanır. Ardından örnek, kullanıcının e-posta adresini, kapsayıcı kimliğini ve her giriş için kapsayıcı erişim izinlerinin türlerini günlüğe kaydeder.

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