本頁面由 Cloud Translation API 翻譯而成。

設定可調整的通知計畫

您正在查看 Apigee Edge 說明文件。
前往 Apigee X 說明文件。info

簡介

在可調整的通知計畫中，API 供應商可以調整每位應用程式開發人員的交易目標數量。您可以根據達到目標數字的百分比 (例如 90%、100% 或 150%)，設定是否傳送通知以及傳送時間。達到目標數量後，系統不會封鎖其他交易。

使用 UI 設定可調整的通知方案

如下所述，設定可調整的通知計畫。

Edge

如要使用 Edge UI 設定可調整的通知費率方案，請在新增或編輯費率方案時，選取「可調整的通知」費率方案類型，然後在「可調整的通知」部分設定下列資訊：

欄位	說明	預設
計算頻率	計算交易量 (或自訂屬性相關數量) 的期間。選取月數 (1 到 24 個月)。	1 個月

如果您為 API 產品定義了自訂屬性，可以設定自訂評分參數，根據自訂屬性定義交易計數器。

例如，您可能需要：

根據 API 呼叫訊息中提供的值，向開發人員收取可變金額。
舉例來說，您可以依據 API 要求中傳輸的位元組數，向應用程式開發人員收費。
將多個 API 呼叫合併為單一交易。
在這種情況下，請選取「使用自訂評分參數」，然後從下拉式清單中選取自訂屬性。

詳情請參閱使用自訂屬性設定費率方案。

Classic Edge (Private Cloud)

如要使用 Edge 傳統版 UI 設定可調整的通知方案，請按照下列步驟操作：

在「費率方案」視窗的「方案詳細資料」分頁中，選取「費率方案類型」欄位中的「可調整的通知」。
如要瞭解如何存取「費率方案」視窗，請參閱「使用 UI 建立費率方案」。

注意：選取「可調整通知」類型後，「費用」和「免費增值」分頁會顯示為灰色，因為這些分頁不適用於可調整的通知方案。
將「續約期」欄位設為方案自動續約的月份數 (除非開發人員在該日期之前終止協議)。如果將這個值設為 0，則在開發人員選擇結束前，這個方案會持續生效。
按一下「Generic Rate Plan」下方的「Details」。
將「匯總依據」設為匯總交易量所涵蓋的時間範圍。請選取 1 到 24 個月的數字。這個值預設為 1 個月。
按一下「套用並關閉」。
按一下「儲存草稿」。
只有在確定計畫內容不會再變動時，才發布計畫。如要瞭解如何設定發布日期和發布方案，請參閱「發布費率方案」。

房價方案發布後，你只能修改結束日期。費率方案發布後即無法刪除，但可以過期並替換為未來的費率方案，如「過期已發布的費率方案」一節所述。

使用 API 設定可調整的通知方案

在 /organizations/{org_name}/monetization-packages/{package_id}/rate-plans 的 POST 要求中，於要求主體的 ratePlanDetails 屬性中指定可調整的通知計畫詳細資料。

如要指定可調整的通知方案，請在要求主體的 ratePlanDetails 中指定下列值：

屬性	值
`type`	請設為 `USAGE_TARGET`。
`meteringType`	請設為 `DEV_SPECIFIC`。
`duration`	與 `durationType` 一併設定匯總依據的時間範圍。如果是可調整的通知頻率方案，請將此值設為介於 1 和 24 之間的整數值。
`durationType`	與 `durationType` 一併設定匯總依據的時間範圍。如為可調整的通知費率方案，請將這個值設為 `MONTH`。

如要進一步瞭解在指定可調整的通知方案詳細資料時，可以設定哪些組態屬性，請參閱「費率方案詳細資料組態設定」。

舉例來說，以下定義了可調整的通知計畫，其中匯總基準設為 1 個月。

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "AdjustableNotification",
     "displayName": "Adjustable notification plan",
     "description": "Adjustable notification plan",
     "published": "true",  
     "organization": {
      "id": "myorg"
     },
     "startDate": "2016-04-15 00:00:00",
     "type": "STANDARD",
     "monetizationPackage": {
        "id": "p1",
        "name": "test"
     },
     "currency": {
        "id" : "usd",
        "name" : "USD"
     },
     "ratePlanDetails": [
        {
           "type": "USAGE_TARGET",
           "meteringType": "DEV_SPECIFIC",
           "duration": 1,
           "durationType": "MONTH",
           "ratingParameter": "VOLUME",
           "organization": {
             "id": "myorg"
           },
           "currency": {
             "id": "usd",
             "name": "USD"
           }
        }
     ]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/p1/rate-plans"  \
-u email:password

使用 API 為每位應用程式開發人員設定交易目標數量

對於已接受可調整通知費率方案的每位應用程式開發人員，您都需要設定交易目標數量。您可以設定是否要根據達到目標數字的百分比 (例如 90%、100% 或 150%) 來決定是否傳送通知。達到目標數量後，系統不會封鎖其他交易。

開發人員接受費率方案後，您可以為其設定交易目標數量，日後也可以更新該值。

接受費率方案時設定交易目標數量

接受費率方案時，如要設定目標交易次數，請在 POST 要求中為 /organizations/{org_name}/developers/{developer_id}/developer-rateplans 資源指定要求主體中的 quotaTarget 屬性。將 quotaTarget 設為正整數或 0，即可停用應用程式開發人員的通知。如未指定，quotaTarget 預設為 0。

舉例來說，當應用程式開發人員接受可調整的通知方案時，系統會使用下列要求將交易目標數量設為 4000。

$ curl -H "Content-Type:application/json" -X POST -d \
'{ 
   "developer":{
     "id":"dev@mycompany.org"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2016-03-24 00:00:00",
   "quotaTarget": 4000,
   "suppressWarning": false
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \
-u email:password

在更新接受的費率方案時設定目標交易次數

如要設定目標交易次數，您可以更新接受的費率方案，並在 PUT 要求中要求主體中的 quotaTarget 屬性為 /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{developer_rateplan_id} 資源。將 quotaTarget 設為正整數或 0，即可停用應用程式開發人員的通知。如未指定，quotaTarget 預設值為 0。

您接受發布的費率方案後，系統會在回應中傳回 {developer_rateplan_id}。

例如：

{
  "created": "2016-03-31 18:59:54",
  "developer": {
    ...
  },
  "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
  "quotaTarget": 3000,
  "ratePlan": {
    ...
  },
  "startDate": "2016-03-31 00:00:00",
  "updated": "2016-03-31 18:59:54",
  "waiveTerminationCharge": false
}

或者，您也可以向 /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans 發出 GET 要求，取得開發人員費率方案的 {developer-rateplan-id}，其中 {developer_id} 是開發人員的電子郵件地址。詳情請參閱「查看開發人員接受的所有費率方案」。

例如：

{
  "developerRatePlan": [
    {
      "created": "2016-03-31 14:52:30",
      "developer": {
        ...
      },
      "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
      "quotaTarget": 3000,
      "ratePlan": { 
        ... 
      }, 
      "startDate": "2016-03-31 00:00:00", 
      "updated": "2016-03-31 18:59:54" 
    } 
  ], 
  "totalRecords": 1 
}

以下要求會將交易目標數量更新為 4000。

$ curl -H "Content-Type:application/json" -X PUT -d \
'{ 
   "id" : "b1c600b8-f871-496d-8173-12b9950d6ab1",
   "developer":{
     "id":"dev@mycompany.com"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2016-04-15 00:00:00",
   "quotaTarget": 4000,
   "suppressWarning":false
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/b1c600b8-f871-496d-8173-12b9950d6ab1"
-u email:password