Table of contents
Criteo REST API für Reseller
Unten finden Sie die wichtigsten Features der Criteo Reseller Program REST API, die es Ihnen erlauben, Budgets und Gebote von Kampagnen auf Verkäufer-Level zu verwalten.
Wir nutzen JWT zur Bereitstellung eines Token-basierten Authentifizierungssystems für unsere REST API. Um Aufrufe an unsere API zu tätigen, müssen Sie bei jedem Aufruf ein Token übergeben.
Sie erhalten Ihr Token, indem Sie einen POST-Aufruf an den Endpunkt /oauth2/token tätigen und dabei die Parameter client_id und client_secret angeben (siehe Abschnitt „Erste Schritte“).
Rufen Sie Ihre AdvertiserID ab, indem Sie einen GET-Aufruf an den Endpunkt /portfolio/ senden.
Rufen Sie Ihre CampaignID ab, indem Sie einen GET-Aufruf an den Endpunkt /sellers/ senden.
Zum Einrichten eines neuen Verkäufers sollten Sie sichergehen, dass dieser im Product Feed, den Sie zuvor mit Criteo geteilt haben, korrekt markiert ist.
Um die korrekte Markierung des neuen Verkäufers sicherzustellen, müssen Sie in der Spalte Verkäufername für jedes im Feed bereitgestellte Produkt des jeweiligen Verkäufers den eindeutigen Bezeichner dieses Verkäufers (der Name des Verkäufers) eintragen.
Nach den obigen Schritten können Sie uns das Budget und die Gebote Ihres Verkäufers senden. Dies erfolgt über die zuvor beschriebenen Schnittstellen für Verkäufer, insbesondere:
- PUT /v1/sellers/bids zum Übermitteln des CPC für den Verkäufer
- POST /v1/sellers/budgets zum Übermitteln des Budgets für den Verkäufer
ENTFERNEN DER DATEN EINES VERKÄUFERS AUS DEM CRITEO RESELLER PROGRAMM
Wenn Sie einen Verkäufer aus dem Criteo Reseller Program entfernen wollen, müssen Sie diesen Verkäufer lediglich innerhalb der Kampagne stoppen. Näheres im Abschnitt "Einen Verkäufer stoppen".
Alternativ können Sie auch die Produkte des Verkäufers aus ihrem Product Feed entfernen. Dies wirkt sich jedoch erst aus, nachdem Criteo die Verarbeitung von Feed und Kategorien abgeschlossen hat. Darüber hinaus verlangt das erneute Hinzufügen einen erhöhten Zeitaufwand, da Feed und Kategorien erneut verarbeitet werden müssen. Beachten Sie zudem: Sobald ein Verkäufer aus dem Feed entfernt worden ist, stehen für ihn keine Statistiken mehr zur Verfügung.
Stellen Sie zum Start einer Kampagne im Criteo Reseller-Programm zuerst einen dedizierten Product Feed bereit. Dieser sollte Produkte von allen Händlern/Partnern enthalten, die beim Programm angemeldet sind. Hinweis: Bei jedem Produkt sollte der eindeutige Bezeichner des Händlers/Partners im Feld „Verkäufer“ angegeben sein.
Die Kampagne wird automatisch erstellt, sobald Ihr Feed verarbeitet ist.
Damit die Kampagne online gehen kann, benötigt sie mindestens einen Verkäufer mit einem bereits festgelegten Budget und Gebot. Sie können diese Daten über die Endpunkte PUT /v1/sellers/bids Und POST /v1/sellers/budgets übermitteln.
Zum Stoppen Ihrer gesamten Kampagne im Criteo Reseller-Programm (für alle Verkäufer) wenden Sie sich an Ihren Account Manager.
Um einen oder mehrere Verkäufer in Ihrer Kampagne zu stoppen, setzen Sie deren Budgets einfach auf "inaktiv". Danach zeigt das System keine Ads für die Produkte dieses Verkäufers mehr an.
Um ein Budget auf "inaktiv" zu setzen, machen Sie bitte einen PUT-Aufruf an den Endpunkt sellers/budgets wie unten beschrieben:
- PUT /sellers/budgets mit Status = Inactive
Sie müssen nichts unternehmen. Wir erkennen, wenn das Budget von Verkäufern verbraucht ist, und stoppen ihre Kampagnen, sobald dies der Fall ist.
Mithilfe folgender Endpunkte können Sie das Budget und den CPC eines bestimmten Verkäufers festlegen:
- Gebote: Zur Initialisierung und Aktualisierung senden Sie einen PUT-Aufruf an den Endpunkt /sellers/bids.
- Budgets:
- Zur Initialisierung senden Sie einen POST-Aufruf an den Endpunkt /v1/sellers/budgets.
- Zur Budget-Aktualisierung senden Sie einen PUT-Aufruf an den Endpunkt /v1/sellers/budgets.
Zur Erhöhung eines Budgets und des CPCs für einen bestimmten Verkäufers tätigen Sie einen PUT-Aufruf an die Endpunkte /v1/sellers/budgets und v1/sellers/bids.
Möchte Ihr Verkäufer seinen CPC senken, richten Sie einen POST-Aufruf an den Endpunkt /v1/sellers/bids.
Will der Verkäufer sein Budget verringern, müssen Sie den aktuellen Status auf "Inactive" setzen. Dadurch werden die Anzeigen unter dem aktuellen Budget ab dem Tag der Ausführung unsichtbar gemacht. Danach müssen Sie ein neues Budget mit dem niedrigeren Wert einrichten. Näheres finden Sie im Abschnitt "Ein neues Budget erstellen". Dieses Budget tritt einen Tag später (Zeitzone UTC) in Kraft.
BEISPIEL:
Tag 0, Verkäufer A hat anfangs einen Budget von 1.000 US-Dollar für seine Kampagne des Criteo Reseller-Programms festgelegt.
Tag 2, Verkäufer A hat noch ein Restbudget von 800 US-Dollar, will sein verfügbares Budget aber auf 500 US-Dollar senken.
Führen Sie also folgende API-Aufrufe aus:
- PUT-Aufruf an den Endpunkt /sellers/budgets/
- Setzen des Status auf Inactive
- (Der genaue Budgetbetrag muss nicht angegeben werden, denn Status hat Priorität)
- POST-Aufruf an den Endpunkt /sellers/budgets
- Setzen des Amount auf 500
- (Der Status muss nicht explizit angegeben werden; bleibt er leer, wird er als Active angenommen.)
BUDGETS ERSTELLEN
In den folgenden zwei Fällen können Sie neue Budgets erstellen:
- Für den jeweiligen Tag besteht noch kein Budget.
- Das Budget für den jeweiligen Tag ist inaktiv.
Um ein neues Budget für einen Verkäufer zu erstellen, führen Sie bitte den folgenden Schritt aus:
- POST-Aufruf an den Endpunkt /sellers/budgets
Wann tritt das neue Budget in Kraft?
- Entweder sofort, wenn Sie für den aktuellen Tag noch kein Budget eingerichtet haben.
- Oder am darauffolgenden Tag, wenn das Budget für den aktuellen Tag inaktiv ist.
Als Erstes sollte der Verkäufer Ihnen das aktualisierte Budget mitteilen.
Nun gibt es drei verschiedene Szenarien mit jeweils unterschiedlichen Aktionen:
- Sie kennen das neue Budget bereits und es ist niedriger als das anfänglich festgelegte Budget:
- Führen Sie die Aktionen aus dem Abschnitt „Wie verringere ich ein Budget/einen CPC?“ aus.
- Sie kennen das neue Budget bereits und es ist höher als das anfänglich festgelegte Budget:
- Führen Sie die Aktionen aus dem Abschnitt „Budget und CPC erhöhen“ aus.
- Sie kennen das neue/richtige Budget nicht:
- Führen Sie die Aktionen aus dem Abschnitt „Einen Verkäufer entfernen“ aus.
- Führen Sie die Aktionen aus dem Abschnitt „Einen Verkäufer entfernen“ aus.
Als Erstes sollte der Verkäufer Ihnen den aktualisierten CPC angeben. Senden Sie dann einen PUT-Aufruf an den Endpunkt sellers/bids/, um das aktualisierte Gebot festzulegen.
Unsere API stützt sich bei der Verwaltung der Gebote und Budgets auf den sellerName. Daher wird bei jeder Änderung des Verkäufernamens automatisch ein neuer Eintrag in unserem System angelegt. Dieser ist nicht mit dem vorherigen Verkäufernamen verknüpft.
Hier eine Zusammenfassung der Schritte, die Sie unternehmen müssen, wenn ein Verkäufer auf Ihrer Plattform seinen Namen ändert:
- Aktualisieren Sie den Product Feed mit dem neuen sellerName.
- Initialisieren Sie das Gebot und Budget Ihres Verkäufers, indem Sie Aufrufe an PUT /v1/sellers/bids und POST /v1/sellers/budgets senden.
Sie können eine Übersicht über das ausgegebene Budget eines bestimmten Verkäufers für eine Kampagne im Criteo Reseller-Programm erhalten, indem Sie einen GET-Aufruf an den Endpunkt /v1/sellers senden. Diese Information wird dann als spentAmount zurückgegeben.
Sie können eine Übersicht über das verbleibende Budget eines bestimmten Verkäufers für eine Kampagne im Criteo Reseller-Programm erhalten, indem Sie einen GET-Aufruf an den Endpunkt /v1/sellers senden. Diese Information wird dann als remainingAmount zurückgegeben.
Sie können einen POST-Aufruf an den Endpunkt /v1/sellers/stats tätigen. Auf Klicks und Kosten kann nur auf Verkäuferebene zugegriffen werden, und maximal tagesgenau.
Maximal 3 Dimensionen können genutzt werden; dazu muss die Dimension für den Verkäufer gehören.
Verfügbare Dimensionen:
- AdvertiserID
- campaignID
- Verkäufer – Notwendig
- Jahr
- Woche
- Tag
Verfügbare Metriken:
- Anzeigen
- Clicks
- AdvertiserCost