Anmelden

Willkommen in unserem Support Center

Hier erhalten Sie Hilfe zu Integration und Live-Kampagnen.

Willkommen in unserem Support Center. Hier erhalten Sie Hilfe zu Integration und Live-Kampagnen.

Wie rufe ich Reportinformationen über die Criteo-API ab?

Zum Abruf eines Reports mithilfe der Criteo-API können Sie folgende Abfragen nutzen: 
  1. clientLogin
  2. scheduleReportJob
  3. getJobStatus
  4. getReportDownloadUrl

 

Listen von API-Abfragen und ‑Antworten

 
1. clientLogin
Gibt ein authToken zurück, das für alle folgenden Aufrufe zu nutzen ist.

Parameter:
Field Typ Beschreibung
Username xsd:string Benutzername des Advertisers
password xsd:string Passwort des Advertisers
source xsd:string Kurze Zeichenfolge, die Ihre Anwendung identifiziert, für Protokollzwecke. Diese Zeichenfolge sollte folgendes Format haben: „firmenName-anwendungsName-versionID“.

Response:
Field Typ Beschreibung
clientLoginResult xsd:string Das clientLoginResult ist das Authentifizierungstoken (authToken), zu nutzen in allen anderen Aufrufen. Es ist 48 Stunden lang gültig.
 
2. getAccount
Gibt allgemeine Account Informationen zurück.

Parameter:
N/A

Response:
Field Typ Beschreibung
Name des Werbetreibenden xsd:string Name dieses Accounts
E-Mail xsd:string E-Mail des Hauptkontakts für den Advertiser
currency xsd:string Währung für dieses Konto; Einheit
Zeitzone xsd:string Zeitzone für diesen Account; Einheit
country xsd:string Land für diesen Account; Einheit
 
3. getBudgets
Gibt die Liste der Budgets zurück, die den Auswahlkriterien entsprechen.

Parameter:
Field Typ Beschreibung
budgetSelector BudgetIDs[] Liste mit abzurufenden Budget-IDs. Falls leer, werden alle Budgets abgerufen.

Response:
Field Typ Beschreibung
getBudgetsResult Budget[] Liste mit Budgetobjekten
 
4. getCampaigns
Gibt die Liste der Kampagnen zurück, die den Auswahlkriterien entsprechen.

Parameter:
Field Typ Beschreibung
campaignSelector CampaignSelector BudgetID, CampaignID, CampaignStatus und BiddingStrategy können zum Abruf von Kampagnen genutzt werden.

Response:
Field Typ Beschreibung
getCampaignsResult Campaign[] Liste mit Kampagnenobjekten
 
5. getCategories
Gibt die Liste der Kategorien zurück, die den Auswahlkriterien entsprechen.

Parameter:
Field Typ Beschreibung
categorySelector CategorySelector CategoryID und Selected können zum Abruf von Kampagnen genutzt werden.

Response:
Field Typ Beschreibung
getCategoriesResult Category[] Liste mit Kategorieobjekten
 
6. mutateCategories
Aktualisiert Kategorien.

Parameter:
Field Typ Beschreibung
mutateCategories CategoryMutates[] Liste mit Änderungsvorgängen. Nur SET-Vorgänge sind zulässig.

Response:
Field Typ Beschreibung
jobResponse categoryMutateJobResponse[] Liste mit categoryJobResponseObjects. Jeder Vorgang hat eine eigene jobID, die sich mit getJobStatus prüfen lässt.
 
6. mutateCampaigns
Aktualisiert Kampagnen.

Parameter:
Field Typ Beschreibung
mutateCampaigns CampaignMutates[] Liste mit Änderungsvorgängen. Nur SET-Vorgänge sind zulässig.


Antwort:
Field Typ Beschreibung
jobResponse campaignMutateJobResponse[] Liste mit campaignJobResponseObjects. Jeder Vorgang hat eine eigene jobID, die sich mit getJobStatus prüfen lässt.


8. scheduleReportJob
Planung eines auszuführenden Reports.

Parameters:
Field Typ Beschreibung
reportJob ReportJob Ein reportJob-Objekt wird übergeben, indem der angeforderte Report beschrieben wird.

Response:
Field Typ Beschreibung
jobID xsd:int ID des angeforderten Vorgangs. Kann in getJobStatus und getReportDownloadURL genutzt werden.
jobStatus xsd:string Status der Anforderung. Falls der reportJob angenommen wurde, wird „Pending“ zurückgegeben.
reportJob ReportJob Anfängliche reportJob-Anforderung


9. getJobStatus
Ruft den Status eines Vorgangs ab, basierend auf der ID.

Parameter:
Field Typ Beschreibung
jobID xsd:int Die jobID, für die der Status abgerufen wird.

Response:
Field Typ Beschreibung
getJobStatusResult xsd:String Status des angeforderten Vorgangs; Aufzählung


