収益化の設定手順

現在、Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントをご確認ください。 情報

始める前に

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

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

収益化サービスの購入後、次のタスクを行う必要があります。

Apigee での初期設定

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

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

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

収益化を構成する

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

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

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

注: Monetization では、サポートされている各通貨の米ドルでの為替レートを取得するジョブが毎日自動的に実行されます。デフォルトでは、ジョブは毎日午前 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 を使用する企業とデベロッパーを管理しました。デベロッパーとは、メールアドレスで一意に識別される単一のエンティティです。会社とは、単一のエンティティとして管理される開発者の集まりです。
レポートを作成する 前払い残高、収益、差異に関するレポートを作成します。プリペイド デベロッパーは、前払い残高レポートと銀行預金との照合を行うことができます。
請求額の調整 請求額の調整を行って、記録の不一致を修正するなどします。
クレジットを発行する 必要に応じて、デベロッパー クレジットを発行します。前払いのデベロッパーの場合、クレジットは使用量が減少したものとして表示され、その分はデベロッパーの前払い残高を増やします。後払い方式のデベロッパーの場合、クレジットは請求書に個別の行として表示されるため、請求書の請求額が減ります。
前払い残高を管理する 現在の前払い済みアカウントの残高を表示し、前払い済みアカウントを再読み込みするか、サードパーティの決済機関を使用して自動再読み込みを設定します。
利用限度額を使用した後払い残高の管理 組織でサポートされている通貨を追加する際に、後払い式デベロッパーの利用限度額を設定できます。利用限度額は、組織内のすべての後払いデベロッパーに適用されます。 また、個々の後払いデベロッパーの利用限度額を設定することもできます。この場合、指定したデベロッパーのみに対して設定された通貨の上限が利用限度額よりも優先されます。
払い戻しを行う 購入取引のデベロッパーへの払い戻しを行います。
収益化ジョブをスケジュールする Monetization には、ジョブ スケジューラと、指定された時間に実行されるように事前にスケジュールされているジョブのセットが用意されています。API を使用して収益化ジョブ スケジュールを管理します。
取引のステータスを確認する API を使用して、指定した期間内に発生したトランザクションのステータスを表示します。
Apigee Edge データを収益化と同期させる Apigee から指示があった場合は、データを収益化用に再同期して、データが確実に同期されるようにします。組織、API プロダクト、デベロッパー、アプリケーションを同期できます。
組織から収益化データを削除する テスト組織のクリアや、組織の削除を行うには、組織から収益化データを削除してください。