บริการ Tag Manager

ข้อมูล Manager API ซึ่งรวมถึงบัญชี คอนเทนเนอร์ และสิทธิ์ของผู้ใช้

บริการ Google Tag Manager ให้สิทธิ์เข้าถึงข้อมูล Tag Manager API แก่ผู้ใช้ที่ได้รับอนุญาต บริการนี้ช่วยให้ผู้ใช้ Tag Manager จัดการบัญชี คอนเทนเนอร์ สภาพแวดล้อม เวอร์ชัน พื้นที่ทํางาน โฟลเดอร์ ตัวแปร ทริกเกอร์ แท็ก และ สิทธิ์ของผู้ใช้ใน Tag Manager ได้

นี่เป็นบริการขั้นสูงที่ต้องเปิดใช้ก่อน ใช้งาน

ข้อมูลอ้างอิง

ดูข้อมูลโดยละเอียดเกี่ยวกับบริการนี้ได้ในเอกสารอ้างอิงสำหรับ Tag Manager API V2

เช่นเดียวกับบริการขั้นสูงทั้งหมดใน Google Apps Script บริการ Tag Manager จะใช้ออบเจ็กต์ เมธอด และพารามิเตอร์เดียวกันกับ API สาธารณะ ดูข้อมูลเพิ่มเติมได้ที่ วิธีกำหนดลายเซ็นของเมธอด

หากต้องการรายงานปัญหาและรับการสนับสนุนอื่นๆ โปรดดูศูนย์ช่วยเหลือของ Google Tag Manager

โค้ดตัวอย่าง

ตัวอย่างโค้ดต่อไปนี้แสดงวิธีใช้ฟีเจอร์บางอย่างของบริการ Tag Manager

สร้างเวอร์ชันคอนเทนเนอร์ที่มีตัวแปร ทริกเกอร์ และแท็ก

โค้ดตัวอย่างต่อไปนี้ใช้ Tag Manager API V2 เพื่อ สร้างคอนเทนเนอร์ที่มีชื่อซึ่งประทับเวลาด้วยวันที่ปัจจุบันก่อน เพื่อเพิ่มโอกาสในการทำให้ชื่อไม่ซ้ำกัน จากนั้นตัวอย่างจะสร้างพื้นที่ทํางาน ที่มีตัวแปรค่าแบบสุ่ม และทริกเกอร์ที่ทํางานสําหรับการดูหน้าเว็บ จากนั้น ตัวอย่างจะใช้ทริกเกอร์เพื่อสร้างแท็กพิกเซลที่กำหนดเองซึ่งจะเรียกใช้พิกเซล ไปยัง //example.com โดยมีตัวล้างแคชต่อท้ายที่ส่วนท้ายของ URL สุดท้าย ตัวอย่างจะสร้างเวอร์ชันคอนเทนเนอร์ที่มีเอนทิตีเหล่านี้ บันทึกเวอร์ชัน และ ส่งคืนเพื่อใช้ในภายหลัง

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 เพื่อยอมรับเวอร์ชันคอนเทนเนอร์ที่อาจสร้างขึ้นในตัวอย่างก่อนหน้า และเรียกข้อมูลรหัสบัญชี คอนเทนเนอร์ และเวอร์ชันจากเวอร์ชัน ตัวอย่าง ใช้รหัสเหล่านี้เพื่อเผยแพร่เวอร์ชันคอนเทนเนอร์แบบเรียลไทม์ให้ทั่วโลกเห็น สุดท้าย ตัวอย่างจะสร้างการแสดงตัวอย่างด่วนของพื้นที่ทำงานใหม่และบันทึกการแสดงตัวอย่างด่วน

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 เพื่อยอมรับเวอร์ชันคอนเทนเนอร์และแยกบัญชี คอนเทนเนอร์ และรหัสเวอร์ชัน ตัวอย่างใช้รหัสเหล่านี้เพื่อสร้างสภาพแวดล้อมของผู้ใช้ที่ชี้ไปยัง เวอร์ชันของคอนเทนเนอร์อินพุตและบันทึกสภาพแวดล้อมของผู้ใช้ ตัวอย่างจะสิ้นสุดลง โดยการบันทึกสภาพแวดล้อมของผู้ใช้ที่ได้รับอนุญาตอีกครั้ง

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 เพื่อค้นหารายการสิทธิ์ทั้งหมดภายในบัญชี Tag Manager จากนั้นตัวอย่างจะ บันทึกอีเมลของผู้ใช้ รหัสคอนเทนเนอร์ และประเภทสิทธิ์เข้าถึงคอนเทนเนอร์ สำหรับแต่ละรายการ

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