Esegui rapporti tramite API

Introduzione

Puoi eseguire qualsiasi dei tuoi report di Rakuten Advertising, sia standard che personalizzati, tramite l'API di Reporting. Questo ti consente di eseguire report senza accedere al tuo account.

Istruzioni

Segui questi passaggi per ottenere l'URL dell'API per i tuoi report:

  1. Accedi all'Interfaccia dei Report.
  2. Seleziona un report standard dal menu a discesa Scegli Report o crea il tuo.
  3. Imposta un intervallo di date per il tuo report.
  4. Se desideri personalizzare ulteriormente il report, applica filtri o aggiungi o rimuovi colonne di metriche e punti dati, quindi fai clic su Salva Report.
  5. Fai clic sulla freccia accanto a Visualizza Report e seleziona Ottieni API:

    Opzioni di menu con "Ottieni API" evidenziato.

  6. Appare un pop-up Ottieni URL API. Mostra un URL che include il tuo token web. Copia l'URL dell'API e salvalo in un luogo sicuro.

 Attenzione

Il tuo URL API presenta un token che ti consente di accedere ai tuoi dati di reportistica senza accedere al tuo account. Dovresti tenerlo al sicuro come faresti con il tuo nome utente e password. Consulta la sezione URL API qui sotto per ulteriori informazioni sul parametro del token.

Applicazione

Puoi incollare l'URL dell'API in qualsiasi browser in qualsiasi momento per generare il tuo report senza dover accedere all'Interfaccia dei Report. Il file CSV con i dati del tuo report verrà scaricato sul tuo computer. I file CSV possono essere aperti in Excel.

URL API

Puoi modificare i parametri API esistenti che stai attualmente utilizzando o creare nuovi URL di API di reportistica senza tornare all'Interfaccia dei Report. Questo è un esempio di URL 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

Puoi modificare le parti mostrate in verde. Fai clic sul + accanto a ciascun nome di parametro per ulteriori informazioni:

Data di inizio primaria
Testo visualizzato: start_date=20XX-01-01

Descrizione: Imposta la data di inizio per il primo intervallo di date nel tuo report. Usa il formato YYYY-MM-DD.

Data di fine primaria
Testo visualizzato: end_date=20XX-07-21

Descrizione: Imposta la data di fine per il primo intervallo di date nel tuo report. Usa il formato YYYY-MM-DD.

Includi riepilogo
Testo visualizzato: include_summary=Y

Descrizione: Imposta su Y se desideri la sezione di riepilogo in cima al file del report. Imposta su N se non lo desideri. Per impostazione predefinita, è impostato su Y.

Network
Testo visualizzato: network=

Descrizione: Usa questa impostazione per mostrare i dati solo per un network. Questo impedisce che valute diverse appaiano nello stesso report. Usa questi valori per ciascun network:

  • US = 1
  • UK = 3
  • CA = 5
  • BR = 8
  • AU = 41
  • FR = 7
  • DE = 9
  • JP = 11
Data di inizio precedente
Testo visualizzato: previous_start_date=20XX-01-01

Descrizione: Imposta la data di inizio per il secondo intervallo di date nel tuo report. Usa il formato YYYY-MM-DD.

Data di fine precedente
Testo visualizzato: previous_end_date=20XX-07-21

Descrizione: Imposta la data di fine per il secondo intervallo di date nel tuo report. Usa il formato YYYY-MM-DD.

Fuso orario
Testo visualizzato: tz=GMT

Descrizione: Imposta il fuso orario utilizzato dal report. GMT è il fuso orario predefinito. Quando selezioni le date nell'interfaccia dei report, il fuso orario scelto appare nell'URL dell'API. Scopri di più sulla personalizzazione del fuso orario per il tuo report.

Tipo di data
Testo visualizzato: date_type=process

Descrizione: Imposta il tipo di data utilizzato nel report. Usa process per la data di elaborazione e transaction per la data della transazione.

Formato della data
Testo visualizzato: date_format=XXXX/XX/XX

Descrizione: Questa impostazione è facoltativa e ha valori predefiniti. Usa una delle opzioni seguenti per formattare le date nel tuo report. Se non specifichi un formato, il predefinito è m/d/yy per la maggior parte dei network e yyyy/mm/dd per il network Giappone. Le opzioni che puoi utilizzare sono:

  • 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
