現在、Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントをご確認ください。 情報
Monetization Limits Check ポリシーを API プロキシに追加して、収益化の上限を適用します。具体的には、ポリシーは次の条件でトリガーされます。
- 収益化対象の API にアクセスするデベロッパーが登録されていないか、料金プランに加入していない。
- デベロッパーが、契約した料金プランの取引量を超過しました。
- デベロッパー アカウントの前払い残高または後払い利用限度額に達している。
Monetization Limits Check ポリシーは、上記のような状況でエラーが発生して API 呼び出しをブロックするように設計されています。このポリシーは Raise Fault ポリシー（Raise Fault ポリシーを参照）を拡張し、返されるメッセージをカスタマイズできます。適用可能な条件は、ビジネス変数から得られます。
UI を使用して Monetization Limits Check ポリシーを接続する
収益化の上限を適用するには、API にアクセスする API プロキシのリクエスト フローに Monetization Limits Check ポリシーを接続する必要があります。Monetization Limits Check ポリシーは、リクエスト内の VerifyAPIKey ポリシーまたは AccessTokenValidation ポリシーの後に接続する必要があります。
Monetization Limits Check ポリシーは、API プロキシの作成時に、または作成後に接続できます。
シンプルな API プロキシをビルドするで説明されているように、API プロキシを作成する際に Monetization がインストールされている場合、ウィザードに Monetization の構成セクションが表示されます。
エッジ
ウィザードの [一般的なポリシー] ページで、[収益化の上限を適用する] チェックボックスをオンにして、収益化の上限のチェック ポリシーをアタッチします。
ウィザードの [Summary] ページに、ポリシーの概要が表示されます。後述のように、Monetization Limits Check ポリシーが API プロキシに接続されることを示す、Monetization ポリシーがリストされていることを確認します。
従来の Edge（Private Cloud）
ウィザードの [セキュリティ] ページで、[収益化制限のチェックを有効にする] チェックボックスをオンにして、収益化制限のチェック ポリシーをアタッチします。
次の図に示すように、Monetization Limits Check ポリシーは、ProxyEndpoint リクエスト PreFlow の VerifyAPI Key ポリシーまたは AccessTokenValidation ポリシーの後に追加されます。
作成済みの API プロキシに Monetization Limits Check ポリシーを追加するには:
- API プロキシ エディタで、デフォルトのプロキシ エンドポイントの [PreFlow] をクリックします。
- [Request Flow] で [+Step] をクリックします。
- [メディエーション] カテゴリで [収益化制限のチェック] を選択します。
- 必要に応じて [Add Step] ダイアログのフィールドを変更し、[Add] をクリックします。
このポリシーは、VerifyAPI Key ポリシーまたは AccessTokenValidation ポリシーの後にリクエスト フローに接続され、クライアント アプリから ProxyEndpoint PreFlow へのリクエスト メッセージに適用されます。
MonetizationLimitsCheck ポリシー XML ファイルの構成の詳細については、MonetizationLimitsCheck ポリシーをご覧ください。