Como gerar relatórios de monetização

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

Confira a documentação da Apigee Edge.

Observação: não é possível gerar relatórios personalizados na Apigee híbrida. Problema conhecido: 355714868

Usando o recurso Relatórios personalizados da Apigee, você pode gerar relatórios para ver as informações de monetização das suas APIs. Para gerar os relatórios, use a IU da Apigee, a API de estatísticas ou a API de consultas, conforme descrito nas seguintes seções:

• Como gerar um relatório personalizado usando a IU da Apigee:
• API Stats
• API Query (API de relatórios personalizados assíncronos)

Métricas e dimensões de monetização

A Apigee fornece as seguintes métricas e dimensões de monetização:

• Métricas e dimensões para transações usando um proxy de API
• Métricas e dimensões para transações com base em taxas

Métricas e dimensões para transações usando um proxy de API

As tabelas a seguir listam as métricas e dimensões de x_apigee_mintng_* disponíveis para transações usando um proxy de API:

• Métricas

  Nome na IU	Nome na API	Descrição
  Multiplicador de preços da API	x_apigee_mintng_price_multiplier	O fator (multiplicador) pelo qual o custo por transação é multiplicado.
  Participação do desenvolvedor na receita	x_apigee_mintng_dev_share	Participação do desenvolvedor na receita de uma transação.
  Preço de monetização	x_apigee_mintng_price	Receita total de uma transação
  Taxas de monetização	x_apigee_mintng_rate	Taxa cobrada por uma transação.

• Dimensões

  Nome na IU	Nome na API	Descrição
  ID do plano de tarifa	x_apigee_mintng_rate_plan_id	É o plano de taxa de monetização do desenvolvedor do app.
  Moeda da receita	x_apigee_mintng_currency	Moeda da receita da transação.
  Transação concluída	x_apigee_mintng_tx_success	Status da monetização da transação.

Observação:

• Para as transações que usam um proxy de API, também é possível usar outras métricas e dimensões junto com as métricas e dimensões de x_apigee_mintng_*.
• A interpretação de um valor de dimensão depende da métrica. Por exemplo, se você selecionar a dimensão API Product, para uma transação baseada em taxa, o valor será o nome do produto de API correspondente ao plano de tarifas ao qual uma taxa de configuração ou recorrente precisa ser aplicada. No entanto, se você selecionar a dimensão API Product para uma transação não paga, o valor vai ser o nome do produto da API que contém os proxies de API que estão sendo chamados.

Métricas e dimensões para transações com base em taxas

As tabelas a seguir listam as métricas e dimensões disponíveis apenas para transações baseadas em taxas:

• Métricas

  Nome na IU	Nome na API	Descrição
  Taxas	tarifas	Valor da taxa.

• Dimensões

  Nome na IU	Nome na API	Descrição
  Tipo de taxa	fees_type	Tipo de taxa: de configuração, recorrente, recarga pré-paga ou reembolso. Essa dimensão vai ser null quando usada com qualquer métrica diferente de fees.
  Data e hora da criação da taxa	created	Carimbo de data/hora Unix em que a taxa foi adicionada para o desenvolvedor de apps e o produto de API. Essa dimensão é null quando usada com qualquer métrica diferente de fees.
  Moeda da receita	x_apigee_mintng_currency	Moeda da taxa.
  E-mail do desenvolvedor	developer_email	O desenvolvedor que vai pagar a taxa.
  Produto de API	api_product	Produto da API correspondente ao plano de tarifas a que a taxa se aplica. O valor está vazio para alguns tipos de tarifa, como recarga pré-paga.
  ID do plano de tarifa	x_apigee_mintng_rate_plan_id	É o plano de taxa de monetização do desenvolvedor do app. O valor está vazio para alguns tipos de tarifa, como recarga pré-paga.
  Início do período	period_start	Início do período em que as taxas recorrentes são cobradas. Por exemplo, para uma taxa mensal, este é o primeiro dia do mês. Essa dimensão é null quando usada com qualquer métrica diferente de fees.
  Término do período	period_end	Fim do período em que as taxas recorrentes são cobradas. Por exemplo, uma taxa mensal é o último dia do mês. Essa dimensão é null quando usada com qualquer métrica diferente de fees.

Para ver descrições detalhadas dessas métricas e dimensões, consulte a Referência de métricas, dimensões e filtros do Analytics.

O exemplo personalizado de relatório a seguir exibe a soma das taxas de monetização em todos os apps para desenvolvedores:

A amostra apresenta o custo total de todas as transações de 1-Apr-2021 to 15-Apr-2021 para cada app do desenvolvedor. O custo é calculado com base no preço com base no consumo, conforme configurado no seu plano de tarifas. Neste exemplo, a métrica (x_apigee_mintng_rate) é um campo de monetização, mas a dimensão (developer_app) é um campo de não monetização. Portanto, com base nos seus requisitos, é possível gerar relatórios combinando os campos de monetização e de não monetização.

Também é possível limitar seus resultados com base nas características das métricas usando filtros.

Para ver as taxas recorrentes nos relatórios gerados, inclua no período selecionado o dia após o último dia do mês ou o dia após a data de expiração da assinatura, já que é quando elas são cobradas.

Como exportar dados de análise de monetização

Na Apigee, não é necessário realizar etapas adicionais para exportar os dados de análise de monetização. Se você estiver exportando dados de análise, a Apigee exportará os campos de monetização a seguir com os dados de análise regulares: Quando as transações baseadas em taxas e as transações que usam um proxy de API são exportadas juntas, cada registro é exportado com as métricas e dimensões comuns, com outras métricas e dimensões (não relacionadas) definidas como NULL.

Observação: para mais informações sobre esses valores, consulte a página de exportação vinculada à frase anterior.

Importante:a Apigee adiciona novos campos periodicamente e recomenda não escrever código dependente que seria interrompido para novos campos.

• client_received_start_timestamp
• period_end
• period_start
• x_apigee_mintng_currency
• x_apigee_mintng_dev_share
• x_apigee_mintng_price
• x_apigee_mintng_price_multiplier
• x_apigee_mintng_rate
• x_apigee_mintng_rate_plan_id
• x_apigee_mintng_tx_success