擷取營利資料

本頁適用於 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 說明文件。

Apigee 會使用營利變數來評估、計算收益分潤和數據分析。如果您希望 Apigee 分析顯示營利資訊，使用營利變數可強化交易的營利功能。

營利變數

營利變數名稱是預先定義的，您無法建立、編輯或刪除這些變數。您可以將要求或回應變數指派給營利變數。

如果您想覆寫營利變數，可以使用DataCapture 政策擷取這些變數。

下表說明 Apigee 提供的營利變數：

營利變數	資料類型	說明
currency	字串	指定用於計算交易收益的貨幣。
perUnitPriceMultiplier	浮點值	指定乘以每筆交易費用的因數 (乘數)。每筆交易費用會在費率方案的以使用量計費定價中指定。只有在交易可營利的情況下，系統才會為交易執行相乘運算。如果交易符合下列任一條件，即可進行營利： 如果 transactionSuccess 變數為 true。 如果 transactionSuccess 變數為 NULL，而 message.status.code 為 2xx (成功)。
revShareGrossPrice	浮點值	指定交易的收益，以便計算開發人員的分潤。只有在您在費率方案中啟用收益分潤功能時，Apigee 才會計算開發人員的分潤。
transactionSuccess	布林值	指定是否要將交易營利。 如果變數設為 true，交易就會產生收益。 如果變數設為 false，則交易不會營利。 如果未指定這個變數，系統會根據 message.status.code 變數中可用的 HTTP 狀態碼值，為交易進行營利。如果回應的 HTTP 狀態碼為空值或大於等於 300，則交易不會產生收益；如果是其他狀態碼，則交易會產生收益。 注意：如果 transactionSuccess 的值不是布林值，DataCapture 政策就會將 mint.tx_success_result 變數評估為 false。

注意：

• 營利變數不會顯示在 Apigee 的 Admin > Data Collectors 頁面中。
• 營利變數會區分大小寫。
• 除了表格中列出的變數名稱外，您無法為營利變數提供任何其他名稱。
• 營利變數不會列在 organizations.datacollectors.list API 中。

值指派範例

以下範例說明如何為營利變數指派值：

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>