Generar informes de monetización

Esta página se aplica a Apigee y Apigee Hybrid.

Consulta la documentación de Apigee Edge.

Nota: La generación de informes personalizados no es compatible con Apigee Hybrid. Problema conocido: 355714868

Mediante la función Informes personalizados de Apigee, puedes generar informes para ver la información de monetización de tus API. Para generar los informes, puedes usar la IU de Apigee, la API de estadísticas o la API de consultas, como se describe en las siguientes secciones:

• Genera un informe personalizado con la IU de Apigee:
• API de estadísticas
• API de consultas (API de informes personalizados asíncronos)

Métricas y dimensiones de monetización

Apigee proporciona las siguientes métricas y dimensiones de monetización:

• Métricas y dimensiones para transacciones con un proxy de API
• Métricas y dimensiones para transacciones basadas en tarifas

Métricas y dimensiones para transacciones con un proxy de API

En las siguientes tablas, se enumeran las métricas y las dimensiones x_apigee_mintng_* disponibles para las transacciones que usan un proxy de API:

• Métricas

  Nombre en la IU	Nombre en la API	Descripción
  Multiplicador de precios de la API	x_apigee_mintng_price_multiplier	El factor (multiplicador) por el que se multiplica el costo por transacción.
  Porcentaje de ingresos del desarrollador	x_apigee_mintng_dev_share	Porcentaje del desarrollador en los ingresos de una transacción.
  Precio de la monetización	x_apigee_mintng_price	Los ingresos totales de una transacción.
  Tasas de monetización	x_apigee_mintng_rate	Tarifa cobrada por una transacción.

• Dimensiones

  Nombre en la IU	Nombre en la API	Descripción
  ID del plan de tarifas	x_apigee_mintng_rate_plan_id	El plan de tasa de monetización del desarrollador de apps.
  Moneda de ingresos	x_apigee_mintng_currency	Moneda de los ingresos de la transacción.
  Transacción exitosa	x_apigee_mintng_tx_success	Estado de monetización de la transacción.

Nota:

• Para las transacciones que usan un proxy de API, también puedes usar otras métricas y dimensiones junto con las métricas y dimensiones x_apigee_mintng_*.
• La interpretación de un valor de dimensión depende de la métrica. Por ejemplo, si seleccionas la dimensión API Product, para una transacción basada en tarifas, el valor será el nombre del producto de API correspondiente al plan de tarifas al que se debe aplicar la tarifa de configuración o la tarifa recurrente. Sin embargo, si seleccionas la dimensión API Product para una transacción no basada en tarifas, el valor será el nombre del producto de API que contiene los proxies de API a los que se llama.

Métricas y dimensiones para transacciones basadas en tarifas

En las siguientes tablas, se enumeran las métricas y las dimensiones disponibles únicamente para transacciones basadas en tarifas:

• Métricas

  Nombre en la IU	Nombre en la API	Descripción
  Tarifas	tarifas	Es el importe de la comisión.

• Dimensiones

  Nombre en la IU	Nombre en la API	Descripción
  Tipo de comisión	fees_type	Tipo de comisión: tarifa de configuración, tarifa recurrente, recarga de prepago o reembolso. Esta dimensión será null cuando se use con cualquier métrica que no sea fees.
  Fecha y hora de creación de la tarifa	created	Marca de tiempo de Unix cuando se agregó la comisión para el desarrollador de la app y el producto de la API. Esta dimensión es null cuando se usa con cualquier métrica que no sea fees.
  Moneda de ingresos	x_apigee_mintng_currency	Es la moneda de la comisión.
  Correo electrónico del desarrollador	developer_email	Es el desarrollador al que se le cobrará la comisión.
  Producto de API	api_product	Producto de API correspondiente al plan de tarifas al que se aplica la comisión. El valor está vacío para algunos tipos de comisiones, como las recargas de prepago.
  ID del plan de tarifas	x_apigee_mintng_rate_plan_id	El plan de tasa de monetización del desarrollador de apps. El valor está vacío para algunos tipos de comisiones, como las recargas de prepago.
  Inicio del período	period_start	Inicio del período por el que se cobran las tarifas recurrentes. Por ejemplo, por una tarifa mensual, este es el primer día del mes. Esta dimensión es null cuando se usa con cualquier métrica que no sea fees.
  Final del período	period_end	Fin del período por el que se cobran las tarifas recurrentes. Por ejemplo, para una tarifa mensual, este es el último día del mes. Esta dimensión es null cuando se usa con cualquier métrica que no sea fees.

Para obtener descripciones detalladas de estas métricas y dimensiones, consulta Referencia de métricas, dimensiones y filtros de Analytics.

El siguiente informe personalizado de muestra demuestra la suma de las tarifas de monetización en todas las apps para desarrolladores:

Para cada app de desarrollador, en la muestra aparece el costo total de todas las transacciones de 1-Apr-2021 to 15-Apr-2021. El costo se calcula en función de los precios por consumo como se configuró en tu plan de tarifas. Ten en cuenta que, en este ejemplo, la métrica (x_apigee_mintng_rate) es un campo de monetización, pero la dimensión (developer_app) no es un campo de monetización. Por lo tanto, según tus requisitos, puedes generar informes con una combinación de campos de monetización y de no monetización.

También puedes limitar los resultados según las características de la métrica mediante filtros.

Para ver las comisiones recurrentes en los informes generados, incluye en el período seleccionado el día posterior al último día del mes o el día posterior a la fecha de vencimiento de la suscripción, ya que es cuando se cobran.

Exporta datos de estadísticas de monetización

En Apigee, no necesitas realizar ningún paso adicional para exportar los datos de estadísticas de monetización. Si exportas datos de estadísticas, Apigee exporta los siguientes campos de monetización junto con datos de estadísticas normales. Cuando las transacciones basadas en tarifas y transacciones que usan un proxy de API se exportan juntas, cada registro exporta con las métricas y dimensiones comunes, con otras métricas (no relacionadas) y las dimensiones establecidas en NULL.

Nota: Consulta la página de exportación vinculada en la oración anterior para obtener información adicional sobre estos valores.

Importante: Apigee agrega periódicamente campos nuevos y recomienda no escribir código dependiente que se interrumpa para los campos nuevos.

• 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