Introducción
Puedes ejecutar cualquiera de tus informes de Rakuten Advertising, tanto estándar como personalizados, a través de la API de informes. Esto te permite ejecutar informes sin iniciar sesión en tu cuenta.
Instrucciones
Sigue estos pasos para obtener la URL de la API para tus informes:
- Accede a la Interfaz de Informes.
- Selecciona un informe estándar del menú desplegable Elegir Informes o crea el tuyo propio.
- Establece un rango de fechas para tu informe.
- Si deseas personalizar aún más el informe, aplica filtros o agrega o elimina columnas de métricas y puntos de datos, luego haz clic en Guardar Informe.
- Haz clic en la flecha junto a Ver Informe y selecciona Obtener API:
- Aparece un anuncio emergente de Obtener URL de API. Muestra una URL que incluye tu token web. Copia la URL de la API y guárdala en un lugar seguro.
Precaución
Tu URL de la API presenta un token que te permite acceder a tus datos de informes sin iniciar sesión en tu cuenta. Debes mantenerlo tan seguro como lo harías con tu nombre de usuario y contraseña. Consulta la sección de URL de la API a continuación para obtener más información sobre el parámetro del token.
Aplicación
Puedes pegar la URL de la API en cualquier navegador en cualquier momento para generar tu informe sin necesidad de acceder a la Interfaz de Informes. El archivo CSV con los datos de tu informe se descargará en tu computadora. Los archivos CSV se pueden abrir en Excel.
URL de la API
Puedes modificar los parámetros de la API existentes que estás utilizando actualmente o construir nuevas URLs de la API de informes sin regresar a la Interfaz de Informes. Este es un ejemplo de URL de la API:
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
Puedes editar las partes mostradas en verde. Haz clic en el + junto a cada nombre de parámetro para obtener más información:
Descripción: Esto establece la fecha de inicio para el primer rango de fechas en su informe. Use el formato YYYY-MM-DD.
Descripción: Esto establece la fecha de finalización para el primer rango de fechas en su informe. Use el formato YYYY-MM-DD.
Descripción: Establezca esto en Y si desea la sección de resumen en la parte superior del archivo del informe. Establezca esto en N si no lo desea. Por defecto, está establecido en Y.
Descripción: Use esta configuración para mostrar datos solo para una red. Esto evita que diferentes monedas aparezcan en el mismo informe. Use estos valores para cada red:
- US = 1
- UK = 3
- CA = 5
- BR = 8
- AU = 41
- FR = 7
- DE = 9
- JP = 11
Descripción: Esto establece la fecha de inicio para el segundo rango de fechas en su informe. Use el formato YYYY-MM-DD.
Descripción: Esto establece la fecha de finalización para el segundo rango de fechas en su informe. Use el formato YYYY-MM-DD.
Descripción: Esto establece la zona horaria que utiliza el informe. GMT es la zona horaria predeterminada. Cuando selecciona fechas en la interfaz de informes, la zona horaria que elija aparece en la URL de la API. Obtenga más información sobre cómo personalizar la zona horaria para su informe.
Descripción: Esto establece el tipo de fecha utilizada en el informe. Use process para la fecha de procesamiento y transaction para la fecha de transacción.
Descripción: Esta configuración es opcional y tiene valores predeterminados. Use una de las opciones a continuación para formatear las fechas en su informe. Si no especifica un formato, el predeterminado es m/d/yy para la mayoría de las redes y yyyy/mm/dd para la red de Japón. Las opciones que puede usar son:
- m/d/YY
- YYYY/mm/dd
- mm/dd/YY
- dd/mm/YY
- dd/mm/YYYY
- m-d-yy
- YYYY-mm-dd
- mm-dd-YY
- dd-mm-YY
- dd-mm-YYYY
Descripción: Este token mantiene sus datos seguros. Mantenga su token seguro y no lo envíe a nadie por correo electrónico. Si necesita un nuevo token, haga clic en Actualizar token de API en la esquina superior derecha de cualquier informe en la interfaz.
Rangos de fechas preestablecidos
Puede usar fechas de inicio y finalización exactas y rangos de fechas preestablecidos en la URL de la API. Usar rangos de fechas preestablecidos le evita tener que calcular las fechas específicas para sus llamadas a la API. Cuando selecciona un rango de fechas preestablecido del menú desplegable en la interfaz de informes, la URL de la API utiliza ese valor preestablecido de la siguiente manera:
Rango de fechas preestablecido | Valores para el parámetro date_range |
---|---|
Ayer | yesterday |
Últimos 7 días | last-7-days |
Este mes | this-month |
Mes pasado | last-month |
Este trimestre | this-quarter |
Trimestre pasado | last-quarter |
Este año | this-year |
Año pasado | last-year |
Cuando compara su informe con otro período, puede usar estos valores para el previous_date_range:
Rango de fechas | Valores del rango de fechas |
---|---|
Semana anterior | previous-week |
Mes anterior | previous-month |
Trimestre anterior | previous-quarter |
Año anterior | previous-year |
Si selecciona un rango de fechas personalizado usando el selector de fechas en la interfaz de informes, la URL de la API mostrará las fechas específicas. Por ejemplo, si selecciona un rango 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, la URL incluirá:
/filters?start_date=20XX-04-22&end_date=20XX-05-05
El desfase de la zona horaria seleccionada se aplicará a su informe. Las fechas y horas solo reflejarán la zona horaria para las columnas de Fecha de Transacción, Hora de Transacción, Fecha de Procesamiento y Hora de Procesamiento.
El desfase de la zona horaria se aplicará a los informes que no incluyan estas columnas, como el Sales and Activity Report. Los informes que sí incluyan estas columnas, como el Individual Item Report, también tendrán el desfase de la zona horaria aplicado como se ve en la Fecha y Hora de Transacción convertidas.
Sin embargo, la conversión de zona horaria no se realiza para las siguientes columnas de Fecha y Hora:
- Fecha de Consumo de Reserva
- Fecha de Clic
- Fecha de Envío de Pedido
- Fecha de Coincidencia de Firma
- Hora de Coincidencia de Firma
- Fecha de Creación de Transacción
- Hora de Creación de Transacción
Parámetro de Formato de Fecha
Este parámetro es opcional y tiene valores predeterminados. Puedes ingresar los valores del parámetro date_format en la URL de la API Get. Puedes usar valores codificados o no codificados.
Atención
Dependiendo de la configuración de tu computadora, programas como Excel podrían no soportar o podrían cambiar el formato de fecha que establezcas en la URL de la API. Es posible que necesites ajustar la configuración de tu programa para ayudar a nuestro parámetro de formato de fecha.
Límite de la API
Solo puedes ejecutar una llamada de API de informes a la vez. Si envías más de una solicitud simultáneamente, recibirás un error en las solicitudes adicionales y en todas las solicitudes posteriores hasta que una o más de tus solicitudes existentes se completen. El error es una respuesta HTTP 429 con el mensaje Has excedido tus límites de solicitud para esta sesión, por favor intenta de nuevo más tarde.
Si usas scripts para ejecutar llamadas de API, asegúrate de que tu script no intente ejecutar múltiples llamadas simultáneamente. Por ejemplo, evita usar bucles con hilos que hagan llamadas ilimitadas. Si debes hacer muchas llamadas, añade una pausa o un límite en tu código entre solicitudes.
Errores de la API
Puedes recibir un código de error o mensaje al ejecutar tus informes a través de la API. Consulta ejemplos de posibles errores de API e instrucciones sobre cómo abordarlos. Para asistencia adicional con errores de API, contacta a Soporte al Cliente.
|
Este sitio web utiliza IA para traducciones, las cuales pueden contener inexactitudes o errores. No nos hacemos responsables de los problemas que surjan por confiar en el contenido traducido; consulta la versión original en inglés para obtener información autorizada. |
Comentarios
Inicie sesión para dejar un comentario.