راه‌اندازی اعلان‌ها بااستفاده از الگوهای اعلان

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

الگوهای اعلان چیست؟

«درآمدزایی» مجموعه‌ای از الگوها را ارائه می‌دهد که متن نمونه را برای انواع مختلف اعلان‌های رویداد تعریف می‌کنند. می‌توانید هریک از این الگوها را برای موارد زیر سفارشی‌سازی کنید:

• همه توسعه‌دهندگان را درباره رویدادهایی مثل محصولات جدید، نسخه‌های جدید «شرایط خدمات»، یا طرح‌های نرخ جدید مطلع کنید.
• توسعه‌دهندگان تحت تأثیر قرارگرفته را درباره رویدادهایی مثل طرح نرخ اصلاح‌شده مطلع کنید.
• ارائه‌دهنده API را درباره رویدادهای مرتبط با توسعه‌دهنده، مثلاً زمانی که توسعه‌دهنده برای حساب ثبت‌نام می‌کند یا زمانی که توسعه‌دهنده برای طرح نرخ ثبت‌نام می‌کند، مطلع کنید.
• همه سرپرستان شرکت را درباره رویدادی خاص مطلع کنید.

یا می‌توانید یک وب‌قلاب ایجاد کنید که کنترل‌کننده تماس برگشتی HTTP را تعریف می‌کند، سپس شرطی را که وب‌قلاب را راه‌اندازی می‌کند، همان‌طور که در راه‌اندازی اعلان‌ها بااستفاده از وب‌قلاب‌ها توضیح داده شده است، پیکربندی کنید.

کاوش صفحه اعلان‌ها

همان‌طور که در زیر توضیح داده شده است، به صفحه «اعلان‌ها» دسترسی پیدا کنید.

درحال ویرایش اعلان‌ها

برای ویرایش اعلان بااستفاده از رابط کاربری:

1. به صفحه اعلان‌ها دسترسی پیدا کنید.
2. روی در کنار اعلانی که می‌خواهید ویرایش کنید کلیک کنید تا جزئیات آن باز شود.
3. فیلدهای «موضوع»، «بدنه»، و «گیرنده» (درصورت وجود) را درصورت نیاز ویرایش کنید.

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

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

   • درحال ویرایش اعلان‌ها برای «اعلام به همه توسعه‌دهندگان»
   • درحال ویرایش اعلان‌ها برای «اعلام به توسعه‌دهندگان تحت‌تأثیر»
   • درحال ویرایش اعلان‌ها برای «ارائه‌دهندگان میانای برنامه‌سازی کاربردی»
4. با انتخاب چارگوش انتخاب مجاور آن، اعلانی را فعال کنید.
5. برای ویرایش اعلان‌های بیشتر، مراحل ۲ تا ۴ را تکرار کنید.
6. برای ذخیره کردن همه تغییرات، روی ذخیره کلیک کنید.

پیامی برای تأیید اینکه اعلان‌ها ذخیره شده‌اند نمایش داده می‌شود. عملیات ذخیره ممکن است چند دقیقه طول بکشد.

درحال ویرایش اعلان‌ها برای «اعلام به همه توسعه‌دهندگان»

اعلان‌های مربوط به انواع رویدادهایی که در بخش اعلان به همه توسعه‌دهندگان انتخاب می‌کنید به همه توسعه‌دهندگان ارسال می‌شود.

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

جدول زیر اعلان‌ها را براساس انواع رویداد در بخش «اعلان به همه توسعه‌دهندگان» فهرست می‌کند. برای اطلاعات بیشتر، ویرایش اعلان‌ها بااستفاده از واسط کاربر را ببینید.

درحال ویرایش اعلان‌ها برای «اعلام به توسعه‌دهندگان تحت‌تأثیر»

اعلان‌های مربوط به انواع رویدادهایی که در بخش اعلان به توسعه‌دهندگان تحت‌تأثیر انتخاب می‌کنید فقط برای توسعه‌دهندگانی ارسال می‌شود که تحت تأثیر آن انواع رویدادها قرار گرفته‌اند. برای مثال، اگر رویداد «طرح نرخ اصلاح‌شده» را انتخاب کنید، اعلان فقط برای توسعه‌دهندگانی که طرح نرخ را پذیرفته‌اند ارسال می‌شود.

جدول زیر اعلان‌ها را براساس انواع رویداد در بخش «اعلان به توسعه‌دهندگان تحت‌تأثیر قرارگرفته» فهرست می‌کند. برای اطلاعات بیشتر، ویرایش اعلان‌ها بااستفاده از واسط کاربر را ببینید.

درحال ویرایش اعلان‌ها برای «اعلان به ارائه‌دهندگان میانای برنامه‌سازی کاربردی»

اعلان‌های مربوط به انواع رویدادهایی که در بخش اعلان ارائه‌دهنده میانای برنامه‌سازی کاربردی انتخاب می‌کنید به ارائه‌دهنده میانای برنامه‌سازی کاربردی که مشخص کرده‌اید ارسال می‌شود.

