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

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

قالب‌های اعلان چیستند؟

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

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

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

بررسی صفحه اعلان‌ها

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

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

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

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

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

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

   • ویرایش اعلان‌ها برای اطلاع‌رسانی به همه توسعه‌دهندگان
   • ویرایش اعلان‌ها برای اطلاع‌رسانی به توسعه‌دهندگان آسیب‌دیده
   • ویرایش اعلان‌ها برای اطلاع‌رسانی به ارائه‌دهندگان API
4. با انتخاب کادر کنار اعلان، آن را فعال کنید.
5. برای ویرایش اعلان‌های اضافی، مراحل ۲ تا ۴ را تکرار کنید.
6. برای ذخیره همه تغییرات، روی ذخیره کلیک کنید.

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

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

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

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

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

ویرایش اعلان‌ها برای اطلاع‌رسانی به توسعه‌دهندگان آسیب‌دیده

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

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

ویرایش اعلان‌ها برای اطلاع‌رسانی به ارائه‌دهندگان API

اعلان‌ها برای انواع رویدادهایی که در بخش Notify API Provider انتخاب می‌کنید، به ارائه‌دهنده API که مشخص می‌کنید ارسال می‌شوند.

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

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

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

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

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

تنظیم اعلان‌ها با استفاده از قالب‌ها با استفاده از API

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

مدیریت قالب‌های اعلان با استفاده از API

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

• مشاهده تمام قالب‌های اعلان با استفاده از 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"

ویرایش قالب اعلان با استفاده از API

با ارسال یک درخواست 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

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

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

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

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

یک شرط اعلان و یک اقدام ایجاد کنید که با ارسال یک درخواست 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

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

با ارسال یک درخواست 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"
    } ]
    }

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

با ارسال یک درخواست 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

حذف یک شرط و اقدام اعلان با استفاده از API

با ارسال درخواست 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)، یک یا چند متغیر را برای نمایش مقادیر برگردانده شده در شیء تراکنش (Transaction) وارد کنید.

جدول زیر خلاصه‌ای از رایج‌ترین متغیرهای قالب اعلان را نشان می‌دهد.