収益化の設定手順

Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントに移動します。 情報

始める前に

Apigee 組織で収益化の使用を開始する前に、次の前提条件タスクを行う必要があります。

  • Apigee Edge アカウントを作成するの説明に沿って、Apigee Edge アカウントを作成します。
  • 収益化を購入します。Edge には、当初は収益化 API は含まれておらず、収益化は管理 UI に統合されていません。収益化 API と収益化 UI コンポーネントを Apigee 組織の Edge に組み込むには、収益化機能を購入する必要があります。

収益化を購入したら、次のタスクを行う必要があります。

Apigee の初期設定

Apigee Edge 構成チームと協力して、収益化の初期設定を完了します。入力に基づいて、構成チームが次の設定を行います。

  • 組織が通信会社であるかどうか。
  • 料金プランを購入するデベロッパーに対してサポートする請求タイプ（前払い、後払い、または両方）。前払いアカウントと後払いアカウントをご覧ください。
  • 会計システムに収益化から抽出したデータを詳細に表示するか、概要を表示するか、必要なデータ形式。
  • カスタムのメール返信アドレス。企業とデベロッパーに送信される収益化メール通知には、デフォルトの noreply@apigee.com アドレスが構成されています。組織のカスタム返信名とアドレスをリクエストする必要があります。

Apigee 構成チームがスクリプトを実行して、収益化を組織と、Apigee Edge を使用して作成したデベロッパー、アプリケーション、API プロダクトと同期します。Apigee サポートから、今後組織の同期を求められることがあります。詳細については、Apigee Edge データを収益化と同期させるをご覧ください。Apigee から指示がない限り、収益化データを同期しないでください。

収益化を構成する

次の表に、Apigee 組織で収益化を構成するために必要な手順の概要を示します。
ステップ 説明
組織のプロフィールを編集する 収益化の初期設定の一環として、Apigee Edge 構成チームが組織プロファイルを設定します。

必要に応じて、組織のプロフィールを編集して、組織に関する情報を追加または更新する必要があります。たとえば、請求タイプ、通貨設定、税モデルの更新が必要になることがあります。
サポートされる通貨を管理する 収益化の初期設定の一環として、Apigee Edge 構成チームは組織でサポートされている通貨を指定し、デフォルトの通貨を設定します。

組織がサポートする通貨を取得し、サポートされている通貨を追加または削除できます（デベロッパーまたは料金プランで使用される通貨を反映するため）。

注: 収益化では、サポートされている各通貨の米ドルでの為替レートを取得するジョブが毎日自動的に実行されます。デフォルトでは、ジョブは毎日午前 0 時 1 秒に実行されます。詳しくは、収益化ジョブのスケジュールを設定するをご覧ください。
利用規約を指定する 必要に応じて、料金プランを公開する前に、利用規約を組織のプロフィールに追加できます。料金プランを公開すると、利用規約の現在のバージョンがデベロッパー ポータルに表示されます。

注: 利用規約は組織プロファイルの外部にあります。組織のプロフィールで、利用規約の場所（公開 URL）を指定します。利用規約の複数のバージョンを追加して、時間の経過に伴う変更を反映できます。
収益化の上限を適用する MonetizationLimitsCheck ポリシーを API プロキシに接続して、収益化の上限を適用します。

具体的には、このポリシーは次の条件の下でトリガーされます。

  • 収益化対象の API を利用するデベロッパーが登録されていないか、料金プランに加入していない。
  • デベロッパーが、定期購入した料金プランのトランザクション ボリュームを超過した。
  • デベロッパーの前払いアカウント残高に達したか、後払い利用限度額に達した。
通知を設定する 通知を構成して、デベロッパーや API プロバイダに特定のイベント（新しく公開された料金プランなど）を通知します。

API を収益化する

API を収益化する場合は、1 つ以上の API プロダクトを API プロダクト バンドルにバンドルし、関連する料金プランを定義します。

