Estás viendo la documentación de Apigee Edge.
Consulta la documentación de Apigee X.
Introducción
Los informes de monetización te permiten acceder a información de uso y actividad de transacciones enfocadas. Por ejemplo, puedes determinar qué aplicaciones, desarrolladores, paquetes de productos de API o productos de API tuvieron actividad de transacción durante un período determinado. Con la monetización, puedes generar informes de resumen o detallados que hacen un seguimiento del uso de la API.
Tipos de informes de monetización
Puedes generar los siguientes tipos de informes de monetización.
Denunciar | Descripción |
---|---|
Facturación | Consulta la actividad de los desarrolladores durante un solo mes de facturación y verifica que los planes de tarifas se hayan aplicado correctamente. |
Saldo prepagado | Consulta las recargas de saldo que realizó un desarrollador prepagado en un mes de facturación o en un mes abierto actual, para que puedas conciliar los pagos recibidos de tu procesador de pagos. |
Ingresos | Consulta la actividad y los ingresos que generaron los desarrolladores dentro de un período para que puedas analizar el rendimiento de los paquetes de productos de API y los productos entre tus desarrolladores (y sus aplicaciones). |
Varianza |
Compara la actividad y los ingresos que generan los desarrolladores en dos períodos, de modo que puedas analizar las tendencias ascendentes o descendentes en el rendimiento de los paquetes de API y los productos de los desarrolladores (y sus aplicaciones). |
Acerca de la retención de datos
En la nube pública de Apigee Edge, la retención de datos de monetización es un derecho de plan. Consulta los derechos de monetización en https://cloud.google.com/apigee/specsheets. Comunícate con Ventas de Apigee si deseas que los datos de monetización se conserven más allá del período de derechos. La retención extendida de datos se activa en el momento de la solicitud y no se puede activar de forma retroactiva para incluir los datos antes del período de retención de datos original.
Explora la página Informes de monetización
Accede a la página Informes de monetización, como se describe a continuación.
Perímetro
Para acceder a la página Informes con la IU de Edge, sigue estos pasos:
- Accede a apigee.com/edge.
- Selecciona Publicar > Monetización > Informes en la barra de navegación izquierda.
Se mostrará la página Informes.
Como se destaca en la figura, la página Informes te permite hacer lo siguiente:
- Ver información de resumen de todos los informes, incluidos el nombre y la descripción, el tipo de informe, el período y la fecha de la última modificación
- Cómo configurar un informe
- Cómo generar y descargar un informe en formato CSV o ZIP
- Cómo editar un informe
- Cómo borrar un informe
- Buscar en la lista de informes
Classic Edge (nube privada)
Para acceder a la página Informes con la IU de la versión clásica de Edge, sigue estos pasos:
- Accede a
http://ms-ip:9000
, donde ms-ip es la dirección IP o el nombre de DNS del nodo del servidor de administración. - Selecciona Monetización > Informes de monetización en la barra de navegación superior.
Se mostrará la página Informes.
- Cómo ver la lista actual de informes
- Cómo configurar un informe
- Cómo generar y descargar un informe en formato CSV
- Cómo editar un informe
- Cómo borrar un informe
Cómo configurar un informe
Configurar un informe con la IU, como se describe en las siguientes secciones
Pasos para configurar un informe
Configura un informe con la IU de Edge o la de Edge clásica.
Perímetro
Para configurar un informe con la IU de Edge, sigue estos pasos:
- Selecciona Publicar > Monetización > Informes en la barra de navegación izquierda.
- Haga clic en + Informe.
- Configura los detalles del informe que se definen en la siguiente tabla.
Campo Descripción Nombre Es el nombre único del informe. Descripción Descripción del informe. Tipo de informe Consulta Tipos de informes de monetización. - Configura los detalles restantes del informe según el tipo de facturación seleccionado, como se describe en las siguientes secciones:
- Después de ingresar la información en la ventana del informe, puede hacer lo siguiente:
- Haga clic en Guardar informe para guardar la configuración del informe.
En el caso de un informe detallado únicamente, haz clic en Enviar trabajo para ejecutar el informe de forma asíncrona y recuperar los resultados más adelante. Consulte el artículo Cómo generar y descargar un informe para obtener más información.
- Haz clic en Guardar como CSV o Guardar como ZIP para descargar el informe generado en tu máquina local como valores separados por comas (CSV) o un archivo comprimido comprimido que contiene el CSV. Se recomienda la descarga de archivos ZIP para informes grandes, que se descargarán de manera más eficaz.
Classic Edge (nube privada)
Para crear un informe con la IU de Edge clásica, sigue estos pasos:
- Selecciona Monetización > Informes de monetización en la barra de navegación superior.
- En el menú desplegable, seleccione el tipo de informe que desea crear. Consulta Tipos de informes de monetización.
- Haga clic en + Informe.
- Configura los detalles del informe según el tipo de facturación seleccionado, como se describe en las siguientes secciones:
- Después de ingresar la información en la ventana del informe, puede hacer lo siguiente:
- Haga clic en Guardar como ... para guardar la configuración del informe y descargarlo más tarde.
Si solo deseas obtener un informe detallado, haz clic en Enviar trabajo a fin de ejecutar el informe de forma asíncrona y recuperar los resultados en otro momento. Consulte el artículo Cómo generar y descargar un informe para obtener más información.
- Haz clic en Descargar CSV a fin de generar y descargar el informe en tu máquina local como un archivo de valores separados por comas (CSV) para su visualización.
Cómo configurar un informe de facturación
Siga los pasos para configurar un informe y, luego, ingrese la siguiente información en la página del informe:
Campo | Descripción |
---|---|
Mes de facturación |
Es el mes de facturación del informe. |
Nivel de informes |
Nivel de los informes. Estos son algunos de los valores válidos:
|
Paquetes de productos |
Nota: En la IU clásica de Edge, los paquetes de productos de la API se denominan paquetes de API. Seleccione los paquetes de productos de API que desea incluir en el informe. Si no se selecciona ninguna opción, se incluirán todos los paquetes de productos de API en el informe. El informe incluye una línea separada para cada paquete de productos de API seleccionado. Si lo deseas, puedes marcar No mostrar en las opciones de la página Resumen. En este caso, el informe agrega información sobre todos los paquetes de productos de API (o seleccionados) (y no enumera la información de cada paquete de productos de API por separado). |
Productos |
Seleccione los productos de API que desea incluir en el informe. Si no se selecciona ninguna, se incluyen todos los productos de API en el informe. El informe incluye una línea separada para cada producto de API seleccionado. Si lo deseas, puedes marcar No mostrar en las opciones de la página Resumen. En este caso, el informe recopila información de todos los desarrolladores (o de los seleccionados) y no muestra información de cada desarrollador seleccionado por separado. |
Empresas | Seleccione las empresas que desea incluir en el informe. Si no se selecciona ninguna, todas las empresas se incluyen en el informe. |
Plan de tarifas |
Planes de tarifas para incluir en el informe. Seleccione una de las siguientes opciones:
|
Cómo configurar un informe de saldo prepagado
Siga los pasos para configurar un informe y, luego, ingrese la siguiente información en la página del informe:Campo | Descripción |
---|---|
Mes de facturación |
Es el mes de facturación del informe. |
Nivel de informes |
Nivel de los informes. Estos son algunos de los valores válidos:
|
Empresas | Seleccione las empresas que desea incluir en el informe. Si no se selecciona ninguna, todas las empresas se incluyen en el informe. |
Cómo configurar un informe de ingresos
Siga los pasos para configurar un informe y, luego, ingrese la siguiente información en la página del informe:
Campo | Descripción |
---|---|
Período |
Es el período del informe. Seleccione una de las siguientes opciones:
|
Seleccionar moneda |
Moneda para el informe. Estos son algunos de los valores válidos:
|
Nivel de informes |
Nivel de los informes. Estos son algunos de los valores válidos:
|
Paquetes de productos |
Nota: En la IU clásica de Edge, los paquetes de productos de la API se denominan paquetes de API. Seleccione los paquetes de productos de API que desea incluir en el informe. Si no se selecciona ninguna opción, se incluirán todos los paquetes de productos de API en el informe. El informe incluye una línea separada para cada paquete de productos de API seleccionado. Si lo deseas, puedes marcar No mostrar en las opciones de la página Resumen. En este caso, el informe agrega información sobre todos los paquetes de productos de API (o seleccionados) (y no enumera la información de cada paquete de productos de API por separado). |
Productos |
Seleccione los productos de API que desea incluir en el informe. Si no se selecciona ninguna, se incluyen todos los productos de API en el informe. El informe incluye una línea separada para cada producto de API seleccionado. Si lo deseas, puedes marcar No mostrar en las opciones de la página Resumen. En este caso, el informe recopila información de todos los desarrolladores (o de los seleccionados) y no muestra información de cada desarrollador seleccionado por separado. |
Empresas | Seleccione las empresas que desea incluir en el informe. Si no se selecciona ninguna, todas las empresas se incluyen en el informe. Si deseas obtener un informe de resumen, tienes la opción de marcar No mostrar en la sección Opciones de visualización del resumen. En este caso, el informe agrega información de todas las empresas (o las seleccionadas) y no enumera por separado la información de cada una de ellas. |
Apps |
Selecciona las aplicaciones que deseas incluir en el informe. Si no se selecciona ninguna, se incluyen todas las aplicaciones en el informe. El informe incluye una línea separada para cada aplicación seleccionada. Si deseas obtener un informe de resumen, tienes la opción de marcar No mostrar en la sección Opciones de visualización del resumen. En este caso, el informe agrega información entre todas las aplicaciones (o seleccionadas) (y no enumera la información de cada aplicación seleccionada por separado). |
Opciones de pantalla de resumen |
Es el orden en el que se agrupan las columnas y se muestran en el informe. Selecciona un número que indique el orden relativo de esa sección en el agrupamiento (1 es el primer agrupamiento). Por ejemplo, a continuación, se agrupa el informe primero por paquetes, luego por productos, por desarrolladores y, por último, por aplicaciones. Si no quieres que se muestre una sección, selecciona No mostrar y elige los campos restantes en orden. El orden se actualiza automáticamente cuando cambias el orden relativo de una sección o eliges no mostrar una sección en el informe. |
Incluye atributos de transacción personalizados en los informes de resumen de ingresos
Las políticas de registro de transacciones te permiten capturar datos de atributos personalizados de las transacciones, y puedes incluirlos en los informes de ingresos de resumen. Configura la propiedad MINT.SUMMARY_CUSTOM_ATTRIBUTES
para tu organización a fin de definir el conjunto predeterminado de atributos personalizados incluidos en las tablas de la base de datos de monetización.
Para usar esta función, es necesario pensar y planificar, así que revisa las siguientes consideraciones.
Si eres cliente de la nube, comunícate con el equipo de asistencia de Apigee Edge para configurar la propiedad. Si eres cliente de Apigee Edge para la nube privada, configura la marca con una solicitud PUT en la siguiente API con credenciales de administrador del sistema.
curl -u email:password -X PUT -H "Content-type:application/xml" http://host:port/v1/o/{myorg} -d \ "<Organization type="trial" name="MyOrganization"> <Properties> <Property name="features.isMonetizationEnabled">true</Property> <Property name="MINT.SUMMARY_CUSTOM_ATTRIBUTES">["partner_id","tax_source"]</Property> <Property name="features.topLevelDevelopersAreCompanies">false</Property> </Properties> </Organization>"
En este ejemplo, la llamada a la API habilita la función y
agrega las columnas partner_id
y tax_source
a la
base de datos de monetización. Ten en cuenta que el arreglo de atributos personalizados de la llamada a la API está codificado como URL.
Consideraciones para incluir atributos de transacción personalizados en los informes
- Asegúrate de conocer los nombres de los atributos que quieres usar antes de crearlos con la API. Esos son nombres de columna en la base de datos, y los datos de los atributos personalizados siempre se almacenan ahí.
- Hay 10 ranuras de atributos personalizados disponibles en cada política de registro de transacciones, como se muestra en la siguiente imagen. Usa los mismos nombres y posiciones para los mismos atributos en todos los productos que se incluirán en los informes. Por ejemplo, en la siguiente política de grabación de transacciones, los atributos personalizados
partner_id
ytax_source
ocupan las casillas 4 y 5, respectivamente. Debe ser su nombre y su posición en todas las políticas de registro de transacciones para que se incluyan los productos en los informes.
Para incluir atributos personalizados en un informe de ingresos resumido después de habilitar la función, usa la API de informes agregando transactionCustomAttributes
a MintCriteria
. Consulta Opciones de configuración de criterios.
Cómo configurar un informe de variación (obsoleto)
Siga los pasos para configurar un informe y, luego, ingrese la siguiente información en la página del informe:
Campo | Descripción |
---|---|
Período |
Es el período del informe. Seleccione una de las siguientes opciones:
|
Paquetes |
Los paquetes de API que se incluirán en el informe. Seleccione una de las siguientes opciones:
El informe incluye una línea separada para cada paquete de API seleccionado. Para obtener un informe de resumen, tienes la opción de marcar No mostrar (paquetes) en la sección Opciones de visualización del resumen. En este caso, el informe agrega información entre todos los paquetes de API (o los seleccionados) y no enumera por separado la información de cada paquete de API. |
Productos |
Los productos de API que se incluirán en el informe. Seleccione una de las siguientes opciones:
El informe incluye una línea separada para cada producto de API seleccionado. Para obtener un informe de resumen, tienes la opción de marcar No mostrar (productos) en la sección Opciones de visualización del resumen. En este caso, el informe recopila información de todos los productos de API (o los seleccionados) (y no enumera la información de cada producto de API por separado). |
Empresas |
Son las empresas que se incluirán en el informe. Seleccione una de las siguientes opciones:
El informe incluye una línea separada para cada empresa seleccionada. Para obtener un informe de resumen, tienes la opción de marcar No mostrar (empresas) en la sección Opciones de visualización del resumen. En este caso, el informe recopila información de todas las empresas (o las seleccionadas) y no enumera por separado la información de cada una de ellas. |
Apps |
Son las aplicaciones que se deben incluir en el informe. Seleccione una de las siguientes opciones:
El informe incluye una línea separada para cada aplicación seleccionada. Para obtener un informe de resumen, tienes la opción de marcar No mostrar (aplicaciones) en la sección Opciones de visualización del resumen. En este caso, el informe agrega información entre todas las aplicaciones (o seleccionadas) (y no enumera la información de cada aplicación seleccionada por separado). |
Moneda |
Moneda para el informe. Estos son algunos de los valores válidos:
|
Opciones de pantalla de resumen |
Es el orden en el que se agrupan las columnas y se muestran en el informe. Selecciona un número que indique el orden relativo de esa sección en el agrupamiento (1 es el primer agrupamiento). Por ejemplo, a continuación, se agrupa el informe primero por paquetes, luego por productos, por desarrolladores y, por último, por aplicaciones. Si no quieres que se muestre una sección, selecciona No mostrar y elige los campos restantes en orden. El orden se actualiza automáticamente cuando cambias el orden relativo de una sección o eliges no mostrar una sección en el informe. |
Cómo generar y descargar un informe
Después de crear un informe, puede descargar los resultados en formato CSV o ZIP. Puedes generar el archivo CSV o ZIP de forma síncrona o asíncrona.
Para un informe síncrono, debes ejecutar la solicitud del informe y la solicitud se bloquea hasta que el servidor de estadísticas proporcione una respuesta. Sin embargo, como un informe podría necesitar procesar una gran cantidad de datos (por ejemplo, 100 de GB), un informe síncrono puede fallar debido a un tiempo de espera.
Un nivel de informe Resumen solo admite la generación síncrona.
Para un informe asíncrono, debes ejecutar la solicitud del informe y recuperar los resultados más adelante. Algunos casos en los que el procesamiento de consultas asíncronas puede ser una buena alternativa incluyen los siguientes:
- Análisis y creación de informes que abarquen intervalos grandes
- Análisis de datos con una variedad de dimensiones de agrupación y otras restricciones que agregan complejidad a la consulta.
- Administración de consultas cuando se descubre que los volúmenes de datos aumentaron de forma significativa para algunos usuarios u organizaciones.
Un nivel de informe Detallado admite la generación asíncrona.
Para generar y descargar un informe en formato CSV o ZIP, realiza una de las siguientes tareas:
- Accede a la página Informes.
- Coloque el cursor sobre el informe que desea descargar.
En la columna Modificados, haga clic en una de las siguientes opciones:
- El ícono
o
(para un informe de resumen) El informe se guarda en un archivo CSV o ZIP de manera síncrona.
- Envía un trabajo (para obtener un informe detallado). Se iniciará el trabajo asíncrono.
Supervise el estado del trabajo en la columna Modified.
El ícono de disco aparece cuando el informe está listo para su descarga:
- Una vez que se complete el trabajo, haz clic en el ícono de disco para descargar el informe.
- El ícono
A continuación, se muestra un ejemplo de un archivo CSV para un informe de facturación de resumen.
Cómo editar un informe
Para editar un informe, siga estos pasos:
- Accede a la página Informes.
- Coloque el cursor sobre el informe que desea editar y haga clic en
en el menú de acciones.
- Actualiza la configuración del informe, según sea necesario.
- Haga clic en Actualizar informe para guardar la configuración actualizada del informe.
Cómo borrar un informe
Para borrar un informe, siga estos pasos:
- Accede a la página Informes.
- Coloque el cursor sobre el informe que desea borrar.
- Haz clic en
en el menú de acciones.
Cómo administrar los informes de monetización mediante la API
En las siguientes secciones, se describe cómo administrar los informes de monetización mediante la API.
Cómo configurar un informe con la API
A fin de configurar un informe para toda la organización, envía una solicitud POST a /organizations/{org_name}/report-definitions
.
Si deseas configurar un informe para un desarrollador específico, envía una solicitud POST a /organizations/{org_name}/developers/{dev_id}/report-definitions
, en la que {dev_id}
es la identificación del desarrollador.
Cuando realice la solicitud, deberá especificar el nombre y el tipo de informe. El tipo es uno de los siguientes: BILLING
, REVENUE
, VARIANCE
(obsoleto) o PREPAID_BALANCE
. Además, puedes especificar criterios en la propiedad mintCriteria
, que configuran más aún el informe. Hay una amplia variedad de criterios que puedes especificar. Esto le ofrece mucha flexibilidad para configurar el informe.
Estos son algunos de los datos que puedes especificar como criterios:
- En un informe de facturación o de saldo prepagado, se muestra el mes de facturación del informe.
- Para un informe de ingresos, el tipo de transacciones que se incluyen en el informe, como las de compra, de cobro y de reembolso
- En el caso del informe de saldo prepagado, el desarrollador al que se aplica el informe
- Para un informe de ingresos, los paquetes de productos de API (o paquetes de API), productos, planes de tarifas y aplicaciones a los que se aplica el informe
- Para un informe de ingresos o variaciones, la moneda correspondiente al informe.
- Para la facturación, el saldo prepagado o los informes de ingresos, ya sea que se trate de un informe de resumen o uno detallado
- Para obtener un informe de resumen de ingresos, incluye atributos de transacción personalizados en el informe
Consulta Opciones de configuración de informes para obtener una lista completa de los criterios de informes.
Por ejemplo, lo siguiente crea un informe de ingresos que resume la actividad de la transacción del mes de julio de 2015. El informe incluye una variedad de tipos de transacciones especificados en la propiedad transactionTypes
y se aplica específicamente al paquete de productos de la API de Payment y al producto de la API de Payment. Debido a que no se especifica un desarrollador o una aplicación específicos en la definición del informe, el informe se aplica a todos los desarrolladores y aplicaciones. Además, como la propiedad currencyOption
se establece en LOCAL
, cada línea del informe se mostrará con la moneda del plan de tarifas aplicable. Además, la propiedad groupBy
especifica que las columnas del informe se agruparán en el siguiente orden: PACKAGE, PRODUCT, DEVELOPER, APPLICATION y RATEPLAN (incluye el nombre y el ID del plan de tarifas).
$ curl -H "Content-Type: application/json" -X POST -d \ '{ "name": "July 2015 revenue report", "description": " July 2015 revenue report for Payment product", "type": "REVENUE", "mintCriteria":{ "fromDate":"2015-07-01 00:00:00", "toDate":"2015-08-01 13:35:00", "showTxDetail":true, "showSummary":true, "transactionTypes":[ "PURCHASE", "CHARGE", "REFUND", "CREDIT", "SETUPFEES", "TERMINATIONFEES", "RECURRINGFEES" ], "monetizationPackageIds":[ "payment" ], "productIds":[ "paymentorg-1@@@payment" ], "currencyOption":"LOCAL", "groupBy":[ "PACKAGE", "PRODUCT", "DEVELOPER", "APPLICATION", "RATEPLAN" ] } }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions" \ -u email:password
A continuación, se crea un informe de facturación detallado en el que se muestra la actividad de un desarrollador DEV FIVE para junio de 2015.
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "June billing report, DEV FIVE", "description": "June billing report, DEV FIVE", "type": "BILLING", "mintCriteria":{ "billingMonth": "JUNE", "billingYear": 2015, "showTxDetail":true, "showSummary":false, "currencyOption":"LOCAL" }, "devCriteria":[{ "id":"RtHAeZ6LtkSbEH56", "orgId":"myorg"}] }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xU/report-definitions" \ -u email:password
Visualiza configuraciones de informes con la API
Puede ver una configuración de informes específica o todas las configuraciones de informes de una organización. También puedes ver las configuraciones de informes de un desarrollador individual.
Para ver una configuración de informe específica para una organización, emite una solicitud GET a /organizations/{org_name}/report-definitions/{report_definition_id}
, en la que {report_definition_id}
es la identificación de la configuración de informe específica (el ID se muestra en la respuesta cuando creas la configuración del informe). Por ejemplo:
$ curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/1f7fa53b-de5a-431d-9438-62131e1396c5" \ -u email:password
Para ver todas las opciones de configuración de informes de la organización, envía una solicitud GET a
/organizations/{org_name}/report-definitions
.
Puedes pasar los siguientes parámetros de búsqueda para filtrar y ordenar los resultados:
Parámetro de consulta | Descripción |
---|---|
all |
Marca que especifica si se deben mostrar todos los paquetes de productos de API. Si se configura en false, el parámetro de consulta size define la cantidad de paquetes de productos de API que se muestran por página. La configuración predeterminada es false. |
size |
Cantidad de paquetes de productos de API que se muestran por página La configuración predeterminada es 20. Si el parámetro de búsqueda all se establece en true , se ignora este parámetro. |
page |
Indica la cantidad de páginas que quieres mostrar (si el contenido está paginado). Si el parámetro de búsqueda all se establece en true , se ignora este parámetro. |
sort |
Campo por el que se debe ordenar la información. Si el parámetro de búsqueda all se establece en true , se ignora este parámetro. La configuración predeterminada es UPDATED:DESC . |
Por ejemplo, a continuación, se muestran configuraciones de informes para la organización y se limita la recuperación a un máximo de cinco configuraciones de informe:
$ curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions?size=5" \ -u email:password
La respuesta debería ser similar a la siguiente (solo se muestra una parte):
{ "reportDefinition" : [ { "description" : "Test revenue report", "developer" : null, "id" : "1f7fa53b-de5a-431d-9438-62131e1396c5", "lastModified" : "2015-08-27 15:44:03", "mintCriteria" : { "asXorg" : false, "currencyOption" : "LOCAL", "fromDate" : "2015-07-01 00:00:00", "groupBy" : [ "PACKAGE", "PRODUCT", "DEVELOPER", "APPLICATION", "RATEPLAN" ], "monetizationPackageIds" : [ "payment" ], "productIds" : [ "paymentorg-1@@@payment" ], "showRevSharePct" : false, "showSummary" : true, "showTxDetail" : true, "showTxType" : false, "toDate" : "2015-08-01 00:05:00", "transactionTypes" : [ "PURCHASE", "CHARGE", "REFUND", "CREDIT", "SETUPFEES", "TERMINATIONFEES", "RECURRINGFEES" ] }, "name" : "Test revenue report", "organization" : { ... }, "type" : "REVENUE" }, { "description" : "June billing report, DEV FIVE", "developer" : null, "id" : "fedac696-ce57-469b-b62c-a77b535fd0eb", "lastModified" : "2015-08-27 17:13:20", "mintCriteria" : { "asXorg" : false, "billingMonth" : "JUNE", "billingYear" : 2015, "currencyOption" : "LOCAL", "showRevSharePct" : false, "showSummary" : false, "showTxDetail" : true, "showTxType" : false }, "name" : "June billing report, DEV FIVE", "organization" : { ... }, "type" : "BILLING" } ], "totalRecords" : 2 }
Para ver las configuraciones de informes de un desarrollador específico, emite una solicitud GET a /organizations/{org_name}/developers/{dev_id}/report-definitions
, en la que {dev_id}
es la identificación del desarrollador. Cuando realizas la solicitud, puedes especificar los parámetros de consulta descritos anteriormente para filtrar y ordenar los datos.
Por ejemplo, a continuación, se muestran configuraciones de informes para un desarrollador específico y se ordena la respuesta por nombre de informe:
$ curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xUreport-definitions?sort=name" \ -u email:password
Cómo actualizar la configuración de un informe con la API
Para actualizar la configuración de un informe, emite una solicitud PUT a /organizations/{org_name}/report-definitions/{report_definition_id}
, en la que {report_definition_id}
es la identificación de la configuración específica del informe. Cuando realices la actualización, deberás especificar en el cuerpo de la solicitud los valores de configuración actualizados y el ID de la configuración del informe. Por ejemplo, la siguiente solicitud actualiza el informe a un informe de resumen (las propiedades actualizadas se destacan):
$ curl -H "Content-Type: application/json" -X PUT -d \ '{ "id": "fedac696-ce57-469b-b62c-a77b535fd0eb", "name": "June billing report, DEV FIVE", "description": "June billing report, DEV FIVE", "type": "BILLING", "mintCriteria":{ "billingMonth": "JUNE", "billingYear": 2015, "showTxDetail":false, "showSummary":true } }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/fedac696-ce57-469b-b62c-a77b535fd0eb" \ -u email:password
La respuesta debería ser similar a la siguiente (solo se muestra una parte):
{ "description" : "June billing report, DEV FIVE", "developer" : null, "id" : "fedac696-ce57-469b-b62c-a77b535fd0eb", "lastModified" : "2015-08-27 17:47:29", "mintCriteria" : { "asXorg" : false, "billingMonth" : "JUNE", "billingYear" : 2015, "showRevSharePct" : false, "showSummary" : true, "showTxDetail" : false, "showTxType" : false }, "name" : "June billing report, DEV FIVE", "organization" : { ... }, "type" : "BILLING" }
Cómo borrar la configuración de un informe con la API
Para borrar la configuración de un informe, envía una solicitud DELETE a /organizations/{org_namer}/report-definitions/{report_definition_id}
, en la que {report_definition_id}
es la identificación de la configuración del informe que se borrará.
Por ejemplo:
$ curl -H "Accept:application/json" -X DELETE \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/fedac696-ce57-469b-b62c-a77b535fd0eb" \ -u email:password
Cómo generar un informe con la API
Después de configurar un informe, puedes generar el informe en formato de archivo de valores separados por comas (CSV) para su visualización.
Para generar un informe, envía una solicitud POST a organizations/{org_id}/{report_type}
, en la que {report_type}
especifica el tipo de informe que deseas generar. Los tipos son los siguientes:
billing-reports
revenue-reports
prepaid-balance-reports
variance-reports
Por ejemplo, para generar un informe de facturación, envía una solicitud POST a organizations/{org_name}/billing-reports
.
En el cuerpo de la solicitud (para cualquier tipo de informe), especifique los criterios de búsqueda del informe. Usa las propiedades de mintCriteria
para especificar los criterios de búsqueda. Consulta Opciones de configuración de criterios para obtener más detalles.
Por ejemplo, la siguiente solicitud busca un informe de ingresos según varios criterios, como las fechas de inicio y finalización del informe, y los tipos de transacción.
$ curl -H "Content-Type:application/json" -H "Accept: application/octet-stream" -X POST -d \ '{ "fromDate":"2015-07-01 00:00:00", "toDate":"2015-08-01 13:35:00", "showTxDetail":true, "showSummary":true, "transactionTypes":[ "PURCHASE", "CHARGE", "REFUND", "CREDIT", "SETUPFEES", "TERMINATIONFEES", "RECURRINGFEES" ], "currencyOption":"LOCAL", "groupBy":[ "PACKAGE", "PRODUCT", "DEVELOPER", "APPLICATION", "RATEPLAN"] }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/revenue-reports" \ -u email:password
Si lo encuentras, el informe de ingresos se genera en formato de archivo CSV. A continuación, se proporciona un ejemplo del resultado del informe:
Reporting Period:,From:,2015-07-01, To:,2015-07-31 API Product:,All Developer:,All Application:,All Currency:,Local Type of Report:,Summary Revenue Report Monetization Package,Package ID,API Product,Product ID,Developer Name,Developer ID,Application Name,Application ID,Rate Plan,Plan ID,Currency,Transaction Type,Provider Status,Total Volume,Charged Rate, Location,location,foo_product,foo_product,Apigee,QQ7uxeMGf3w9W08B,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000, Location,location,foo_product,foo_product,BarCompany,barcompany,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000, Location,location,foo_product,foo_product,fremont,fremont,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000, Location,location,foo_product,foo_product,Juan's Taco Shack,juan-s-taco-sha,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,
Incluir atributos personalizados para desarrolladores en los informes de ingresos mediante la API
Solo en los informes de ingresos, puedes incluir atributos personalizados en el informe, si el atributo personalizado está definido para el desarrollador. Define atributos personalizados cuando agregues desarrolladores a tu organización, como se describe en Cómo administrar desarrolladores de apps.
Para incluir atributos personalizados en un informe de ingresos, envía una solicitud POST a organizations/{org_name}/revenue-reports
y agrega el array devCustomAttributes
dentro del cuerpo de la solicitud:
"devCustomAttributes": [ "custom_attribute1", "custom_attribute2", ... ]
Nota: No especifiques los atributos predefinidos MINT_*
y ADMIN_*
en el array devCustomAttributes
.
En el siguiente ejemplo, se incluyen tres atributos personalizados, BILLING_TYPE
, SFID
y ORG_EXT
, en el informe (si se define para el desarrollador):
$ curl -H "Content-Type:application/json" -H "Accept: application/octet-stream" -X POST -d \ '{ "fromDate":"2015-07-01 00:00:00", "toDate":"2015-08-01 13:35:00", "showTxDetail":true, "showSummary":true, "transactionTypes":[ "PURCHASE", "CHARGE", "REFUND", "CREDIT", "SETUPFEES", "TERMINATIONFEES", "RECURRINGFEES" ], "currencyOption":"LOCAL", "groupBy":[ "PACKAGE", "PRODUCT", "DEVELOPER", "APPLICATION", "RATEPLAN" ], "devCustomAttributes": [ "BILLING_TYPE", "SFID", "ORG_EXT" ] }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/revenue-reports" \ -u email:password
A continuación, se muestra un ejemplo del resultado del informe que incluye valores para los dos atributos personalizados:
Reporting Period:,From:,2015-07-01, To:,2015-07-31 API Product:,All Developer:,All Application:,All Currency:,Local Type of Report:,Summary Revenue Report Monetization Package,Package ID,API Product,Product ID,Developer Name,Developer ID,Application Name,Application ID,Rate Plan,Plan ID,Currency,Transaction Type,Provider Status,Total Volume,Charged Rate,BILLING_TYPE,SFID,ORG_EXT Location,location,foo_product,foo_product,Apigee,QQ7uxeMGf3w9W08B,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA, Location,location,foo_product,foo_product,BarCompany,barcompany,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA, Location,location,foo_product,foo_product,fremont,fremont,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA, Location,location,foo_product,foo_product,Juan's Taco Shack,juan-s-taco-sha,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,
Cómo informar actividad de transacciones con la API
Puedes ver la actividad de transacción de una organización mediante una solicitud POST a /organizations/{org_name}/transaction-search
. Cuando realizas la solicitud, debes especificar los criterios de recuperación. Estos son algunos de los datos que puedes especificar como criterios:
- Es el ID de uno o más productos de API para los que se emitieron transacciones.
- Mes y año de facturación de las transacciones
- Desarrollador(es) que emitió la transacción.
- Es el tipo de transacción, como las tarifas de compra y configuración.
- Estado de la transacción, como correcto y fallido.
Consulta Opciones de configuración de criterios para obtener una lista completa de los criterios.
Por ejemplo, a continuación, se muestran las transacciones emitidas por un desarrollador específico para el mes de facturación de junio de 2015:
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "billingMonth": "JUNE", "billingYear": 2015, "devCriteria": [{ "id": "RtHAeZ6LtkSbEH56", "orgId":"myorg"}], "transactionTypes": ["PURCHASE", "CHARGE", "SETUPFEES"], "transactionStatus": ["SUCCESS", "FAILED"] }' "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/transaction-search \ -u email:password
También puedes determinar qué aplicaciones, desarrolladores, paquetes de productos de API o productos de API tuvieron actividad de transacciones en un período determinado. Verás esta información por separado para cada tipo de objeto. Por ejemplo, puedes ver información sobre las aplicaciones que acceden a las API en tus paquetes de productos de API monetizados dentro de una fecha de inicio y finalización específica.
Para ver información sobre la actividad de la transacción, envía una solicitud GET a uno de los siguientes recursos:
Recurso | Muestra |
---|---|
/organizations/{org_name}/applications-with-transactions |
Aplicaciones con transacciones |
/organizations/{org_name}/developers-with-transactions |
Desarrolladores con transacciones |
/organizations/{org_name}/products-with-transactions |
Productos con transacciones |
/organizations/{org_name}/packages-with-transactions |
Paquetes de productos de API (o paquetes de API) con transacciones |
Cuando envías la solicitud, debes especificar como parámetros de consulta una fecha de inicio y de finalización para el período. Por ejemplo, la siguiente solicitud muestra a los desarrolladores con transacciones durante el mes de agosto de 2015.
$ curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers-with-transactions?START_DATE=2015-08-01&END_DATE=2015-08-31" \ -u email:password
La respuesta debería ser similar a la siguiente (solo se muestra una parte):
{ "developer" : [ { "address" : [ { "address1" : "Dev Five Address", "city" : "Pleasanton", "country" : "US", "id" : "0917f15f-9521-4e69-9376-07aa7b7b32ca", "isPrimary" : true, "state" : "CA", "zip" : "94588" } ], "approxTaxRate" : 0.0900, "billingType" : "POSTPAID", "broker" : false, "developerRole" : [ ], "email" : "dev5@myorg.com", "hasSelfBilling" : false, "id" : "tJZG6broTpGGGeLV", "legalName" : "DEV FIVE", "name" : "Dev Five", "organization" : { ... }, "registrationId" : "dev5", "status" : "ACTIVE", "type" : "UNTRUSTED" }, { "address" : [ { "address1" : "Dev Seven Address", "city" : "Pleasanton", "country" : "US", "id" : "f86d8c9f-6ed1-4323-b050-6adf494096c9", "isPrimary" : true, "state" : "CA", "zip" : "94588" } ], "approxTaxRate" : 0.0900, "billingType" : "POSTPAID", "broker" : false, "developerRole" : [ ], "email" : "dev7@myorg.com", "hasSelfBilling" : false, "id" : "VI3l8m8IPAvJTvjS", "legalName" : "DEV SEVEN", "name" : "Dev Seven", "organization" : { ... }, "registrationId" : "dev7", "status" : "ACTIVE", "type" : "UNTRUSTED" }, ... ] }
Opciones de configuración de informes para la API
Las siguientes opciones de configuración de informes están disponibles para la API:
Nombre | Descripción | Predeterminada | ¿Es obligatoria? |
---|---|---|---|
name |
Es el nombre del informe. |
N/A | Sí |
description |
Es una descripción del informe. |
N/A | No |
mintCriteria |
Son los criterios para configurar un informe. Consulta Opciones de configuración de criterios para obtener más detalles. |
N/A | No |
type |
Es el tipo de informe. El valor puede ser uno de los siguientes:
|
N/A | Sí |
Opciones de configuración de criterios
Las siguientes opciones de configuración están disponibles para los informes a través de la propiedad mintCriteria
:
Nombre | Descripción | Predeterminada | ¿Es obligatoria? |
---|---|---|---|
appCriteria |
ID y organización de una aplicación específica que se incluirá en el informe. Si no se especifica esta propiedad, se incluirán todas las aplicaciones en el informe. |
N/A | No |
billingMonth |
Nota: Esta propiedad no es válida para los informes de ingresos. Es el mes de facturación del informe, como JULIO. |
N/A | Sí |
billingYear |
Nota: Esta propiedad no es válida para los informes de ingresos. El año de facturación del informe, como 2015. |
N/A | Sí |
currCriteria |
ID y organización para una moneda específica que se incluirá en el informe Si no se especifica esta propiedad, se incluirán todas las monedas admitidas en el informe. |
N/A | No |
currencyOption |
Moneda para el informe. Estos son algunos de los valores válidos:
|
N/A | No |
devCriteria |
El ID del desarrollador (dirección de correo electrónico) y el nombre de la organización que se incluirán en el informe Si no se especifica esta propiedad, se incluirán todos los desarrolladores en el informe. Por ejemplo: "devCriteria":[{ "id":"RtHAeZ6LtkSbEH56", "orgId":"my_org"} ] |
N/A | No |
devCustomAttributes |
Nota: Esta propiedad se aplica solo a los informes de ingresos. Atributos personalizados que se incluirán en el informe, si se definen para un desarrollador. Por ejemplo: "devCustomAttributes": [ "custom_attribute1", "custom_attribute2", ... ] Nota: No especifiques los atributos predefinidos |
N/A | No |
fromDate |
Nota: Esta propiedad se aplica solo a los informes de ingresos, varianza y actividad de la transacción. Es la fecha de inicio del informe en UTC. |
N/A | Obligatorio para los informes de ingresos; no es obligatorio para otros tipos de informes. |
groupBy |
Es el orden en el que se agrupan las columnas en el informe. Estos son algunos de los valores válidos:
|
N/A | No |
monetizationPackageId |
Es el ID de uno o más paquetes de productos de API que se incluirán en el informe. Si no se especifica esta propiedad, se incluirán todos los paquetes de productos de API en el informe. Nota: Esta propiedad no es válida cuando se ve la actividad de transacción ( |
N/A | No |
pkgCriteria |
Es el ID y la organización para un paquete de productos de API específico que se incluirá en el informe. Si no se especifica esta propiedad, se incluirán todos los paquetes de productos de API en el informe. Esta propiedad se puede especificar en lugar de Nota: Esta propiedad no es válida cuando se ve la actividad de transacción ( |
N/A | No |
prevFromDate |
Nota: Esta propiedad se aplica solo a los informes de variaciones. Fecha de inicio de un período anterior en UTC. Se utiliza a fin de crear un informe para un período anterior de comparación con un informe actual. |
N/A | No |
prevToDate |
Nota: Esta propiedad se aplica solo a los informes de variaciones. Fecha de finalización de un período anterior en UTC. Se utiliza a fin de crear un informe para un período anterior y compararlo con un informe actual. |
N/A | No |
prodCriteria |
ID y organización para un producto específico de la API que se incluirá en el informe. Si no se especifica esta propiedad, se incluirán todos los productos de API en el informe. Esta propiedad se puede especificar en lugar de Nota: Esta propiedad no es válida cuando se ve la actividad de transacción ( |
N/A | No |
productIds |
ID de uno o más productos de API para incluir en el informe. Si no se especifica esta propiedad, se incluirán todos los productos de API en el informe. Los ID de productos de API deben especificarse como |
N/A | No |
pricingTypes |
Es el tipo de precios que se debe incluir en el informe. Estos son algunos de los valores válidos:
Si no se especifica esta propiedad, se incluirán en el informe los planes de tarifas de todos los tipos de precios. |
N/A | No |
ratePlanLevels |
Es el tipo de plan de tarifas que se debe incluir en el informe. Estos son algunos de los valores válidos:
Si no se especifica esta propiedad, se incluirán los planes de tarifas estándar y específicos para desarrolladores en el informe. |
N/A | No |
showRevSharePct |
Marca que especifica si el informe muestra los porcentajes de reparto de ingresos. Entre los valores válidos, se incluyen los siguientes:
|
N/A | No |
showSummary |
Marca que especifica si el informe es un resumen. Estos son algunos de los valores válidos:
|
N/A | No |
showTxDetail |
Nota: Esta propiedad se aplica solo a los informes de ingresos. Marca que especifica si en el informe se muestran detalles a nivel de la transacción. Entre los valores válidos, se incluyen los siguientes:
|
N/A | No |
showTxType |
Marca que especifica si el informe muestra el tipo de cada transacción. Entre los valores válidos, se incluyen los siguientes:
|
N/A | No |
toDate |
Nota: Esta propiedad se aplica solo a los informes de ingresos, varianza y actividad de la transacción. Es la fecha de finalización del informe en UTC. El informe incluye datos recopilados hasta el final del día anterior a la fecha especificada. Se excluirán del informe los datos de informes recopilados en la fecha de finalización especificada. Por ejemplo, si desea vencer un plan de tarifas el 31 de diciembre de 2016, debe establecer el valor toDate en 2017-01-01. En este caso, se incluirán los datos del informe hasta el final del día 31 de diciembre de 2016 y se excluirán los del 1 de enero de 2017. |
N/A | Obligatorio para los informes de ingresos; no es obligatorio para otros tipos de informes. |
transactionStatus |
Es el estado de las transacciones que se incluirán en el informe. Estos son algunos de los valores válidos:
|
N/A | No |
transactionCustomAttributes |
Atributos de transacción personalizados que se incluirán en los informes de ingresos de resumen. Debes habilitar esta función en tu organización. Consulta Cómo incluir atributos de transacción personalizados en los informes de resumen de ingresos. |
N/A | No |
transactionTypes |
Es el tipo de transacciones que se incluirán en el informe. Estos son algunos de los valores válidos:
Si no se especifica esta propiedad, se incluirán todos los tipos de transacción en el informe. |
N/A | No |