Introducción
Puede ejecutar cualquiera de sus informes de Rakuten Advertising, tanto estándar como personalizados, a través de laAPI (interfaz de programación de aplicaciones) de informes. Esto le permite ejecutar informes sin iniciar sesión en su cuenta.
Instrucciones
Siga estos pasos para obtener la URL de laAPI (interfaz de programación de aplicaciones) para sus informes:
- Acceda a la interfaz de informes.
- Seleccione un informe estándar en el menú desplegable Elegir informes o elabore el suyo propio.
- Seleccione los parámetros del intervalo de fechas.
- Si lo desea, puede personalizar el informe aplicando filtros y añadiendo o eliminando columnas de métricas y puntos de datos. A continuación, haga clic en Guardar informe.
- Haga clic en la flecha situada junto a Ver informe y seleccione Obtener API:
- Aparecerá la ventana emergente «Obtener URL de la API». Muestra una URL que incluye su token web. Copie la URL de laAPI (interfaz de programación de aplicaciones) y guárdela en un lugar seguro.
Importante
La URL de suAPI (interfaz de programación de aplicaciones) incluye un token que permite acceder a los datos de sus informes sin necesidad de iniciar sesión en su cuenta. Debe guardarse de forma tan segura como guardaría su nombre de usuario y su contraseña. Consulte la sección URL de la API (interfaz de programación de aplicaciones) para obtener más información sobre el parámetro token.
Aplicación
Puede pegar la URL de la API (interfaz de programación de aplicaciones) en cualquier navegador y en cualquier momento para generar su informe sin necesidad de acceder a la interfaz de informes. El archivo CSV con los datos de su informe se descargará en el ordenador. Los archivos CSV pueden abrirse en Excel.
URL de laAPI (interfaz de programación de aplicaciones)
Puede modificar los parámetros de la API (interfaz de programación de aplicaciones) que esté utilizando actualmente o crear nuevas URL de la API (interfaz de programación de aplicaciones) de informes sin necesidad de volver a interfaz de informes. Este es un ejemplo de URL de la API (interfaz de programación de aplicaciones):
https://ran-reporting.rakutenmarketing.com/en/reports/revenue-report-by-day/filters?start_date=20XX-10-25&end_date=20XX-10-26&include_summary=Y&network=1&previous-start-date=20XX-09-25&; previous-end-date=20XX-09-26&tz=GMT&date_type=process&date_format=m-d-yy&token=xxxxxxx
Todo lo que aparece en verde arriba se puede editar. Haga clic en el signo + situado junto al nombre de cada parámetro para obtener más información:
Descripción: la fecha de inicio del primer intervalo de fechas para los datos de su informe. Formato AAAA-MM-DD.
Descripción: la fecha de finalización del primer intervalo de fechas para la fecha de su informe. Formato AAAA-MM-DD.
Descripción: ajústelo a «Y» si desea el resumen de seis filas del informe aparezca en la parte superior del archivo que descargue. Ajústelo a «N» si no lo desea. El valor predeterminado es Y.
Descripción: utilice este filtro para mostrar los datos de una red cada vez, de manera que no aparezcan varias monedas en el mismo informe.
- US=1
- RU=3
- CA=5
- BR=8
- AU=41
- FR=7
- DE=9
- JP=11
Descripción: la fecha de inicio del segundo intervalo para los datos de su informe. Formato AAAA-MM-DD.
Descripción: la fecha de finalización del segundo intervalo de fechas para los datos de su informe. Formato AAAA-MM-DD.
Descripción: es la zona horaria que utiliza el informe. GMT es la zona horaria por defecto. Los usuarios pueden cambiar la zona horaria al seleccionar las fechas y verlo reflejado en la API (interfaz de programación de aplicaciones).
Descripción: el tipo de fecha. Utilice procesamiento para la fecha de procesamiento y transacción para la fecha de transacción.
Descripción: se trata de un parámetro opcional con valores por defecto. Utilice uno de los campos siguientes para dar formato a las fechas del informe. Si no se especifica, los valores por defecto de todas las redes serán m/d/aa para las redes no japonesas y aaaa/mm/dd para la red de Japón. Los valores permitidos en este parámetro son:
- m/d/AA
- AAAA/mm/dd
- mm/dd/AA
- dd/mm/AA
- dd/mm/AAAA
- m-d-aa
- AAAA-mm-dd
- mm-dd-AA
- dd-mm-AA
- dd-mm-AAAA
Descripción: este token garantiza la seguridad de sus datos. Se deriva de su Security Token. Guarde bien el token. No modifique este valor. Si desea actualizar su token, puede hacerlo en el Publisher Dashboard.
Intervalos de fechas preestablecidos
Admitimos tanto los intervalos de fechas preestablecidos como los intervalos de fechas exactos especificados en los valores start_date y end_date.
Esto reduce la necesidad de lógica adicional para generar las fechas para las API. La interfaz de informes configurará la URL de la API (interfaz de programación de aplicaciones) para que utilice el intervalo de fechas preestablecido cuando elija un intervalo de fechas preestablecido en el menú desplegable de intervalos de fechas.
| Intervalo de fechas preestablecido | Valores del periodo «Actual» para el parámetro date_range |
|---|---|
| Ayer | ayer |
| Últimos 7 días | últimos-7-días |
| Este mes | este-mes |
| El mes pasado | el-mes-pasado |
| Este trimestre | este-trimestre |
| Último trimestre | último-trimestre |
| Este año | este-año |
| El año pasado | el-año-pasado |
Cuando se compara con otro periodo, estos son los valores de previous_date_range:
| Intervalo de fechas | Valores del intervalo de fechas |
|---|---|
| Semana anterior | semana-anterior |
| Mes anterior | mes-anterior |
| Trimestre anterior | trimestre-anterior |
| Año anterior | año-anterior |
La interfaz generará una URL de laAPI (interfaz de programación de aplicaciones) con fechas específicas si elige «Intervalo de fechas personalizado» en el selector de fechas. Por ejemplo, si ha seleccionado un intervalo de fechas personalizado con el 22 de abril de 20XX como fecha de inicio y el 5 de mayo de 20XX como fecha de finalización, este es el aspecto que tendrá su URL de laAPI (interfaz de programación de aplicaciones):
/filters?start_date=20XX-04-22&end_date=20XX-05-05
El desfase horario seleccionado se aplicará a su informe. Las fechas y horas reflejarán la zona horaria solo para las columnas fecha de transacción, hora de transacción, fecha de procesamiento y hora de procesamiento.
Un informe sin estas columnas, como el Sales and Activity Report, tendrá aplicado el desfase horario. Los informes que sí incluyen estas columnas, como el Individual Item Report, también tendrán aplicado el desfase horario tal y como se ve en la fecha y hora de transacción convertidas.
Sin embargo, la conversión de la zona horaria no se realiza para las siguientes columnas de Fecha y Hora:
- Fecha de consumo de la reserva
- Clic en la fecha
- Fecha de envío del pedido
- Fecha de coincidencia de la firma
- Hora de coincidencia de la firma
- Fecha de creación de la transacción
- Transacción creada a tiempo
Parámetro del formato de fecha
Se trata de un parámetro opcional con valores por defecto. Puede introducir los valores del parámetro date_format codificados o no codificados en «Obtener URL de la API».
Atención
Dependiendo de su configuración regional, es posible que su Excel o otras aplicaciones de archivos no admitan o anulen nuestro parámetro de formato de fecha en determinados formatos de fecha. Es posible que tenga que ajustar sus aplicaciones para que admitan nuestro parámetro de formato de fecha.
Límite de API (interfaz de programación de aplicaciones)
Las solicitudes que utilizan las API de informes están limitadas a una llamada simultánea en cada momento. Si recibimos más de una solicitud ejecutándose simultáneamente, recibirá un error en todas las solicitudes posteriores hasta que una o varias de sus solicitudes existentes se hayan completado. El error será una respuesta HTTP 429 con el mensaje «Ha excedido los límites de solicitud para esta sesión. Inténtelo de nuevo más tarde».
Vea más ejemplos de posibles errores de la API (interfaz de programación de aplicaciones).
Si utiliza llamadas con script, asegúrese de no realizar más de una llamada simultánea, como en un ciclo continuo. Si está ejecutando llamadas ilimitadas a API (interfaz de programación de aplicaciones), ponga una pausa o un límite a las llamadas en su código.
Comentarios
Inicie sesión para dejar un comentario.