Einführung
Sie können alle Ihre Rakuten Advertising-Berichte – sowohl Standard- als auch benutzerdefinierte Berichte – über die Reporting-API ausführen. So können Sie Berichte ausführen, ohne sich bei Ihrem Konto anmelden zu müssen.
Anleitung
Folgen Sie diesen Schritten, um die API-URL für Ihre Berichte zu erhalten:
- Rufen Sie die Reporting-Schnittstelle auf.
- Wählen Sie einen Standardbericht aus dem Drop-down-Menü „Berichte auswählen“ aus oder erstellen Sie einen eigenen Bericht.
- Wählen Sie die Parameter für den Datumsbereich.
- Wenn Sie möchten, können Sie den Bericht anpassen, indem Sie Filter anwenden oder Spalten mit Metriken und Datenpunkten hinzufügen oder entfernen und auf „Bericht speichern“ klicken.
- Klicken Sie auf den Pfeil neben „Bericht anzeigen“ und wählen Sie „API abrufen“ aus:
- Es wird ein „Get-API-URL“-Pop-up angezeigt. Es wird eine URL angezeigt, die Ihren Web-Token enthält. Kopieren Sie die API-URL und speichern Sie sie an einem sicheren Ort.
Vorsicht
Ihre API-URL enthält ein Token, mit dem Sie auf Ihre Berichtsdaten zugreifen können, ohne sich bei Ihrem Konto anmelden zu müssen. Sie sollten sie genauso sicher aufbewahren wie Ihren Benutzernamen und Ihr Passwort. Weitere Informationen über den Token-Parameter finden Sie im Abschnitt zur API-URL weiter unten.
Anwendung
Sie können die API-URL jederzeit in jeden gewünschten Browser eingeben, um Ihren Bericht zu erstellen, ohne auf die Reporting-Schnittstelle zugreifen zu müssen. Die CSV-Datei mit Ihren Berichtsdaten wird auf Ihren Computer heruntergeladen. CSV-Dateien können in Excel geöffnet werden.
API-URL
Sie können bestehende API-Parameter, die Sie derzeit verwenden, ändern oder neue API-URLs für Berichte erstellen, ohne zur Reporting-Schnittstellezurückkehren zu müssen. Dies ist ein Beispiel für eine API-URL:
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
Alles, was oben grün markiert ist, kann bearbeitet werden. Klicken Sie auf das + neben dem jeweiligen Parameternamen, um weitere Informationen zu erhalten:
Beschreibung: Das Startdatum für den ersten Datumsbereich für Ihre Berichtsdaten. Formatiert in JJJJ-MM-TT.
Beschreibung: Das Enddatum für den ersten Datumsbereich für Ihr Berichtsdatum. Formatiert in JJJJ-MM-TT.
Beschreibung: Setzen Sie diesen Wert auf Y, wenn Sie eine sechszeilige Berichtszusammenfassung am Anfang der heruntergeladenen Datei sehen möchten. Setzen Sie dies auf „N“, wenn Sie das nicht wünschen. Die Standardeinstellung ist Y.
Beschreibung: Verwenden Sie diesen Filter, um Daten für jeweils genau ein Netzwerk anzuzeigen, damit nicht mehrere Währungen in demselben Bericht erscheinen.
- US=1
- UK=3
- CA=5
- BR=8
- AU=41
- FR=7
- DE=9
- JP=11
Beschreibung: Das Startdatum für den zweiten Bereich Ihrer Berichtsdaten. Formatiert in JJJJ-MM-TT.
Beschreibung: Das Enddatum für den zweiten Datumsbereich für Ihre Berichtsdaten. Formatiert in JJJJ-MM-TT.
Beschreibung: Dies ist die Zeitzone, die für den Bericht verwendet wird. GMT ist die Standardzeitzone. Benutzer können die Zeitzone bei der Auswahl der Daten ändern und sehen, wie sich dies in der API widerspiegelt.
Beschreibung: Der Datumstyp. Verwenden Sie process für das Bearbeitungsdatum und transaction für das Transaktionsdatum.
Beschreibung: Dies ist ein optionaler Parameter mit Standardwerten. Verwenden Sie eines der unten stehenden Felder, um die Daten im Bericht zu formatieren. Wenn Sie keine Angaben machen, setzen wir die Standardwerte für alle Netzwerke auf M/T/JJ für nicht-japanische Netzwerke und JJJJ/MM/TT für das Netzwerk Japan. Die zulässigen Werte für diesen Parameter sind:
- M/T/JJ
- JJJJ/MM/TT
- MM/TT/JJ
- TT/MM/JJ
- TT/MM/JJJJ
- M-T-JJ
- JJJJ-MM-TT
- MM-TT-JJ
- TT-MM-JJ
- TT-MM-JJJJ
Beschreibung: Dieses Token gewährleistet die Sicherheit Ihrer Daten. Es wird von Ihrem Security Token abgeleitet. Bewahren Sie das Token sicher auf. Ändern Sie diesen Wert nicht. Wenn Sie Ihr Token aktualisieren möchten, können Sie dies im Publisher Dashboard tun.
Voreingestellte Datumsbereiche
Wir unterstützen sowohl voreingestellte Datumsbereiche als auch exakte Datumsbereiche, die in den Werten start_date und end_date angegeben sind.
Dies reduziert den Bedarf an zusätzlicher Logik zur Generierung der Daten für die APIs. Die Reporting-Schnittstelle stellt die API-URL so ein, dass sie den voreingestellten Datumsbereich verwendet, wenn Sie einen voreingestellten Datumsbereich aus dem Drop-down-Menü „Datumsbereich“ auswählen.
| Voreingestellter Datumsbereich | Aktuelle Periodenwerte für den Parameter date_range |
|---|---|
| Gestern | yesterday |
| Letzte 7 Tage | last-7-days |
| Dieser Monat | this-month |
| Letzter Monat | last-month |
| Dieses Quartal | this-quarter |
| Letztes Quartal | last-quarter |
| Dieses Jahr | this-year |
| Letztes Jahr | last-year |
Beim Vergleich mit einem anderen Zeitraum sind dies die Werte für previous_date_range:
| Datumsbereich | Datumsbereichswerte |
|---|---|
| Letzte Woche | previous-week |
| Vorheriger Monat | previous-month |
| Vorheriges Quartal | previous-quarter |
| Vorheriges Jahr | previous-year |
Die Schnittstelle generiert eine API-URL mit konkreten Daten, wenn Sie sich in der Datumsauswahl für die Option „Benutzerdefinierter Datumsbereich“ entscheiden. Wenn Sie zum Beispiel einen benutzerdefinierten Datumsbereich mit dem 22. April 20XX als Startdatum und dem 5. Mai 20XX als Enddatum ausgewählt haben, sieht Ihre API-URL folgendermaßen aus:
/filters?start_date=20XX-04-22&end_date=20XX-05-05
Die gewählte Zeitzonenverschiebung wird auf Ihren Bericht angewandt. Datum und Uhrzeit spiegeln die Zeitzone nur für die Spalten Transaktionsdatum, Transaktion Zeit, Bearbeitungsdatumund Prozesszeit wider.
Bei einem Bericht ohne diese Spalten, z. B. beim Sales and Activity Report, wird der Zeitzonenversatz angewendet. Bei Berichten, die diese Spalten enthalten, z. B. beim Individual Item Report, wird ebenfalls der Zeitzonenversatz angewendet, wie an dem konvertierten Transaktionsdatum und der konvertierten Zeit zu sehen ist.
Für die folgenden Datums- und Zeitspalten wird die Zeitzonenkonvertierung jedoch nicht durchgeführt:
- Buchungsdatum
- Klick-Datum
- Versanddatum der Bestellung
- Signature Match-Datum
- Signature Match-Zeit
- Transaktion erstellt am Datum
- Transaktion erstellt um Zeit
Datumsformat-Parameter
Dies ist ein optionaler Parameter mit Standardwerten. Sie können die Werte des Parameters date_format verschlüsselt oder unverschlüsselt in die Get-API-URL eingeben.
Achtung
Je nach Ihren lokalen Einstellungen kann es sein, dass Ihre Excel- oder andere Dateianwendungen unseren Datumsformat-Parameter bei bestimmten Datumsformaten nicht unterstützen oder außer Kraft setzen. Möglicherweise müssen Sie Ihre Anwendungen so anpassen, dass sie unseren Datumsformat-Parameter unterstützen.
API-Limit
Anfragen, die die Reporting-APIs verwenden, sind auf einen einzelnen Aufruf zu einem bestimmten Zeitpunkt beschränkt. Wenn wir mehr als eine Anfrage gleichzeitig erhalten, erhalten Sie bei allen weiteren Anfragen eine Fehlermeldung, bis eine oder mehrere ihrer bestehenden Anfragen abgeschlossen sind. Die Fehlermeldung wird eine HTTP-Antwort mit dem Statuscode 429 und dem Wortlaut „Sie haben die Anfragelimits für diese Sitzung überschritten, bitte versuchen Sie es später erneut ” sein.
Sehen Sie sich weitere Beispiele für mögliche API-Fehlermeldungen an.
Wenn Sie skriptgesteuerte Aufrufe verwenden, stellen Sie sicher, dass Sie nicht mehr als einen Aufruf gleichzeitig vornehmen, wie z. B. in einer Thread-Schleife. Wenn Sie eine unbegrenzte Anzahl von API-Aufrufen ausführen, sollten Sie in Ihrem Code entweder eine Pause oder eine Begrenzung der Aufrufe vorsehen.
Kommentare
Bitte melden Sie sich an, um einen Kommentar zu hinterlassen.