収益化の設定手順

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 Edge データを収益化と同期するで説明されているように、Apigee サポートから組織の同期をリクエストされる場合があります。Apigee から指示がない限り、収益化データを同期しないでください。

収益化を構成する

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

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

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

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

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

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

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

API を収益化する

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

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

次の表に、API を収益化するために必要な手順を示します。

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

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

注: 従来の 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 プロダクト、デベロッパー、アプリケーションを同期できます。
組織から収益化データを削除する テスト組織を消去したり、組織を削除したりするために、組織から収益化データを削除する場合があります。