جدول زیر اعلان‌ها را براساس انواع رویداد در بخش «ارائه‌دهنده API اعلان» فهرست می‌کند. برای اطلاعات بیشتر، ویرایش اعلان‌ها بااستفاده از واسط کاربر را ببینید.

فعال یا غیرفعال کردن اعلان

برای فعال یا غیرفعال کردن اعلان بااستفاده از واسط کاربر:

1. به صفحه اعلان‌ها دسترسی پیدا کنید.
2. با انتخاب یا لغو انتخاب کردن چارگوش کنار اعلان، آن را فعال یا غیرفعال کنید.
3. برای ذخیره کردن همه تغییرات، روی ذخیره کلیک کنید.

عملیات ذخیره ممکن است چند دقیقه طول بکشد. پیامی برای تأیید اینکه اعلان‌ها ذخیره شده‌اند نمایش داده می‌شود.

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

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

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

الگوهای اعلان را بااستفاده از API مدیریت کنید، همان‌طور که در بخش‌های زیر توضیح داده شده است:

• مشاهده همه الگوهای اعلان بااستفاده از میانای برنامه‌سازی کاربردی
• مشاهده الگوی اعلان بااستفاده از API
• ویرایش الگوی اعلان بااستفاده از میانای برنامه‌سازی کاربردی

مشاهده همه الگوهای اعلان بااستفاده از API

می‌توانید با صدور درخواست GET به /mint/organizations/{org_name}/notification-email-templates، همه الگوهای اعلانی را که درآمدزایی ارائه می‌دهد فهرست کنید. برای مثال:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/notification-email-templates" \
  -u email:password

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

{
    "createdDate" : 1376975394984,
    "htmlImage" : "<p>Dear ${developer.legalName} , ${developer.name} <br /> Introducing _________. For more details visit us at _________________</p>",
    "id" : "4d81ea64-d005-4010-b0a7-6ec8a5c3954b",
    "name" : "DEFAULT_NEW_PRODUCT_TEMPLATE",
    "orgId" : "myorg",
    "source" : "Mail Man Test",
    "subject" : "Notification of new product",
    "updatedDate" : 1376975394984
}

مشاهده الگوی اعلان بااستفاده از API

با صدور درخواست GET به /mint/organizations/{org_name}/notification-email-templates/{template_id}، که در آن {template_id} شناسه الگو است، الگوی اعلان را مشاهده کنید. برای مثال:

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-email-templates/4d81ea64-d005-4010-b0a7-6ec8a5c3954b" \
  -H "Accept:application/json"  \
  -u email:password

موارد موجود در الگوها که با $ شروع می‌شوند متغیر هستند. برای اطلاعات بیشتر، استفاده از متغیرها در الگوهای اعلان را ببینید. فرض کنید متغیرهای موجود در اعلان به مقادیر زیر ارزیابی می‌شوند:

• ${developer.legalName}.XYZ company
• ${developer.name}.DEV1
• ${QUOTA_TYPE}.Transactions
• ${PERCENT}.90%
• ${QUOTA_UNIT}.Calls
• ${QUOTA_LIMIT}.100
• ${ratePlan.monetizationPackage.products.name}.X
• ${EXPIRY_DATE}.2016-09-30

پیام اعلان ارائه‌شده توسط الگو این خواهد بود:

    "Dear XYZ company, DEV1
    You have exceeded Transactions of 90% calls of 100 calls for X product. Your API calls will be blocked till 2016-09-30"

ویرایش الگوی اعلان بااستفاده از میانای برنامه‌سازی کاربردی

الگوی اعلان را با صدور درخواست PUT به /nint/organizations/{org_name}/notification-email-templates/{template_id} ویرایش کنید. محتوای تغییریافته الگو را در بدنه درخواست ارائه دهید.

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

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

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-email-templates/4d81ea64-d005-4010-b0a7-6ec8a5c3954b " \
  -H "Content-Type: application/json" \
  -d '{
    "id" : "4d81ea64-d005-4010-b0a7-6ec8a5c3954b",
    "htmlImage" : "<p>Exciting news, we have added a new product :${Product.name}. See details in <a href="${Product.url}">New Products</a> </p>",
    "name" : "NewProductNotification",
    "organization": {
    "id": "{org_name}"
    },
    "source" : "Mail Man Test ",
    "subject" : "New Product Available: ${Product.name}"
  }' \
  -u email:password

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

شرایط و اقدامات اعلان را بااستفاده از «میانای برنامه‌سازی کاربردی» مدیریت کنید، همان‌گونه که در بخش‌های زیر توضیح داده شده است.

• ایجاد وضعیت و کنش اعلان بااستفاده از میانای برنامه‌سازی کاربردی
• مشاهده وضعیت و کنش اعلان بااستفاده از میانای برنامه‌سازی کاربردی
• ویرایش کردن وضعیت و کنش اعلان بااستفاده از میانای برنامه‌سازی کاربردی
• حذف کردن شرط و کنش اعلان بااستفاده از میانای برنامه‌سازی کاربردی

ایجاد وضعیت و کنش اعلان بااستفاده از میانای برنامه‌سازی کاربردی

