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

بيانات واجهة برمجة التطبيقات الخاصة بخدمة "إدارة العلامات من Google"، بما في ذلك الحسابات والحاويات وأذونات المستخدمين

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

هذه خدمة متقدّمة يجب تفعيلها قبل استخدامها.

مراجع

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

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

للإبلاغ عن المشاكل والعثور على دعم آخر، يُرجى الاطّلاع على مركز مساعدة Google Tag Manager.

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

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

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

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

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

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

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

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

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

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