Como capturar dados de monetização

Esta página se aplica à Apigee e à Apigee híbrida.

Confira a documentação da Apigee Edge.

A Apigee usa as variáveis de monetização para classificar, calcular a participação na receita e analisar dados. Se você quer que as análises da Apigee mostrem as informações de monetização usando as variáveis, é possível melhorar os recursos de monetização das suas transações.

Variáveis de monetização

Os nomes das variáveis de monetização são predefinidos, e não é possível criar, editar nem excluir as variáveis. É possível atribuir as variáveis de solicitação ou resposta às variáveis de monetização.

Esta tabela descreve as variáveis de monetização disponíveis na Apigee:

Variável de monetização Tipo de dados Descrição
moeda String Especifica a moeda de cálculo da receita de uma transação.
perUnitPriceMultiplier Ponto flutuante Especifica o fator (multiplicador) usado para multiplicar o custo por transação. O custo por transação é especificado nos preços de taxas, com base no consumo do plano de tarifas. A multiplicação é realizada para uma transação apenas quando ela é monetizável. Uma transação é passível de monetização quando alguma das seguintes condições é atendida:
  • Quando a variável transactionSuccess é true.
  • Quando a variável transactionSuccess é NULL e message.status.code é 2xx (sucesso).
revShareGrossPrice Ponto flutuante

Especifica a receita da transação para calcular a participação do desenvolvedor. A Apigee calcula o compartilhamento do desenvolvedor apenas se você tiver ativado a participação na receita no seu plano de tarifas.
transactionSuccess boolean Especifica se a transação deve gerar receita.
  • Quando a variável está definida como true, a transação é monetizada.
  • Quando a variável está definida como false, a transação não é monetizada.

    • Quando você não especifica essa variável, as transações são monetizadas com base no valor do código de status HTTP disponível na variável message.status.code. Quando o código de status HTTP da resposta é NULL ou >=300, a transação não é monetizada. Para todos os outros códigos de status, a transação é monetizada.

Exemplos de atribuição de valor

Os exemplos a seguir mostram como atribuir valores às variáveis de monetização:

moeda

O exemplo a seguir 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 a seguir 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 a seguir atribui o valor da variável minPrice no cabeçalho de 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 a seguir atribui o valor da variável bookingStatus no cabeçalho de resposta à variável transactionSuccess:

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