Introduction

Vous pouvez exécuter tous les rapports de Rakuten Advertising, qu'ils soient standards ou personnalisés, via l'API de rapport. Cela vous permet d'exécuter des rapports sans vous connecter à votre compte.

Instructions

Suivez ces étapes pour obtenir l'URL de l'API pour vos rapports :

1. Accédez à l'interface des rapports.
2. Sélectionnez un rapport standard dans le menu déroulant « Choisir des rapports » ou créez le vôtre.
3. Sélectionnez les paramètres de la plage de dates.
4. Si vous le souhaitez, personnalisez le rapport en appliquant des filtres ou en ajoutant ou supprimant des colonnes de mesures et de points de données, puis cliquez sur Enregistrer le rapport.
5. Cliquez sur la flèche située à côté de Voir le rapport et sélectionnez Obtenir l'API :

   

6. Une fenêtre pop-up Obtenir l'URL de l'API s'affiche. Une URL contenant votre jeton Web s'affichera. Copiez l'URL de l'API et enregistrez-la dans un emplacement sécurisé.

Application

Vous pouvez coller l'URL API dans n'importe quel navigateur à tout moment pour générer votre rapport sans avoir besoin d'accéder à l'interface des rapports. Le fichier CSV contenant les données de votre rapport sera téléchargé sur votre ordinateur. Les fichiers CSV peuvent être ouverts sur Excel.

URL DE L'API

Vous pouvez modifier les paramètres API que vous utilisez actuellement ou créer de nouvelles URL de rapport API sans revenir à la page interface des rapports. Il s'agit d'un exemple d'URL d'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&; date de fin précédente = 20XX-09-26 & tz = GMT & date_type = processus & date_format = md-aa & token = xxxxxxx

Tout ce qui est en vert ci-dessus peut être modifié. Cliquez sur le + à côté de chaque nom de paramètre pour plus d'informations :

Plages de dates prédéfinies

Nous prenons en charge à la fois les plages de dates prédéfinies et les plages de dates exactes spécifiées dans les valeurs start_date et end_ date.

Cela réduit la nécessité d'une logique supplémentaire pour générer les dates pour les API. Le site interface des rapports configure l'URL API pour qu'elle utilise la plage de dates prédéfinie lorsque vous choisissez une plage de dates prédéfinie dans le menu déroulant de la plage de dates.

Lorsque vous comparez à une autre période, ce sont les valeurs des plages de dates précédentes :

L'interface génère une URL API avec des dates spécifiques si vous choisissez une plage de dates personnalisée dans le sélecteur de dates. Par exemple, si vous avez sélectionné une plage de dates personnalisée avec le 22 avril 20XX comme date de début et le 5 mai 20XX comme date de fin, voici à quoi ressemblera l'URL de votre API :

/filters?start_date=20XX-04-22&end_date=20XX-05-05

Le décalage de fuseau horaire sélectionné sera appliqué à votre rapport. Les dates et heures reflètent le fuseau horaire uniquement pour les colonnes Date de transaction, Heure de transaction, Date de traitement et Heure de traitement.

Un rapport sans ces colonnes, comme le Rapport sur les ventes et activités, se ver ra appliquer le décalage de fuseau horaire. Les rapports qui incluent ces colonnes, comme le Rapport sur les articles individue ls, verront également le décalage de fuseau horaire appliqué, comme le montre la conversion de ladate de transaction et de l'heure.

Cependant, la conversion du fuseau horaire n'est pas effectuée pour les colonnes Date et Heure suivantes :

• Date de consommation de la réservation
• Date du clic
• Date d'expédition de la commande
• Date de correspondance de Signature
• Heure de correspondance de Signature
• Date de création de la transaction
• Heure de création de la transaction

Paramètre de format de la date

Il s'agit d'un paramètre facultatif avec des valeurs par défaut. Vous pouvez saisir les valeurs du paramètre date_format codées ou non dans l'URL d'obtention de l'API.

Limite de l'API

Les demandes utilisant les API de création de rapports sont limitées à un appel simultané à un moment donné. Si nous recevons plus d'une requête en même temps, vous recevrez une erreur pour toutes les autres requêtes jusqu'à ce qu'une ou plusieurs des requêtes existantes soient terminées. L'erreur sera une réponse HTTP 429 avec le message « Vous avez dépassé les limites de requêtes pour cette session, veuillez réessayer plus tard. »

Consultez d'autres exemples d'erreurs possibles de l'API.

Si vous utilisez des appels scriptés, assurez-vous que vous n'effectuez pas plus d'un appel simultané, par exemple dans une boucle de thread. Si vous exécutez un nombre illimité d'appels à l'API, mettez en place une pause ou une limite d'appels dans votre code.