Token
Testo visualizzato: token=xxxxxxxxxx

Descrizione: Questo token mantiene i tuoi dati sicuri. Tieni il tuo token al sicuro e non inviarlo a nessuno tramite email. Se hai bisogno di un nuovo token, clicca su Aggiorna API Token nell'angolo in alto a destra di qualsiasi report nell'interfaccia.

Intervalli di date preimpostati

Puoi utilizzare date di inizio e fine esatte e intervalli di date preimpostati nell'URL dell'API. Utilizzare intervalli di date preimpostati ti evita di dover calcolare le date specifiche per le tue chiamate API. Quando selezioni un intervallo di date preimpostato dal menu a tendina nell'interfaccia dei report, l'URL dell'API utilizza quel valore preimpostato come segue:

Intervallo di date preimpostato Valori per il parametro date_range
Ieri yesterday
Ultimi 7 giorni last-7-days
Questo mese this-month
Lo scorso mese last-month
Questo trimestre this-quarter
Lo scorso trimestre last-quarter
Quest'anno this-year
L'anno scorso last-year

Quando confronti il tuo report con un altro periodo, puoi utilizzare questi valori per il previous_date_range:

Intervallo di date Valori dell'intervallo di date
Settimana precedente previous-week
Mese precedente previous-month
Trimestre precedente previous-quarter
Anno precedente previous-year

Se selezioni un intervallo di date personalizzato utilizzando il selettore di date nell'interfaccia dei report, l'URL dell'API mostrerà le date specifiche. Ad esempio, se selezioni un intervallo di date personalizzato con il 22 aprile 20XX come data di inizio e il 5 maggio 20XX come data di fine, l'URL includerà:

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

Il fuso orario selezionato verrà applicato al tuo report. Date e orari rifletteranno solo il fuso orario per le colonne Data della Transazione, Ora della Transazione, Data di Elaborazione e Ora di Elaborazione.

L'offset del fuso orario verrà applicato ai report che non includono queste colonne, come il Sales and Activity Report. I report che includono queste colonne, come il Individual Item Report, avranno anche l'offset del fuso orario applicato come visto nella data e ora della transazione convertite.

Tuttavia, la conversione del fuso orario non viene effettuata per le seguenti colonne di data e ora:

  • Data di Consumo della Prenotazione
  • Data di Clic
  • Data di Spedizione dell'Ordine
  • Data di Corrispondenza della Signature
  • Ora di Corrispondenza della Signature
  • Data di Creazione della Transazione
  • Ora di Creazione della Transazione

Parametro Formato Data

Questo parametro è facoltativo e ha valori predefiniti. Puoi inserire i valori del parametro date_format nell'URL dell'API Get. Puoi utilizzare valori codificati o non codificati.

 Attenzione

A seconda delle impostazioni del tuo computer, programmi come Excel potrebbero non supportare o potrebbero modificare il formato data impostato nell'URL dell'API. Potrebbe essere necessario regolare le impostazioni del programma per supportare il nostro parametro formato data.

Limite API

Puoi eseguire solo una chiamata API di report alla volta. Se invii più di una richiesta contemporaneamente, riceverai un errore sulle richieste extra e su tutte le richieste successive fino a quando una o più delle tue richieste esistenti non saranno completate. L'errore è una risposta HTTP 429 con il messaggio Hai superato i limiti di richiesta per questa sessione, riprova più tardi.

Se utilizzi script per eseguire chiamate API, assicurati che il tuo script non tenti di eseguire più chiamate contemporaneamente. Ad esempio, evita di utilizzare cicli con thread che effettuano chiamate illimitate. Se devi effettuare molte chiamate, aggiungi una pausa o un limite nel tuo codice tra le richieste.

Errori API

Potresti ricevere un codice di errore o un messaggio mentre esegui i tuoi report tramite API. Visualizza esempi di possibili errori API e istruzioni su come risolverli. Per ulteriore assistenza con errori API, contatta il Supporto Clienti.

 

 

Questo sito web utilizza l'IA per le traduzioni, che potrebbero contenere imprecisioni o errori. Non siamo responsabili per problemi derivanti dall'affidamento al contenuto tradotto; consulta la versione originale in inglese per informazioni autorevoli.

Questo articolo è stato utile?
Utenti che ritengono sia utile: 0 su 0

Commenti

0 commenti

Accedi per aggiungere un commento.