設定限制通知

您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件。 資訊

簡介

您可以按照使用營利限制檢查政策強制執行營利限制政策，設定營利相關限制。您也可以設定自動通知，在即將達到或達到上限時通知機構內的開發人員和/或使用者。

您可以為自訂限制和隱含限制設定自動通知。舉例來說，系統會為預付型開發人員設定隱含限制，也就是預付餘額。您可以設定自動通知，讓開發人員在接近預付餘額或已經達到預付餘額時收到通知。

工具箱

您可以透過管理 UI 或營利 API 為限制設定自動通知。如果您使用 UI，可以在「通知」頁面設定自動通知。

如果您使用 API，可以編輯營利提供的通知範本，藉此針對限制設定自動通知。然後指定特定條件，進而傳送編輯後範本提供的通知。

透過使用者介面設定限制通知

  1. 在「新增限制」頁面的「通知」區段中按一下「新增」。「通知」部分隨即開啟。

  2. 選擇通知的等級。這個門檻以絕對值或限制基礎的百分比值為依據。選取：
    • 下拉式選單中的符號 (?) 或小於或等於 (?) 符號。
    • 整數 (不接受小數點)。「絕對」(表示數值) 或「百分比」來表示百分比值。如為百分比限制，請務必確保將限制設為 >，這表示當開發人員達到或超過該百分比時，通知就會傳送。

    舉例來說，如果您將支出上限設為 $100 美元，並將通知設為大於或等於 90%，系統會在達到或超過上限的 90% ($90) 時傳送通知。

  3. 在「傳送電子郵件」欄位中，選取一或多位開發人員，或選取貴機構的一或多位使用者。系統會將通知傳送給受影響的開發人員或使用者。

    電子郵件收件者：您必須將開發人員限制條件設為「不限」，或是為特定開發人員設定開發人員限制條件，才能傳送通知給開發人員。如果您選擇「不限」，電子郵件地址清單中會顯示「已選取的開發人員 (任何)」。這表示任何受影響的開發人員都會收到營利通知。如果您選取了特定開發人員，電子郵件地址清單內會顯示「已選取的開發人員 ({developer_id})」圖示 (其中 {developer_id} 是所選開發人員的識別身分)。營利設定只會傳送通知給該特定開發人員，

    如果您未將開發人員限制條件設為「不限」或特定開發人員，「傳送電子郵件」欄位中就不會出現「已選取的開發人員 (不限)」。不過，您可以選擇要通知貴機構的哪些使用者。

    如要為貴機構的使用者新增電子郵件地址，請在「管理」分頁中選取「機構使用者」。

    電子郵件範本：在「傳送電子郵件」欄位「所選開發人員 (不限)」或貴機構使用者 (或兩者) 中，選取電子郵件範本後，就會看到電子郵件範本。範本中顯示的內容取決於下列因素：

    • 通知的層級。
    • 表示限制是否為暫停執行限制。
    • 電子郵件的適用對象為機構使用者和/或開發人員。

    舉例來說，如果符合下列所有條件：

    • 已勾選「暫停執行」核取方塊。
    • 通知層級為 100% 或等於上限的金額。
    • 電子郵件僅適用於機構使用者。

    範本如下所示：

    假設開發人員的公司名稱為「XYZ 公司」，針對名為「X 套件」的 API 套件和名為「Y 產品」的 API 產品，交易量上限設為 50，到期日為 2013 年 9 月 30 日。傳送的電子郵件看起來會像這樣：

    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

    如果電子郵件是「已選取的開發人員 (任何)」，範本會如下所示：

    這兩個範本都會解析相關變數，例如開發人員名稱 (如適用)、套件名稱 (如適用) 和產品名稱 (如適用)。您可以按一下範本左側的「編輯」，依需求編輯訊息。

    如果限制適用於「不限」或特定應用程式，以及「不限」或特定使用者，您還必須在範本中新增應用程式和使用者變數。您可以按照下列步驟進行：

    • 按一下範本左側的 [編輯]。
    • 新增 ${user.name} user, depending on whether the limit is for application and/or user.

    以下顯示編輯為「不限」或特定應用程式的範本。

    如未檢查暫停執行作業，或是通知等級大於或等於 100%，所選開發人員的範本將如下所示：

    再次提醒您，如果限制是「不限」(或特定) 應用程式，或「不限」(或特定) 使用者，您需要編輯範本，然後新增 ${application.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 設定限制通知

營利服務提供的一組範本，可為各種類型的通知提供文字，包括限制通知和臨時通知，例如提醒開發人員有新產品供應情形。您可以根據自己的需求自訂任一範本。如要設定自動限制通知，請先編輯適當的範本。然後指定會導致系統傳送編輯範本所提供通知的條件。詳情請參閱「使用通知範本設定通知」。

後續步驟

瞭解如何設定自動通知，以向開發人員告知新產品、新版條款及細則或新費率方案等活動。請參閱「使用通知範本設定通知」。