タグ マネージャーのサービス

Google タグ マネージャー サービスを利用すると、認証済みユーザーは Tag Manager API のデータにアクセスできます。ユーザーはこのサービスを利用することで、タグ マネージャーのアカウント、コンテナ、環境、バージョン、ワークスペース、フォルダ、変数、トリガー、タグ、ユーザーのアクセス権を管理できます。

注: これは、使用前に有効にする必要がある高度なサービスです。

リファレンス

このサービスの詳細については、Tag Manager API V2 のリファレンス ドキュメントをご覧ください。

Apps Script のすべての高度なサービスと同様に、タグ マネージャー サービスでは、公開 API と同じオブジェクト、メソッド、パラメータを使用します。詳細については、メソッド シグネチャの決定方法をご覧ください。

問題の報告やその他のサポートについては、Google タグ マネージャー ヘルプセンターをご覧ください。

サンプルコード

以下のサンプルコードは、タグ マネージャー サービスの一部の機能の使用方法を示しています。

変数、トリガー、タグを含むコンテナのバージョンを作成する

以下のサンプルコードでは、Tag Manager API V2 を使用して、まず、現在の日時のタイムスタンプを含む名前のコンテナを作成しています。これは、コンテナが重複する危険性を下げるためです。続いて、ランダム値の変数と、すべてのページビューを対象に配信されるトリガーを含むワークスペースを作成しています。その後、そのトリガーを使用して、URL の末尾にキャッシュの無効化を追加し、//example.com にピクセルを配信する任意のピクセルタグを作成しています。最後に、上記のエンティティを使用してコンテナ バージョンを作成し、バージョンをログに記録して、後で使用できるように返します。

advanced/tagManager.gs

GitHub で表示

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

コンテナのバージョンを公開し、現在のドラフト コンテナのクイック プレビューを確認する

以下のサンプルコードでは、Tag Manager API V2 を使用して、上記の例で作成したコンテナのバージョンを承認し、そのバージョンからアカウント、コンテナ、バージョン ID を取得しています。このサンプルでは、これらの ID を使用してコンテナのバージョンを公開しています。そして最後に、新しいワークスペースのクイック プレビューを作成し、それを記録しています。

advanced/tagManager.gs

GitHub で表示

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

ユーザー環境を作成して再認証する

以下のサンプルコードでは、Tag Manager API V2 を使用してコンテナのバージョンを承認し、アカウント、コンテナ、バージョン ID を抽出しています。このサンプルでは、これらの ID を使用して、入力コンテナのバージョンを参照するユーザー環境を作成し、それを記録しています。最後に、再認証されたユーザー環境を記録します。

advanced/tagManager.gs

GitHub で表示

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

アカウント内のすべてのメールとコンテナのアクセス権を記録する

以下のサンプルコードでは、Tag Manager API V2 を使用して、タグ マネージャー アカウント内のすべての権限の一覧を検索しています。その後、ユーザーのメールアドレス、コンテナ ID、各エントリのコンテナのアクセス権の種類を記録します。

advanced/tagManager.gs

GitHub で表示

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