10. getReportDownloadUrl
Gibt eine URL zurück, von der der Bericht mit der angegebenen Vorgangs-ID heruntergeladen werden kann. Nach Aufruf dieser Methode kann der Aufrufer eine reguläre HTTP-GET-Anfrage an die zurückgegebene URL ausführen, um den Bericht abzurufen. Die Berichte liegen im XML-Format vor.

Parameter:
Field Typ Beschreibung
jobID xsd:int Die jobID, für die die Download-URL abgerufen wird.

Response:
Field Typ Beschreibung
jobURL xsd:String Vollständige URL, über die der Bericht heruntergeladen werden kann.


11. getStatisticsLastUpdate
Gibt eine Liste von StatUpdate-Objekten zurück, um abgeschlossene Buchungen für den jeweiligen Statistiktyp anzuzeigen (bis jetzt ClicksAndImpressions und Sales).

Parameter:
Keine.

Antwort:
Field Typ Beschreibung
getStatisticsLastUpdateResult StatUpdate[] Liste mit StatUpdateObjects. Ein StatUpdate enthält einen Typ und ein Datum.

 

Objektbeschreibungen

 
Type Campaign
Field Typ Beschreibung
campaignID xsd:int ID der Kampagne
campaignName xsd:string Name der Kampagne
campaignBid BidInformation BidInformation (CPC Gebotsinformationen) für die Kampagne
budgetID xsd:decimal ID des Budgets, das die Kampagne nutzt
remainingDays xsd:int Anzahl der Tage, die diese Kampagne mit dem vorhandenen Budget weiterlaufen kann. Dieser Wert wird basierend auf dem aktuellen Kostentrend geschätzt.
Status xsd:string Status der Kampagne:
  • RUNNING: Die Kampagne ist aktuell aktiv.
  • NOT_RUNNING: Die Kampagne ist inaktiv.
  • DEAD: Die Kampagne ist archiviert (schreibgeschützt).
categoryBids CategoryBid[] Liste mit BidInformation (Gebotsinformationen), die einer Kategorie zugeordnet sind.


Typ Kategorie
Field Typ Beschreibung
categoryID xsd:int ID der Kategorie
categoryName xsd:string Name der Kategorie (abgerufen aus dem Katalogfeed)
avgPrice xsd:double Durchschnittlicher Preis der Produkte dieser Kategorie
numberOfProducts xsd:int Anzahl der Produkte, die mit dieser Kategorie gekennzeichnet sind
selected xsd:boolean „True“, wenn die Kategorie ausgewählt ist (ausgewählt bedeutet Verfügbarkeit für Gebote und Berichte)


Typ Budget
Field Typ Beschreibung
budgetID xsd:int ID des Budgets
budgetName xsd:string Name des Budgets
totalAmount xsd:int Gesamter zu diesem Budget hinterlegter Betrag
remainingBudget xsd:decimal Verfügbarer Betrag
remainingBudgetUpdated xsd:dateTime Uhrzeit, zu der remainingBudget ermittelt wurde


Typ BidInformation
Field Typ Beschreibung
biddingStrategy xsd:string Gebotsstrategie:
  • Cpc: Cost-per-Click
  • Cpa: Cost-per-Action
  • Cpm: Cost-per-Thousand
Hinweis: Nur CPC wird unterstützt.
cpcBid xsd:double Wert des Cost-per-Click
cpaBid CPABid CPABid enthält postClick, postView, commission und percent. (Noch nicht unterstützt.)


Typ CategoryBid
Field Typ Beschreibung
campaignCategoryUID xsd:int Globale UID, die die Kategorie für eine bestimmte Kampagne identifiziert
campaignID xsd:int ID der Kampagne, für die dieses Kategorie CPC Gebot gesetzt wird
categoryID xsd:int ID der Kategorie, für die dieses CPC Gebot gesetzt wird
selected xsd:boolean „True“, wenn die Kategorie ausgewählt ist (ausgewählt bedeutet Verfügbarkeit für Gebote und Berichte)
bidInformation BidInformation BidInformation (Gebotsinformationen) für das Kategoriegebot


Typ ReportJob
Field Typ Beschreibung
reportSelector CategoryIDs
CampaignIDs
Liste mit Kategorie- oder Kampagnen-IDs, für die der Report Daten abrufen soll
reportType xsd:string Typ des auszuführenden Reports:
  • Campaign
  • Kategorie
aggregationType xsd:string Typ der Aggregation für den Report:
  • Hourly
  • Daily
startDate xsd:string Startdatum des Reports (JJJJ-MM-TT)
endDate xsd:string Enddatum des Reports (JJJJ-MM-TT)
selectedColumns ReportColumn[] Liste der in dem Bericht angeforderten Spalten:
  • clicks
  • impressions
  • ctr
  • revcpc
  • ecpm
  • cost
  • Verkäufe
  • convRate
  • orderValue
  • salesPostView
  • convRatePostView
  • orderValuePostView
  • Cost of Sales
  • impressionWin
  • costPerOrder
isResultGzipped xsd:boolean „True“, falls der Report als ZIP-Datei gepackt sein muss.

 

War dieser Beitrag hilfreich?
0 von 2 fanden dies hilfreich
Powered by Zendesk