Eseguire i rapporti tramite API

Introduzione

Puoi eseguire tutti i tuoi report di Rakuten Advertising, sia standard che personalizzati, tramite l'API di Reporting. Questo ti permette di eseguire i rapporti senza accedere al tuo account.

Istruzioni:

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

  1. Accedi all' interfaccia dei report.
  2. Seleziona un rapporto standard dal menu a discesa Scegli i rapporti o creane uno.
  3. Seleziona i parametri dell'intervallo di date.
  4. Se lo desideri, puoi personalizzare il rapporto applicando eventuali filtri o aggiungendo o rimuovendo colonne di metriche e punti dati e cliccare su Salva rapporto.
  5. Clicca sulla freccia accanto a Visualizza rapporto e selezioni Ottieni API:

    get api.png

  6. Comparirà un pop-up Ottieni URL API. Questo indica un URL che include il tuo token web. Copia l'URL dell'API e salvalo in una posizione sicura.

 Attenzione

Il tuo URL API contiene un token che consente di accedere ai dati del tuo report senza effettuare il login al tuo account. Dovrebbe essere conservato con la stessa cautela con cui conserveresti il tuo nome utente e la tua password. Per maggiori informazioni sul parametro token, vedi la sezione URL API qui sotto.

Applicazione

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

URL API

Puoi modificare i parametri API esistenti che stai utilizzando o creare nuovi URL di reporting API senza tornare al sito 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=processo&date_format=m-d-yy&token=xxxxxxx

Tutto ciò che è in verde può essere modificato. Per maggiori informazioni, clicca sul + accanto al nome di ciascun parametro:

Data di inizio primaria
Testo visualizzato: data di inizio=20XX-10-25

Descrizione: la data di inizio del primo intervallo temporale per i dati del report. Formattata in AAAA-MM-GG.

Data di fine primaria
Testo visualizzato: end-date=20XX-10-26

Descrizione: la data di fine del primo intervallo temporale per i dati del report. Formattata in AAAA-MM-GG.

Includi riepilogo
Testo visualizzato: include_summary=Y

Descrizione: imposta questo valore su Y se desideri che il riepilogo del rapporto a sei righe sia visualizzato nella parte superiore del file scaricato. In caso contrario, impostarla su "N". L'impostazione predefinita è Y.

Network
Testo visualizzato: network=1

Descrizione: utilizza questo filtro per visualizzare i dati di un solo network alla volta, in modo da non far apparire più valute nello stesso report.

  • 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-09-25

Descrizione: la data di inizio del secondo intervallo per i dati del report. Formattato AAAA-MM-GG.

Data di fine precedente
Testo visualizzato: previous-end-date=20XX-09-26

Descrizione: la data di fine del secondo intervallo temporale per i dati del report. Formattato AAAA-MM-GG.

Fuso orario
Testo visualizzato: tz=GMT

Descrizione: questo è il fuso orario utilizzato dal rapporto. GMT è il fuso orario predefinito. Gli utenti possono cambiare il fuso orario quando selezionano le date e visualizzarlo nell'API.

Tipo di data
Testo visualizzato: date_type=process

Descrizione: il tipo di data. Utilizza il processo per data di elaborazione e transazione per data della transazione.

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

Descrizione: si tratta di un parametro opzionale con valori predefiniti. Utilizzare uno dei campi sottostanti per formattare le date nel report. Se non viene specificato, i valori predefiniti per tutte le reti saranno m/g/aa per i network non giapponesi e aaaa/mm/gg per il network giapponese. I valori ammessi in questo parametro sono:

  • m/g/AA
  • AAAA/mm/gg
  • mm/gg/AA
  • gg/mm/AA
  • gg/mm/AAAA
  • m-g-aa
  • AAAA-mm-gg
  • mm-gg-AA
  • gg-mm-AA
  • gg-mm-AAAA
Gettone
Testo visualizzato: token=xxxxxxxx xx

Descrizione: questo token garantisce la sicurezza dei dati. È derivato dal suo Security Token. Tenga il token al sicuro. Non modifichi questo valore. Se desidera aggiornare il suo token, può farlo nel sito Publisher Dashboard.

Intervalli di date predefiniti

Supportiamo sia gli intervalli di date preimpostati che gli intervalli di date esatte, come specificato nei valori start_date e end date.

Questo riduce la necessità di una logica aggiuntiva per generare le date per le API. L'interfaccia dei report imposterà l'URL di API in modo che utilizzi l'intervallo di date preimpostato quando scegli un intervallo di date preimpostato dal menu a tendina.

Intervallo di date predefinito Valori del periodo "corrente" per il parametro date_range
Ieri yesterday
Ultimi 7 giorni last-7-days
Questo mese this-month
Il mese scorso last-month
Questo trimestre this-quarter
Ultimo trimestre last-quarter
Quest'anno this-year
Ultimo anno last-year

Quando si esegue il confronto con un altro periodo, questi sono i valori di 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

L'interfaccia genererà un URL API con date specifiche, se scegli Intervallo di date personalizzato dal selezionatore di date. Ad esempio, se hai selezionato un Intervallo di date personalizzato con il 22 aprile 20XX come data di inizio e il 5 maggio 20XX come data di fine, ecco come apparirà il tuo URL API:

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

L'offset del fuso orario selezionato verrà applicato al report. Le date e gli orari rifletteranno il fuso orario solo per le colonne data della transazione, ora della transazione, data di elaborazione e le colonne del Tempo di elaborazione.

Un report senza queste colonne, come Sales and Activity Report avrà l'offset del fuso orario applicato. I report che includono queste colonne, come Individual Item Report, avranno anche l'offset del fuso orario applicato, come si vede nella conversione di Data e ora della transazione.

Tuttavia, la conversione del fuso orario non viene effettuata per le seguenti colonne Data e Ora:

  • Prenotazione data di consumo
  • Data di clic
  • Data di spedizione dell'ordine
  • Data signature match
  • Tempo signature match
  • Transazione creata alla data
  • Transazione creata in orario

Parametro Formato data

È un parametro opzionale con valori predefiniti. Puoi inserire i valori del parametro date_format codificati o non codificati nell'URL API Get.

 Attenzione

A seconda delle impostazioni locali, Excel o altre applicazioni di file potrebbero non supportare o sovrascrivere il nostro parametro di formato data in alcuni formati di data. Potrebbe essere necessario modificare le applicazioni per supportare il parametro del formato della data.

Limite API

Le richieste che utilizzano le API di reportistica sono limitate a una chiamata simultanea per volta. In caso di ricezione simultanea di più di una richiesta in esecuzione, riceverai un errore per tutte le ulteriori richieste fino al completamento di una o più richieste esistenti. L'errore sarà la risposta HTTP 429 con il messaggio "Hai superato i limiti di richiesta per questa sessione, riprova più tardi".

Visualizza altri esempi di possibili errori API.

Se si utilizzano chiamate da script, accertarsi di non effettuare più di una chiamata simultanea, come ad esempio in un ciclo di thread. Se si esegue un numero illimitato di chiamate API, inserire nel codice una pausa o un limite alle chiamate.

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

Commenti

0 commenti

Accedi per aggiungere un commento.