خدمة "إدارة العلامات من Google"

تتيح خدمة "إدارة العلامات من Google" للمستخدم المعتمَد الوصول إلى بيانات واجهة برمجة التطبيقات الخاصة بأداة "إدارة العلامات". تتيح هذه الخدمة لمستخدمي "إدارة العلامات من Google" إدارة الحسابات والحاويات والبيئات والإصدارات ومساحات العمل والمجلدات والمتغيرات والمشغّلات والعلامات وأذونات المستخدمين.

مراجع

للحصول على معلومات مفصّلة حول هذه الخدمة، يُرجى الاطّلاع على المستندات المرجعية الخاصة بإصدار Tag Manager API 2.

مثل جميع الخدمات المتقدّمة في Apps Script، تستخدم خدمة Tag Manager الكائنات والطُرق والمعلَمات نفسها المستخدَمة في واجهة برمجة التطبيقات العامة. لمزيد من المعلومات، اطّلِع على كيفية تحديد تواقيع الطرق.

للإبلاغ عن مشاكل والعثور على معلومات مفيدة أخرى، يُرجى الانتقال إلى مركز مساعدة "إدارة العلامات من Google".

نموذج التعليمات البرمجية

يوضّح نموذج الرمز البرمجي أدناه كيفية استخدام بعض ميزات خدمة "إدارة العلامات من Google".

تُنشئ هذه الطريقة إصدار حاوية يتضمّن متغيّرًا ومشغّلاً وعلامة.

يستخدم نموذج الرمز البرمجي أدناه الإصدار 2 من Tag Manager API لإنشاء حاوية تحمل اسمًا يتضمّن الطابع الزمني مع التاريخ الحالي لزيادة فرص أن يكون الاسم فريدًا. بعد ذلك، تنشئ العيّنة مساحة عمل تحتوي على متغيّر قيمة عشوائية، ومشغّل يتم تنشيطه عند كلّ مشاهدة للصفحة. بعد ذلك، يستخدم المثال المشغّل لإنشاء علامة بكسل عشوائية تُطلق بكسلًا إلى //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);
  }
}

ينشر إصدار حاوية ويعرض معاينة سريعة لمسودة الحاوية الحالية.

يستخدم نموذج الرمز البرمجي أدناه الإصدار 2 من Tag Manager API لقبول إصدار حاوية ربما تم إنشاؤه في المثال أعلاه، واسترداد معرّفات الحساب والحاوية والإصدار من الإصدار. يستخدم النموذج المعرّفات هذه لنشر إصدار حاوية مباشر للجميع. أخيرًا، ينشئ النموذج معاينة سريعة لمساحة عمل جديدة ويسجّل هذه المعاينة.

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

تنشئ هذه السمة بيئة مستخدم وتعيد منح الإذن بها.

يستخدم نموذج الرمز البرمجي أدناه الإصدار 2 من Tag Manager API لقبول إصدار حاوية واستخراج معرّفات الحساب والحاوية والإصدار. يستخدم النموذج أرقام التعريف هذه لإنشاء بيئة مستخدم تشير إلى إصدار حاوية الإدخال وتسجّل بيئة المستخدم. ينتهي النموذج بتسجيل بيئة مستخدم تمت إعادة تفويضها.

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

تسجّل هذه السمة جميع رسائل البريد الإلكتروني وأذونات الوصول إلى الحاوية ضِمن الحساب.

يستخدم نموذج الرمز البرمجي أدناه الإصدار 2 من Tag Manager API للعثور على قائمة بجميع الأذونات ضِمن حساب على "إدارة العلامات من Google". بعد ذلك، تسجّل العيّنة عنوان البريد الإلكتروني للمستخدم ومعرّف الحاوية وأنواع أذونات الوصول إلى الحاوية لكل إدخال.

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