Capturar dados de rentabilização

Esta página aplica-se ao Apigee e ao Apigee Hybrid.

Veja a documentação do Apigee Edge.

O Apigee usa as variáveis de rentabilização para classificação, cálculo da partilha de receita e estatísticas. Se quiser que as estatísticas do Apigee mostrem as informações de rentabilização. Ao usar as variáveis de rentabilização, pode melhorar as capacidades de rentabilização das suas transações.

Variáveis de rentabilização

Os nomes das variáveis de rentabilização estão predefinidos e não pode criar, editar nem eliminar as variáveis. Pode atribuir variáveis de pedido ou de resposta às variáveis de monetização.

Esta tabela descreve as variáveis de rentabilização disponíveis no Apigee:

Variável de rentabilização Tipo de dados Descrição
moeda String Especifica a moeda para calcular a receita de uma transação.
perUnitPriceMultiplier Flutuante Especifica o fator (multiplicador) pelo qual o custo por transação é multiplicado. O custo por transação é especificado nos preços das taxas baseadas no consumo do plano tarifário. A multiplicação é realizada para uma transação apenas se a transação for rentabilizável. Uma transação é rentabilizável se qualquer uma das seguintes condições for cumprida:
  • Se a variável transactionSuccess for true.
  • Se a variável transactionSuccess for NULL e o message.status.code for 2xx (êxito).
revShareGrossPrice Flutuante

Especifica a receita da transação para calcular a quota do programador. O Apigee calcula a quota do programador apenas se tiver ativado a partilha de receita no seu plano tarifário.
transactionSuccess booleano Especifica se a transação deve ser rentabilizada.
  • Se a variável estiver definida como true, a transação é rentabilizada.
  • Se a variável estiver definida como false, a transação não é rentabilizada.

    • Se não especificar esta variável, as transações são rentabilizadas com base no valor do código de estado HTTP disponível na variável message.status.code. Se o código de estado HTTP da resposta for NULL ou >=300, a transação não é rentabilizada. Para todos os outros códigos de estado, a transação é rentabilizada.

Exemplos de atribuição de valores

Os exemplos seguintes mostram como atribuir valores às variáveis de rentabilização:

moeda

O exemplo seguinte atribui o valor do elemento JSON booking[0].currency na resposta à variável currency:

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

perUnitPriceMultiplier

O exemplo seguinte atribui o valor do elemento JSON booking[0].factor na resposta à variável perUnitPriceMultiplier:

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

revShareGrossPrice

O exemplo seguinte atribui o valor da variável minPrice no cabeçalho da resposta à variável revShareGrossPrice:

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

transactionSuccess

O exemplo seguinte atribui o valor da variável bookingStatus no cabeçalho da resposta à variável transactionSuccess:

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