収益化データの取得

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

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

Apigee は、収益化変数を使用してレーティング、収益分配の計算、分析を行います。Apigee アナリティクスに収益化情報を表示する場合。収益化変数を使用して、トランザクションの収益化機能を強化できます。

収益化変数

収益化変数名は事前定義されているため、変数の作成、編集、削除はできません。リクエスト変数またはレスポンス変数のいずれかを収益化変数に割り当てることができます。

次の表では、Apigee で使用可能な収益化変数を示します。

収益化変数	データ型	説明
currency	文字列	トランザクションからの収益の計算で使用する通貨を指定します。
perUnitPriceMultiplier	浮動小数点数	トランザクションごとの費用にかける係数（乗数）を指定します。トランザクションごとの費用は、料金プランの使用量に基づく料金で指定されます。乗算は、トランザクションが収益化可能な場合にのみ実行されます。次のいずれかの条件が満たされている場合、トランザクションは収益化可能です。 `transactionSuccess` 変数が `true` の場合。 `transactionSuccess` 変数が `NULL` で、`message.status.code` が `2xx` の場合（成功）。
revShareGrossPrice	浮動小数点数	デベロッパーのシェアの計算で使用するトランザクションの収益を指定します。デベロッパーのシェアは、料金プランで収益分配を有効にした場合にのみ計算されます。
transactionSuccess	ブール値	トランザクションを収益化するかどうかを指定します。変数が `true` に設定されている場合、トランザクションは収益化されます。変数が `false` に設定されている場合、トランザクションは収益化されません。この変数を指定しない場合、`message.status.code` 変数で使用可能な HTTP ステータスコードの値に基づいてトランザクションが収益化されます。レスポンスの HTTP ステータスコードが NULL または 300 以上の場合、トランザクションは収益化されません。それ以外のステータスコードの場合、トランザクションは収益化されます。注: `transactionSuccess` の値がブール値以外である場合、DataCapture ポリシーでは `mint.tx_success_result` 変数を `false` と判定します。

値の割り当て例

次の例は、収益化変数に値を割り当てる方法を示しています。

currency

次の例では、レスポンスの booking[0].currency JSON 要素の値を currency 変数に割り当てています。

<Capture>
  <Collect>
    <Source>response</Source>
    <JSONPayload>
      <JSONPath>booking[0].currency</JSONPath>
    </JSONPayload>
  </Collect>
  <DataCollector scope="monetization">currency</DataCollector>
</Capture>

perUnitPriceMultiplier

次の例では、レスポンスの booking[0].factor JSON 要素の値を perUnitPriceMultiplier 変数に割り当てています。

<Capture>
  <Collect>
    <Source>response</Source>
    <JSONPayload>
      <JSONPath>booking[0].factor</JSONPath>
    </JSONPayload>
  </Collect>
  <DataCollector scope="monetization">perUnitPriceMultiplier</DataCollector>
</Capture>

revShareGrossPrice

次の例では、レスポンスヘッダーの minPrice 変数の値を revShareGrossPrice 変数に割り当てています。

<Capture>
  <Collect>
    <Source>response</Source>
    <Header name="minPrice">
      <Pattern ignoreCase="true">{$}</Pattern>
    </Header>
  </Collect>
  <DataCollector scope="monetization">revShareGrossPrice</DataCollector>
</Capture>

transactionSuccess

次の例では、レスポンスヘッダーの bookingStatus 変数の値を transactionSuccess 変数に割り当てています。

<Capture>
  <Collect>
    <Source>response</Source>
    <Header name="bookingStatus">
      <Pattern ignoreCase="true">{$}</Pattern>
    </Header>
  </Collect>
  <DataCollector scope="monetization">transactionSuccess</DataCollector>
</Capture>