Monetization レポートの生成

このページの内容は Apigee と Apigee ハイブリッドに該当します。

Apigee Edge のドキュメントを表示する。

Apigee のカスタム レポート機能を使用すると、レポートを生成して、API の収益化情報を表示できます。このレポートを生成するには、次のセクションで説明するように、Apigee UI、Stats API、または Query API を使用します。

収益化の指標と分割項目

Apigee には、次の収益化の指標と分割項目が用意されています。

  • API プロキシを使用するトランザクションの指標と分割項目
  • 料金ベースのトランザクションの指標と分割項目

API プロキシを使用するトランザクションの指標と分割項目

次の表に、API プロキシを使用したトランザクションで使用できる x_apigee_mintng_* の指標と分割項目をリスト表示します。

  • 指標
    UI での名前 API での名前 説明
    API 料金の乗数 x_apigee_mintng_price_multiplier トランザクションごとの費用にかける係数（乗数）。
    デベロッパーへの収益分配率 x_apigee_mintng_dev_share トランザクションの収益におけるデベロッパーのシェア。
    収益化の金額 x_apigee_mintng_price トランザクションの総収益。
    収益化率 x_apigee_mintng_rate トランザクションに対して課金される料金。
  • 分割項目
    UI での名前 API での名前 説明
    収益の通貨 x_apigee_mintng_currency トランザクション収益の通貨。
    トランザクションの成功 x_apigee_mintng_tx_success トランザクションの収益化ステータス。

料金ベースのトランザクションの指標と分割項目

次の表に、料金ベースのトランザクションでのみ使用できる指標と分割項目を示します。

  • 指標
    UI での名前 API での名前 説明
    料金 fees 設定料金、定期的な料金、前払い追加料金の金額。
  • 分割項目
    UI での名前 API での名前 説明
    API プロダクト api_product 設定費用、定期的料金、前払い追加料金が適用される料金プランに対応する API プロダクト。前払い追加料金の場合、値は空です。
    デベロッパーのメール developer_email 設定費用、定期的料金、前払い追加料金で課金されるデベロッパー。
    料金タイプ fees_type 料金のタイプ。設定料金、定期的な料金、前払い追加料金があります。この分割項目を fees 以外の指標で使用すると、null になります。
    期間の終了 period_end

    現在、Apigee 組織で使用できます。Apigee ハイブリッド組織では使用できません。

    定期的な料金が請求される期間の終了。たとえば、月額料金の場合、これは月の最後の日です。
    期間の開始 period_start

    現在、Apigee 組織で使用できます。Apigee ハイブリッド組織では使用できません。

    定期的な料金が請求される期間の開始。たとえば、月額料金の場合、これは月の初日です。
    収益の通貨 x_apigee_mintng_currency 設定料金、定期的な料金、前払い追加料金の通貨。
    料金プラン ID。 x_apigee_mintng_rate_plan_id

    現在、Apigee 組織で使用できます。Apigee ハイブリッド組織では使用できません。

    アプリ デベロッパー向けの収益化率料金プラン。

これらの指標と分割項目の詳細については、分析の指標、分割項目、フィルタのリファレンスをご覧ください。

次のサンプル カスタム レポートは、すべてのデベロッパー アプリの収益化率の合計を示しています。

収益化率の合計を示すカスタム レポートの結果

このサンプルでは、デベロッパー アプリごとに、1-Apr-2021 to 15-Apr-2021 からのすべてのトランザクションの合計費用が表示されます。費用は、料金プランで構成された使用量に基づく料金に基づいて計算されます。この例で、指標（x_apigee_mintng_rate）は収益化フィールドですが、分割項目（developer_app）は非収益化フィールドです。そのため、要件に基づいて、収益化フィールドと非収益化フィールドの両方を組み合わせてレポートを生成できます。

フィルタを使用して、指標の特性に基づいて結果を制限することもできます。

収益化分析データのエクスポート

Apigee では、収益化分析データをエクスポートするために追加の手順を実行する必要はありません。分析データをエクスポートすると、Apigee は次の収益化フィールドと通常の分析データをエクスポートします。料金ベースのトランザクションと API プロキシを使用するトランザクションを一緒にエクスポートする場合、各レコードは共通の指標と分割項目でエクスポートされ、他の（関係のない）指標と分割項目は NULL に設定されます。
  • client_received_start_timestamp
  • period_end
  • period_start
  • x_apigee_mintng_currency
  • x_apigee_mintng_dev_share
  • x_apigee_mintng_price
  • x_apigee_mintng_price_multiplier
  • x_apigee_mintng_rate
  • x_apigee_mintng_rate_plan_id
  • x_apigee_mintng_tx_success