سرویس TagManager

سرویس Google Tag Manager دسترسی به داده‌های API مربوط به Tag Manager را برای یک کاربر مجاز فراهم می‌کند. این سرویس به کاربران Tag Manager اجازه می‌دهد تا حساب‌های کاربری Tag Manager، کانتینرها ، محیط‌ها ، نسخه‌ها ، فضاهای کاری ، پوشه‌ها ، متغیرها ، تریگرها ، برچسب‌ها و مجوزهای کاربر را مدیریت کنند.

مرجع

برای اطلاعات دقیق در مورد این سرویس، به مستندات مرجع مربوط به Tag Manager API V2 مراجعه کنید.

مانند تمام سرویس‌های پیشرفته در Apps Script، سرویس Tag Manager از همان اشیاء، متدها و پارامترهای API عمومی استفاده می‌کند. برای اطلاعات بیشتر، به بخش «نحوه تعیین امضاهای متد» مراجعه کنید.

برای گزارش مشکلات و یافتن پشتیبانی‌های دیگر، به مرکز راهنمای گوگل تگ منیجر مراجعه کنید.

کد نمونه

کد نمونه زیر نحوه استفاده از چند ویژگی سرویس Tag Manager را نشان می‌دهد.

یک نسخه کانتینر با یک متغیر، تریگر و تگ ایجاد می‌کند.

کد نمونه زیر با استفاده از Tag Manager API V2 ابتدا یک کانتینر با نامی که با تاریخ فعلی برچسب زمانی خورده است ایجاد می‌کند تا شانس منحصر به فرد بودن آن را افزایش دهد. سپس این نمونه یک فضای کاری با یک متغیر مقدار تصادفی و یک تریگر ایجاد می‌کند که برای هر بازدید از صفحه فعال می‌شود. در مرحله بعد، این نمونه از تریگر برای ایجاد یک تگ پیکسل دلخواه استفاده می‌کند که یک پیکسل را به //example.com با یک cache buster که به انتهای URL اضافه شده است، فعال می‌کند. در نهایت، نمونه یک نسخه کانتینر با موجودیت‌های فوق ایجاد می‌کند، نسخه را ثبت می‌کند و آن را برای استفاده بعدی برمی‌گرداند.

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

یک نسخه کانتینر منتشر می‌کند و پیش‌نمایشی سریع از پیش‌نویس کانتینر فعلی ارائه می‌دهد.

کد نمونه زیر از API نسخه ۲ تگ منیجر برای پذیرش یک نسخه کانتینر که ممکن است در مثال بالا ایجاد شده باشد، استفاده می‌کند و شناسه‌های حساب، کانتینر و نسخه را از آن نسخه بازیابی می‌کند. این نمونه از این شناسه‌ها برای انتشار زنده یک نسخه کانتینر به جهان استفاده می‌کند. در نهایت، این نمونه یک پیش‌نمایش سریع از یک فضای کاری جدید ایجاد می‌کند و پیش‌نمایش سریع را ثبت می‌کند.

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

یک محیط کاربری ایجاد و مجدداً مجاز می‌کند.

کد نمونه زیر از Tag Manager API V2 برای پذیرش یک نسخه کانتینر و استخراج شناسه‌های حساب، کانتینر و نسخه استفاده می‌کند. این نمونه از این شناسه‌ها برای ایجاد یک محیط کاربری استفاده می‌کند که به نسخه کانتینر ورودی اشاره می‌کند و محیط کاربر را ثبت می‌کند. این نمونه با ثبت یک محیط کاربر مجاز مجدد شده به پایان می‌رسد.

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

تمام ایمیل‌ها و مجوزهای دسترسی به کانتینر را در یک حساب کاربری ثبت می‌کند.

کد نمونه زیر از Tag Manager API V2 برای یافتن لیستی از تمام مجوزهای موجود در یک حساب Tag Manager استفاده می‌کند. سپس این نمونه، آدرس ایمیل کاربر، شناسه کانتینر و انواع مجوزهای دسترسی به کانتینر را برای هر ورودی ثبت می‌کند.

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