API プロダクト バンドルは、パッケージの料金プラン（開始日が現在の日付または将来の日付）を公開するまで、デベロッパーに表示されません。デベロッパーは、現在有効なレートプランのいずれかを購入することによってのみ、API プロダクト バンドルを使用するアプリを登録できます。API プロダクト バンドルに現在有効な公開済み料金プランがない場合、パッケージは収益化されません。

次の表は、API を収益化するために必要な手順をまとめたものです。

ステップ 説明
API プロダクト バンドルを管理する

API プロダクトをグループ化する API プロダクト バンドルを作成します。

注: Classic Edge UI と Monetization API では、プロダクト バンドルは API パッケージと呼ばれます。

API を使用して API プロダクト バンドルを管理するには、以下をご覧ください。
トランザクション記録ポリシーを構成する

各 API プロダクトのトランザクション記録ポリシーを構成します。トランザクション記録ポリシーは、カスタム属性など、API プロダクトのトランザクション レコードにキャプチャする内容を定義します。

API を使用してトランザクション記録ポリシーを構成するには、以下をご覧ください。
料金プランの管理と公開

料金プランを作成して、API の収益化アプローチを定義します。たとえば、API の使用に対して固定料金を請求するか、変動料金を請求するかなどです。

API を使用して料金プランを管理するには、以下をご覧ください。
公開済みの料金プランを購入する API を使用して、公開された料金プランを購入し、必要に応じて購入した料金プランの有効期限を設定または解約します。
デベロッパー ポータルで収益化を構成する デベロッパー ポータルで収益化を構成して、料金プランの登録、自動支払い処理と請求、レポート、プロダクト カタログ、その他の収益化固有の設定に開発者がセルフサービス プランにアクセスできるようにします。

管理: 収益受け取り

収益化を構成して API を収益化したら、次の表にまとめた手順を 1 つ以上実行できます。

ステップ 説明
企業とデベロッパーを管理する API を使用する企業とデベロッパーを管理する。デベロッパーは単一のエンティティであり、メールアドレスで一意に識別されます。カンパニーは、1 つのエンティティとして管理されるデベロッパーの集まりです。
レポートを作成する プリペイド残高、収益、差異のレポートを作成します。前払いデベロッパーの場合、プリペイド残高レポートと銀行振込を照合できます。
請求の調整を行う たとえば、記録の不一致を修正するために請求の調整を行います。
クレジットを発行する 必要に応じて、デベロッパー クレジットを発行します。前払いデベロッパーの場合、クレジットは使用量の削減として表示され、デベロッパーのプリペイド残高が増加します。後払いデベロッパーの場合、クレジットは請求書の別の行に表示され、請求書の請求額が減額されます。
前払い残高を管理する 現在のプリペイド アカウントの残高を確認し、プリペイド アカウントにチャージしたり、サードパーティの支払いプロバイダを使用して自動チャージを設定したりできます。
利用限度額を使用して後払い残高を管理する 組織でサポートされている通貨を追加すると、後払いデベロッパーのクレジット上限を設定できます。クレジット上限は、組織内のすべての後払いデベロッパーに適用されます。また、個々の後払いデベロッパーのクレジットの上限を設定することもできます。この場合、利用限度額は、指定されたデベロッパーの通貨に設定された上限のみをオーバーライドします。
払い戻し後の対応 購入取引の払い戻しをデベロッパーに投稿します。
収益化ジョブをスケジュール設定する Monetization には、ジョブ スケジューラと所定の時間に実行されるジョブが用意されています。API を使用して収益化ジョブのスケジュールを管理します。
取引のステータスを表示する API を使用して、指定した期間に発生した取引のステータスを表示します。
Apigee Edge データを収益化と同期させる Apigee から指示された場合は、データが同期されていることを確認するために、データを収益化と再同期します。組織、API プロダクト、デベロッパー、アプリケーションを同期できます。
組織から収益化データを削除する テスト組織をクリアしたり、組織を削除したりするために、組織の収益化データを削除することがあります。