افزودن دستورگان‌های سفارشی

درحال مشاهده اسناد Apigee Edge هستید.
به اسناد Apigee X بروید. اطلاعات

برای افزودن کد سفارشی جاوا اسکریپت یا محتوای HTML قبل‌از برچسب <body> در هر صفحه در درگاهتان:

  1. انتشار > درگاه‌ها را انتخاب کنید و درگاهتان را انتخاب کنید.
  2. در صفحه مقصد، روی تنظیمات کلیک کنید. یا می‌توانید تنظیمات را در منو کرکره‌ای در نوار پیمایش بالا انتخاب کنید.
  3. روی زبانه نوشته‌های سفارشی کلیک کنید.

  4. در بخش دستورگان سفارشی، کد سفارشی جاوا اسکریپت را در چارگوش نوشتاری وارد کنید. می‌توانید چندین دستورگان را اضافه کنید.

  5. روی ذخیره کلیک کنید.

بخش‌های زیر نمونه‌هایی از دستورگان‌های سفارشی ارائه می‌دهند:

همچنین پیکربندی ردیابی Analytics را ببینید.

اجرای یک دستورگان سفارشی درطول رویداد جاوا اسکریپت onLoad یا onUnload

تعریف کردن دستورگان‌های سفارشی برای اجرا شدن وقتی هر صفحه در درگاه شما:

  • بااستفاده از رویداد جاوا اسکریپت onLoad در DOM بار می‌شود.
  • بااستفاده از رویداد جاوا اسکریپت onUnload از آن خارج می‌شود.

تابع سفارشی شما باید به‌عنوان بخشی از portal.pageEventListeners در فضای نام جهانی (اعلام‌شده در متغیر window) تعریف شود.

هر دو رویداد onLoad و onUnload مسیر فعلی صفحه (برای مثال، /quickstart) را به‌عنوان اولین پارامترهای خود دریافت می‌کنند. تابع onUnload مقدار برگشتی از فراخوانی onLoad را به‌عنوان پارامتر دوم خود دریافت می‌کند و امکان می‌دهد زمینه‌ها بین دو رویداد منتقل شود. از onUnload برای پاکسازی شنوندگان رویدادی که دیگر لازم نیستند و انجام فعالیت‌های پاکسازی دیگر استفاده کنید.

برای مثال:

<script>
window.portal = {};
window.portal.pageEventListeners = {
  onLoad: (path) => {
    if (path === '/quickstart') {
      // Change text content of first <p> element to something
      // else. (DOM must be loaded when onLoad is called)
      document.getElementsByTagName('p')[0].textContent =
          'Welcome to the quick start! Be sure to send us your feedback.';
      // print a custom message to the console every second while user is on
      // quickstart page.
      const interval =
          window.setInterval(() => console.log('Hello'), 1000);
      return interval;
    }
    return undefined;
  },
  onUnload: (path, contextReturnedFromOnLoad) => {
    if (contextReturnedFromOnLoad != null) {
      // Stop printing custom message to console every second.
      window.clearInterval(contextReturnedFromOnLoad)

    }
  },
};
</script>

از دستورگان‌های سفارشی می‌توان برای پیاده‌سازی راه‌حل موافقت با کوکی استفاده کرد. چندین گزینه منبع باز محبوب وجود دارد که در JavaScript پیاده‌سازی شده‌اند؛ یکی از آن‌ها را که با الزامات خاص شما برای رعایت استانداردها مطابقت دارد انتخاب کنید.

برای مثال، دستورگان زیر از دستورگان اطلاعات کوکی استفاده می‌کند.

<script type="text/javascript" id="cookieinfo" src="//cookieinfoscript.com/js/cookieinfo.min.js">
</script>