Sommario
L'API REST di Criteo per rivenditori
Di seguito, troverai i concetti chiave dell'API REST del programma Criteo Reseller, che ti consente di gestire le offerte e i budget delle campagne al livello dei venditori.
Utilizziamo JWT per fornire il sistema di autenticazione basato su token alla nostra API REST. Allo scopo di richiamare la nostra API, avrai bisogno di trasmettere un token in relazione a ciascuna di tali chiamate.
Per ottenere il token, dovrai richiamare l'endpoint POST /oauth2/token, con client_id e client_secret quali parametri (vedi la sezione Inizia).
Recupera l'ID inserzionista richiamando l'endpoint GET /portafoglio/.
Recupera il tuo CampaignID richiamando l'endpoint GET /rivenditore/.
Per inserire un nuovo venditore, è necessario verificare che sia identificato correttamente nel catalogo Feed del prodotto che hai condiviso in precedenza con Criteo.
Per verificare che il venditore sia identificato correttamente, sarà necessario impostare la colonna relativa al nome del rivenditore con l'identificativo unico del rivenditore, che è il nome del rivenditore per ciascuno dei prodotti del rivenditore forniti nel feed.
Dopo le fasi riportate sopra, sarai in grado di inviarci il budget e le offerte dei tuoi rivenditori grazie ai loro endpoint, descritti in precedenza, e in particolare:
- PUT /v1/rivenditori/offerte per inviarci il CPC del rivenditore
- POST /v1/rivenditori/budget per inviarci il budget del rivenditore
RIMOZIONE DEI DATI DI UN VENDITORE DAL PROGRAMMA CRITEO RESELLER
Se desideri rimuovere un venditore dal programma Criteo Reseller, è sufficiente che tu blocchi questo venditore all'interno della campagna (vedi la sezione “Come bloccare un venditore”).
In alternativa, puoi anche rimuovere i prodotti del venditore dal feed dei prodotti. Tuttavia, questo avrà effetto solo dopo che Criteo avrà completato l'ingesting di feed e categoria. Inoltre, per aggiungerlo nuovamente sarà necessario anche più tempo in quanto richiederà l'ingesting di un nuovo feed e di una nuova categoria Infine, quando il venditore è stato rimosso dal feed, le statistiche di questo venditore non saranno più disponibili.
Per avviare una campagna del programma Criteo Reseller, è necessario fornirci un feed del prodotto dedicato contenente i prodotti di tutti i rivenditori coinvolti nel programma. Ricorda che ciascuno di questi prodotti deve presentare un identificatore unico relativo al rivenditore nel campo rivenditore.
La tua campagna verrà automaticamente creata dal momento in cui avviene l'ingesting del feed.
Perché diventi attiva la campagna deve presentare almeno un rivenditore con budget e offerta già impostati. È possibile inviarli tramite gli endpoint PUT /v1/rivenditori/offerte e POST /v1/rivenditori/budget.
Per interrompere uno o più rivenditori all'interno della tua campagna, è necessario impostare i loro budget come "Non attivo". A quel punto, il sistema smetterà di mostrare annunci per i prodotti di quel rivenditore.
Per impostare un budget come "Inattivo", è necessario richiamare l'endpoint PUT /rivenditori/budget come descritto di seguito:
- PUT /rivenditori/budget con stato = Inattivo
Tu non puoi fare nulla. Anticipiamo l'esaurimento del budget di tutti i rivenditori e interrompiamo le relative campagne in qualunque momento si stia esaurendo il budget.
Per impostare il budget e il CPC per un rivenditore, è necessario utilizzare i seguenti endpoint:
- Offerte: per l'inizializzazione e l'aggiornamento, richiama l'endpoint PUT /rivenditori/offerte
- Budget:
- Per l'inizializzazione: richiama l'endpoint POST /v1/rivenditori/budget
- Per l'aggiornamento del budget: richiama l'endpoint /v1/rivenditori/budget
Per aumentare un budget e il CPC per un rivenditore specifico, devi richiamare gli endpoint PUT /V1/rivenditori/budget e /V1/rivenditori/offerte.
Nel caso il rivenditore desideri ridurre il suo CPC, è necessario richiamare l'endpoint POST /v1/rivenditori/offerte.
Nel caso il rivenditore desideri ridurre il suo budget, sarà necessario impostare lo stato corrente su Non attivo - ciò interromperà le visualizzazioni sul budget corrente il giorno stesso (G) in cui si esegue l'azione. Dopodiché, è possibile creare un nuovo budget con il valore ridotto (vedi la sezione “Come creare un nuoco budget”). Questo inizierà (G+1), ora UTC
ESEMPIO:
Giorno 0, il rivenditore A ha inizialmente impostato un valore del budget pari a $ 1000 per la campagna del programma Criteo Reseller.
Giorno 2, il rivenditore A ha un budget pari a $ 800 MA decide di ridurre il suo budget disponibile a $ 500.
Quindi è necessario procedere come segue:
- Richiama l'endpoint PUT /rivenditori/budget/
- Imposta lo stato su Non attivo
- (Non è necessario precisare nessun valore del budget qui, budgetStatus (Stato budget) ha la priorità)
- Richiama l'endpoint POST /rivenditori/budget/
- Imposta importo su 500
- (Non è necessario precisare nessuno stato qui; se viene lasciato vuoto, si presume che sia Attivo)
CREAZIONE DI BUDGET
È possibile creare un nuovo budget in presenza di uno solo dei due casi:
- non possiedi un budget per il giorno corrente
- possiedi un budget non attivo per il giorno corrente
Per creare un nuovo budget per un rivenditore, sarà necessario richiamare
- Richiama l'endpoint POST /rivenditori/budget/
Il nuovo budget avrà effetto in uno dei due casi:
- Subito, non possiedi un budget per il giorno corrente
- Domani, se hai un budget non attivo per il giorno corrente
Primo, sarà necessario che il tuo rivenditore ti fornisca il budget aggiornato.<br>Quindi, esistono tre scenari principali che portano ad azioni diverse:
- Hai già il nuovo budget ed è minore del budget iniziale impostato:
- Applica le azioni descritte nella sezione "Come posso ridurre un budget/CPC"
- Hai già il nuovo budget ed è maggiore del budget iniziale impostato:
- Applica le azioni descritte nella sezione "Come posso aumentare un budget/CPC"
- Non hai il budget nuovo/corretto:
- Applica le azioni spiegate nella sezione "Come posso rimuovere un rivenditore"
- Applica le azioni spiegate nella sezione "Come posso rimuovere un rivenditore"
Primo, sarà necessario che il tuo rivenditore ti fornisca il CPC aggiornato. Dovrai inoltre richiamare l'endpoint PUT rivenditori/offerte/ per impostare l'offerta aggiornata.
Poiché la nostra API si basa essenzialmente su sellerName (Nome venditore) per la gestione di offerte e budget, qualunque cambiamento relativo al nome del rivenditore creerà automaticamente una nuova voce nel nostro sistema, non correlata al precedente nome del rivenditore.<br>In poche parole, se un rivenditore modifica il suo nome sulla tua piattaforma, sarà necessario:
- Aggiornare il tuo feed del prodotto con il nuovo sellerName (Nome venditore)
- Inizializzare l'offerta e il budget del rivenditore inviandoci un'istruzione PUT /v1/rivenditori/offerte e POST /v1/rivenditori/budget.
Per visualizzare il budget speso relativo a un rivenditore dedicato per una campagna del programma Criteo Reseller, richiama l'endpoint GET /v1/rivenditori. Le informazioni saranno disponibili come spentAmount (Budget speso).
Per visualizzare il budget speso relativo a un rivenditore dedicato per una campagna del programma Criteo Reseller, richiama l'endpoint GET /v1/rivenditori. Le informazioni saranno disponibili come remainingAmount (Importo residuo).
ResocontiPuoi richiamare l'endpoint POST /v1/rivenditori/statistiche. È possibile unicamente accedere a impression, clic e costo a livello di rivenditore, disponibili fino a un livello di granularità giornaliero.
Possono essere utilizzate massimo 3 dimensioni e devono contenere la dimensione del rivenditore.
Dimensioni disponibili:
- ID inserzionista
- campaignID
- Rivenditore – Obbligatorio
- Anno
- Settimana
- Giorno
Metriche disponibili:
- Display
- Clic
- Costo inserzionista