設定限制通知

您目前查看的是 Apigee Edge 說明文件。
前往 Apigee X 說明文件。 info

簡介

您可以設定營利相關限制，詳情請參閱「使用營利限制檢查政策強制執行營利限制」。您也可以設定自動通知，在達到或即將達到限制時，提醒開發人員和/或貴機構的使用者。

您可以為自訂限制和隱含限制設定自動通知。舉例來說，系統會為預付型開發人員設定隱含限制，也就是他們的預付餘額。您可以設定自動通知，在開發人員的預付餘額即將用盡或已用盡時通知他們。

工具箱

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

如果您使用 API，請編輯營利提供的通知範本，為限制設定自動通知。接著，指定導致傳送通知的條件，通知內容由編輯後的範本提供。

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

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

  2. 選取通知層級。這是以絕對值或限制基準百分比為準的門檻。選取：
    • 從下拉式選單中選取大於或等於符號 (?) 或小於或等於符號 (?)。
    • 整數 (即不得有小數點)。絕對值 (表示數值) 或百分比 (表示百分比值)。如果是百分比限制，請務必將限制設為「>」，也就是說，當開發人員達到或超過該百分比時，系統就會傳送通知。

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

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

    電子郵件收件者：只有在將「開發人員限制」條件設為「任何」或特定開發人員時，您才能傳送通知給開發人員。如果您選取「任何」，電子郵件地址清單中會顯示「所選開發人員 (任何)」。也就是說，營利功能會將通知傳送給所有受影響的開發人員。如果您選取特定開發人員，電子郵件地址清單中會顯示「已選取開發人員 ({developer_id})」，其中 {developer_id} 是所選開發人員的識別資訊。營利功能只會傳送通知給該特定開發人員。

    如果沒有選取「任何」開發人員限制條件或特定開發人員，您就不會在「傳送電子郵件給」欄位中看到「選取的開發人員 (任何)」。不過，您可以選擇要通知貴機構的哪些使用者。

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

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

    • 通知層級。
    • 限制是否為停止執行限制。
    • 電子郵件的收件者是機構使用者、開發人員，還是兩者皆是。

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

    • 已勾選「停止執行」核取方塊。
    • 通知層級為 100% 或與限制相同。
    • 這封電子郵件僅供機構使用者參考。

    範本如下所示：

    假設開發人員的公司名稱為「XYZ company」，名為「X Package」的 API 套件和名為「Y Product」的 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 設定用量限制通知

營利功能提供一系列範本，可為各種通知提供文字，包括限制通知，以及臨時通知，例如提醒開發人員有新產品推出。您可以視需求調整這些範本。如要設定自動通知，請先編輯適當的範本。接著指定條件，當符合條件時，系統就會傳送您在編輯範本時提供的通知。詳情請參閱「使用通知範本設定通知」。

後續步驟

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