شرایط و کنشی برای اعلان ایجاد کنید که با صدور درخواست POST به /mint/organizations/{org_name}/notification-conditions منجر به اعلان خودکار شود.

وقتی درخواست می‌کنید، در متن درخواست شرایطی را که منجر به اعلان می‌شود و اقداماتی را که باید هنگام رسیدن به آن شرایط انجام شود (مثلاً ارسال اعلان ایمیلی) مشخص کنید.

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

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

برای مثال، درخواست زیر مشخص می‌کند که وقتی مشخصه NEW_PRODUCT و مقدار مشخصه PUBLISHED true است، اعلان را در الگویی با شناسه 01191bf9-5fdd-45bf-8130-3f024694e63 ارسال کنید (این DEFAULT_NEW_PRODUCT_TEMPLATE است).

curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions" \
  -H "Content-Type:application/json"
  -d '{
    "notificationCondition": [
    {
      "attribute": "NEW_PRODUCT"
    },
    {
      "attribute": "PUBLISHED",
      "value": "true"
    }
    ],
    "actions": [{
      "actionAttribute": "DEV_ID",
      "value": "ANY",
      "templateId": "01191bf9-5fdd-45bf-8130-3f024694e63"
    }]
  }' \
  -u email:password

مشاهده وضعیت اعلان و کنش بااستفاده از میانای برنامه‌سازی کاربردی

با صدور درخواست GET به organizations/{org_name}/notification-conditions/{condition_Id}، وضعیت اعلان و اقدام را مشاهده کنید، که در آن {condition_Id} شناسه وضعیت است. وقتی وضعیت اعلان را ایجاد می‌کنید، شناسه برگردانده می‌شود. برای مثال:

curl -X GET "https://api.enterprise.apigee.com /v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4" \
  -H "Accept:application/json" \
  -u email:password

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

    {
    "actions" : [ {
    "actionAttribute" : "DEV_ID",
    "id" : "141ba00c-d7bd-4fef-b339-9d58b83255f4",
    "templateId" : "766aba4f-0f7a-4555-b48e-d707c48b8f4c",
    "value" : "ANY"
    }, {
    "actionAttribute" : "ORG_EMAIL",
    "id" : "21486ce1-4290-4a55-b415-165af3e93c9d",
    "templateId" : "efa4ce63-7c08-4876-984b-6878ec435994",
    "value" : "DEFAULT_LIMIT_NOTIFICATION_EMAIL"
    } ],
    "notificationCondition" : [ {
    "attribute" : "Balance",
    "id" : "2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4",
    "organization" : {
    ...
    },
    "value" : "< 0"
    } ]
    }

ویرایش کردن وضعیت و کنش اعلان بااستفاده از میانای برنامه‌سازی کاربردی

با صدور درخواست POST به organizations/{org_name}/notification-conditions/{condition_Id}، وضعیت و اقدام اعلان را ویرایش کنید، که در آن {condition_Id} شناسه وضعیت است. وقتی وضعیت اعلان را ایجاد می‌کنید، شناسه برگردانده می‌شود. وقتی درخواست را صادر می‌کنید، تغییراتی را که می‌خواهید در وضعیت یا کنش اعلان ایجاد کنید در متن درخواست مشخص کنید.

برای مثال:

   $ curl -H "Content-Type:application/json" -X POST -d \
    ' {
    "notificationCondition": [
    {
      "attribute": "NEW_PRODUCT"
    },
    {
    "attribute": "PUBLISHED",
    "value": "true"
    }
    ],
    "actions": [{
      "actionAttribute": "DEV_ID",
      "value": "ANY",
      "templateId": "01191bf9-5fdd-45bf-8130-3f024694e63"
    }]
    }' \
    "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4" \
  -u email:password

حذف وضعیت و کنش اعلان بااستفاده از میانای برنامه‌سازی کاربردی

با ارسال درخواست DELETE به organizations/{org_name}notification-conditions/{condition_Id}، شرط اعلان را حذف کنید. برای مثال:

curl -X DELETE "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4"  \
  -H "Accept:application/json"  \
  -u email:password

دارایی‌های پیکربندی برای شرایط اعلان

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

دارایی‌های پیکربندی برای کنش‌های اعلان

هنگام استفاده از API، ویژگی‌های پیکربندی زیر برای کنش‌های اعلان دردسترس است.

استفاده از متغیرها در الگوهای اعلان

وقتی پیام را در الگوی اعلان ویرایش می‌کنید، می‌توانید یک یا چند متغیر را بااستفاده از «زبان عبارت بهاری» (SpEL) اضافه کنید تا مقادیر برگشتی در شیء «تراکنش» را نشان دهید.

جدول زیر متغیرهای الگوی اعلان پرکاربرد را خلاصه می‌کند.

سفارشی‌سازی نشانی ایمیل پاسخ به

برای درآمدزایی، نشانی noreply@apigee.com پیش‌فرض برای استفاده در اعلان‌های ایمیلی که به شرکت‌ها و توسعه‌دهندگان ارسال می‌شود پیکربندی شده است. برای پیکربندی نام و نشانی پاسخ سفارشی برای سازمانتان، با «پشتیبانی Apigee» تماس بگیرید.