سرویس TagManager

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

ارجاع

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

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

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

کد نمونه

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

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

کد نمونه زیر از Tag Manager API V2 برای ایجاد یک محفظه با نامی استفاده می کند که با تاریخ فعلی مهر زمانی دارد تا شانس منحصر به فرد بودن آن افزایش یابد. سپس نمونه یک فضای کاری با یک متغیر مقدار تصادفی و یک ماشه ایجاد می کند که برای هر نمای صفحه فعال می شود. در مرحله بعد، نمونه از ماشه برای ایجاد یک تگ پیکسل دلخواه استفاده می کند که یک پیکسل را به //example.com با یک کش کش اضافه شده به انتهای 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);
  }
}

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

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

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

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

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

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

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

کد نمونه زیر از 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);
  }
}