擷取營利資料

本頁內容適用於 ApigeeApigee Hybrid

查看 Apigee Edge 說明文件。

Apigee 會使用營利變數進行評等、計算收益分享和分析。如果您希望 Apigee Analytics 顯示營利資訊,使用營利變數,可提升交易的營利能力。

營利變數

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

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

營利變數 資料類型 說明
currency 字串 指定用來計算交易收益的貨幣。
perUnitPriceMultiplier 浮點值 指定每筆交易費用要乘上的因數 (乘數)。 每筆交易的費用會列在費率方案的「以用量計費」定價中。只有在交易可營利時,系統才會執行乘法運算。如果符合下列任一條件,交易即可營利:
  • 如果 transactionSuccess 變數為 true
  • 如果 transactionSuccess 變數為 NULL,且 message.status.code2xx (成功)。
revShareGrossPrice 浮點值

指定交易收益,用於計算開發人員的分潤。只有在費率方案中啟用收益分享功能時,Apigee 才會計算開發人員的收益。

transactionSuccess 布林值 指定交易是否應營利。
  • 如果變數設為 true,交易就會營利。
  • 如果變數設為 false,交易就不會營利。
  • 如未指定此變數,系統會根據 message.status.code 變數中提供的 HTTP 狀態碼值,判斷交易是否符合營利資格。如果回應的 HTTP 狀態碼為 NULL 或 >=300,交易就不會營利;如果是其他狀態碼,交易就會營利。

值指派範例

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

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>