اعلان‌های محدودیت را تنظیم کنید

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

مقدمه

می‌توانید محدودیت‌های مربوط به کسب درآمد را تنظیم کنید، همانطور که در اعمال محدودیت‌های کسب درآمد با استفاده از خط‌مشی بررسی محدودیت‌های کسب درآمد توضیح داده شده است. همچنین می‌توانید اعلان‌های خودکار را تنظیم کنید که به توسعه‌دهندگان و/یا کاربران در سازمانتان، در صورت نزدیک شدن به محدودیت یا رسیدن به آن، هشدار دهد.

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

جعبه ابزار

می‌توانید با استفاده از رابط کاربری مدیریت یا API کسب درآمد، اعلان‌های خودکار محدودیت‌ها را تنظیم کنید. اگر از رابط کاربری استفاده می کنید، اعلان های خودکار را در صفحه اعلان ها تنظیم می کنید.

اگر از API استفاده می‌کنید، اعلان‌های خودکار محدودیت‌ها را با ویرایش یک الگوی اعلان ارائه شده توسط کسب درآمد تنظیم می‌کنید. سپس شرایطی را که منجر به ارسال اعلان ارائه شده توسط الگوی ویرایش شده می شود، مشخص می کنید.

تنظیم اعلان‌های محدود با استفاده از رابط کاربری

  1. در بخش اعلان‌ها در صفحه افزودن محدودیت، روی افزودن کلیک کنید. با این کار بخش Notification باز می شود.

  2. سطحی را برای اعلان انتخاب کنید. این یک آستانه بر اساس یک عدد مطلق یا درصدی از مبنای حد است. انتخاب کنید:
    • بزرگتر یا مساوی علامت (?) یا کوچکتر یا مساوی علامت (?) از منوی کشویی.
    • یک عدد کامل (یعنی بدون رقم اعشار). مطلق (برای نشان دادن مقدار عددی) یا درصد برای نشان دادن مقدار درصد. برای محدودیت‌های درصد، همیشه مطمئن شوید که حد را روی > تنظیم کرده‌اید، به این معنی که اعلان زمانی ارسال می‌شود که توسعه‌دهنده به آن سطح درصد برسد یا از آن عبور کند.

    به عنوان مثال، اگر محدودیت هزینه را 100 دلار تعیین کنید و اعلان را بیشتر یا مساوی 90 درصد تعیین کنید، زمانی که 90 درصد از حد مجاز (90 دلار) رسید یا فراتر رفت، اعلان ارسال می شود.

  3. در قسمت ارسال ایمیل، یک یا چند توسعه دهنده را انتخاب کنید یا یک یا چند کاربر در سازمان خود را انتخاب کنید. اعلان برای توسعه دهندگان یا کاربران آسیب دیده ارسال خواهد شد.

    گیرندگان ایمیل: تنها در صورتی می‌توانید برای توسعه‌دهندگان اعلان ارسال کنید که شرط محدودیت برنامه‌نویس را «Any» تنظیم کنید یا شرط محدودیت برنامه‌نویس را با یک توسعه‌دهنده خاص تنظیم کنید. اگر "Any" را انتخاب کرده باشید، "Selected developer (Any)" را در لیست آدرس های ایمیل مشاهده خواهید کرد. این بدان معناست که کسب درآمد برای توسعه دهندگان آسیب دیده اعلان ارسال می کند. اگر برنامه‌نویس خاصی را انتخاب کرده‌اید، «توسعه‌دهنده انتخاب شده ( {developer_id} )» را در فهرست آدرس‌های ایمیل (که در آن {developer_id} شناسه توسعه‌دهنده انتخاب‌شده است) خواهید دید. کسب درآمد فقط برای آن برنامه‌نویس خاص اعلان ارسال می‌کند.

    اگر شرط محدودیت برنامه‌نویس «Any» یا یک توسعه‌دهنده خاص را انتخاب نکرده‌اید، «Selected developer (Any)» را در قسمت Send Email مشاهده نخواهید کرد. با این حال، می‌توانید انتخاب کنید که به کدام یک از کاربران سازمان خود اطلاع دهید.

    می‌توانید با انتخاب «کاربران سازمان» در برگه «مدیریت»، آدرس‌های ایمیل را برای کاربران سازمان خود اضافه کنید.

    الگوهای ایمیل: پس از انتخاب در قسمت ارسال ایمیل "توسعه دهنده انتخابی (هر)" یا آدرس ایمیل کاربران در سازمان خود (یا هر دو) یک الگوی ایمیل را مشاهده خواهید کرد. آنچه در الگو نشان داده می شود به موارد زیر بستگی دارد:

    • سطح اطلاع رسانی
    • اینکه آیا این محدودیت محدودیت اجرای توقف بوده یا خیر.
    • چه ایمیل برای کاربران سازمان، توسعه دهندگان یا هر دو باشد.

    برای مثال، اگر همه موارد زیر درست باشد:

    • چک باکس اجرای توقف علامت زده شده است.
    • سطح اطلاع رسانی 100% یا همان مقدار حد مجاز است.
    • ایمیل فقط برای کاربران سازمان است.

    قالب به شکل زیر است:

    فرض کنید نام شرکت توسعه‌دهنده "شرکت XYZ" است، محدودیت حجم تراکنش برای یک بسته API به نام "X Package" و یک محصول API با نام "Y Product" 50 است، و تاریخ انقضا در 30 سپتامبر تعیین شده است. 2013. پیام ایمیلی که ارسال می شود به شکل زیر است:

    Developer XYZ company has exceeded their transaction volume limit of 50 transactions for X package, Y product. Their API calls will be blocked till 2013-09-30

    اگر ایمیل به "Selected developer (Any)" باشد، الگو به صورت زیر ظاهر می شود:

    هر دو الگو متغیرهای مربوطه مانند نام توسعه دهنده (در صورت وجود)، نام بسته (در صورت وجود) و نام محصول (در صورت وجود) را حل می کنند. می توانید با کلیک بر روی ویرایش در سمت چپ الگو، پیام را ویرایش کنید تا نیازهای خود را برآورده کند.

    اگر محدودیت برای "Any" یا یک برنامه خاص و "Any" یا یک کاربر خاص است، همچنین باید متغیرهایی را برای برنامه(ها) و کاربر(ها) به الگو اضافه کنید. شما می توانید این کار را به صورت زیر انجام دهید:

    • روی ویرایش در سمت چپ الگو کلیک کنید.
    • ${user.name} user, depending on whether the limit is for application and/or user.

    یک الگوی ویرایش شده برای "Any" یا یک برنامه خاص در زیر نشان داده شده است.

    اگر اجرای توقف بررسی نشود، یا سطح اعلان بزرگتر یا مساوی 100 درصد باشد، الگوی یک توسعه دهنده انتخاب شده به این صورت است:

    دوباره، اگر محدودیت برای "هر" (یا یک برنامه خاص) یا "هر" (یا یک کاربر خاص) است، باید الگو را ویرایش کنید و سپس برنامه ${application.name} و/یا ${user.name} را اضافه کنید. کاربر ${user.name} ، بسته به اینکه محدودیت برای یک برنامه، یک کاربر یا هر دو باشد.

    متغیرهای الگو: وقتی پیام را در قالب ایمیل ویرایش می‌کنید، می‌توانید هر یک از متغیرهای زیر را اضافه کنید.

    متغیر توضیحات
    ${developer.name}

    نام توسعه دهنده.

    ${developer.legalName}

    نام شرکت سازنده.

    ${ratePlan.monetizationPackage.displayName}

    نام بسته API.

    ${application.name}

    نام برنامه.

    ${USER}

    نام کاربر.

    ${USAGE}

    استفاده فعلی (کل درآمد یا هزینه ها، یا حجم).

    ${PERCENT}

    درصد محدودیتی که با استفاده فعلی به آن رسیده است.

    ${QUOTA_TYPE}

    نوع محدودیت (حجم تراکنش، محدودیت هزینه، یا قرار گرفتن در معرض کارمزد).

    ${QUOTA_UNIT}

    واحد اصلی برای حد: ارز (برای محدودیت هزینه)، یا تماس (برای محدودیت تراکنش).

    ${QUOTA_LIMIT}

    مقدار حد.

    ${EXPIRY_DATE}

    تاریخ یا زمانی که محدودیت منقضی می شود یا زمانی که بازنشانی می شود.

    برای مثال، اگر می‌خواهید زمانی که توسعه‌دهنده‌ای به درصد معینی از حجم تراکنش برای هر بسته در هر برنامه‌ای رسیده است مطلع شوید، می‌توانید الگو را به شکل زیر ویرایش کنید:

    ${developer.legalName} has reached a total volume of ${USAGE} on ${ratePlan.monetizationPackage.displayName}. This is ${PERCENT} of the daily/weekly/monthly (state period of limit as appropriate) transaction volume limit of ${QUOTA_LIMIT}.
  4. اعلان ها را در صورت نیاز برای سطوح اضافی اضافه کنید. برای هر سطح اضافی، روی افزودن کلیک کنید. این یک ناحیه سطح، ارسال ایمیل و الگوی ایمیل را به بخش اعلان‌های صفحه اضافه می‌کند. می توانید تا 6 سطح برای اعلان های خود اضافه کنید. به عنوان مثال اگر اعلان را روی 70%، 80%، 90%، 100% تنظیم کنید، پس از رسیدن به هر یک از این سطوح، اعلان ارسال خواهد شد.
  5. پس از اینکه همه اعلان‌ها را اضافه کردید، روی ذخیره (برای ذخیره و انتشار اعلان‌ها در تاریخ بعدی)، ذخیره و انتشار (برای انتشار اکنون)، یا لغو (برای لغو) کلیک کنید.

تنظیم اعلان های محدودیت با استفاده از API

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

مراحل بعدی

نحوه تنظیم اعلان‌های خودکار را بیاموزید تا بتوانید به برنامه‌نویسان درباره رویدادهایی مانند محصولات جدید، نسخه‌های جدید T&C یا طرح‌های نرخ جدید هشدار دهید. به تنظیم اعلان ها با استفاده از الگوهای اعلان مراجعه کنید.