Aanmelden

Welkom bij ons Support Center

Voor hulp met integratie en live campagnes.

Welkom bij ons Support Center. Voor hulp met integratie en live campagnes.

Hoe kan ik de rapportage-informatie aanroepen met de Criteo API?

Met de volgende query's kunt u een rapport aanroepen met de Criteo API: 
  1. clientLogin
  2. scheduleReportJob
  3. getJobStatus
  4. getReportDownloadUrl

 

Lijst van API-aanroepen en -reacties

 
1. clientLogin
Retourneert een AuthToken die kan worden gebruikt voor latere aanroepen.

Parameters:
Veld Type Beschrijving
gebruikersnaam xsd:string Gebruikersnaam adverteerder
wachtwoord xsd:string Wachtwoord adverteerder
bron xsd:string Korte string die uw applicatie identificeert voor het inloggen. De string moet als volgt zijn opgebouwd: "Bedrijfsnaam-Applicatienaam-versieID".

Antwoord:
Veld Type Beschrijving
clientLoginResult xsd:string De clientLoginResult is de authenticatiecode (authToken), die nodig is voor alle andere aanroepen. Deze is 48 uur geldig.
 
2. getAccount
Retourneert elementaire accountinformatie.

Parameters:
Niet beschikbaar.

Antwoord:
Veld Type Beschrijving
Naam van de adverteerder xsd:string Naam van dit account
email xsd:string E-mailadres van de hoofdcontactpersoon bij de adverteerder
Valuta xsd:string Valuta van dit account. Opsomming
tijdzone xsd:string Tijdzone van dit account. Opsomming
land xsd:string Land van dit account. Opsomming
 
3. getBudgets
Retourneert een lijst van budgetten die aan de selectorcriteria voldoet.

Parameters:
Veld Type Beschrijving
budgetSelector BudgetIDs[] Een lijst van op te halen budget-ID's. Een lege lijst betekent dat alle budgetten zijn opgehaald.

Antwoord:
Veld Type Beschrijving
getBudgetsResult Budget[] Een lijst van budgetdoelen.
 
4. getCampaigns
Retourneert een lijst van campagnes die aan de selectorcriteria voldoet.

Parameters:
Veld Type Beschrijving
campaignSelector CampaignSelector BudgetID,CampaignID,CampaignStatus en BiddingStrategy kunnen worden gebruikt om campagnes op te halen.

Antwoord:
Veld Type Beschrijving
getCampaignsResult Campaign[] Een lijst van campagnedoelen.
 
5. getCategories
Retourneert een lijst van categorieën die aan de selectorcriteria voldoet.

Parameters:
Veld Type Beschrijving
categorySelector CategorySelector CategoryID en Selected kunnen worden gebruikt om categorieën op te halen.

Antwoord:
Veld Type Beschrijving
getCategoriesResult Category[] Een lijst van categoriedoelen.
 
6. mutateCategories
Voor het bijwerken van categorieën.

Parameters:
Veld Type Beschrijving
mutateCategories CategoryMutates[] Een lijst van mutatiebewerkingen. Alleen SET-bewerkingen worden ondersteund.

Antwoord:
Veld Type Beschrijving
jobResponse categoryMutateJobResponse[] Een lijst van categoryJobResponseObjects. Elke bewerking heeft een eigen jobID, die gecontroleerd kan worden met GetJobStatus.
 
7. mutateCampaigns
Campagnes bijwerken.

Parameters:
Veld Type Beschrijving
mutateCampaigns CampaignMutates[] Een lijst van mutatiebewerkingen. Alleen SET-bewerkingen worden ondersteund.


Antwoord:
Veld Type Beschrijving
jobResponse campaignMutateJobResponse[] Een lijst van campaignJobResponseObjects. Elke bewerking heeft een eigen jobID, die gecontroleerd kan worden met GetJobStatus.


8. scheduleReportJob
Plant een uit te voeren rapport-job in.

Parameters:
Veld Type Beschrijving
reportJob ReportJob Een reportJob-doel wordt doorgegeven, waarin het gevraagde rapport wordt beschreven.

Antwoord:
Veld Type Beschrijving
jobID xsd:int ID van de gevraagde job. Kan worden gebruikt in getJobStatus en getReportDownloadURL.
jobStatus xsd:string Status van de aanvraag. Een geaccepteerde reportJob retourneert 'In behandeling'.
reportJob ReportJob De oorspronkelijke reportJob-aanvraag.


9 getJobStatus
Haalt een jobstatus op aan de hand van de ID.

Parameters:
Veld Type Beschrijving
jobID xsd:int De job-ID waarvoor de status is opgehaald.

Antwoord:
Veld Type Beschrijving
getJobStatusResult xsd:String Status van de aangevraagde job. Opsomming.


10. getReportDownloadUrl
Retourneert een URL vanwaar het rapport met de betreffende job-ID kan worden gedownload. Na gebruik van deze methode kan de aanroeper een gewone HTTP GET op de geretourneerde URL uitvoeren om het rapport op te halen. Het rapport heeft een XML-indeling.

Parameters:
Veld Type Beschrijving
jobID xsd:int De job-ID waarvoor een download-URL is opgehaald.

Antwoord:
Veld Type Beschrijving
jobURL xsd:String Volledige URL vanwaar het rapport kan worden gedownload.


11. getStatisticsLastUpdate
Retourneert een lijst met Statupdate-objecten om voor het gerelateerd type statistieken "boeken gesloten" aan te geven (ClicksAndImpressions, Sales for now)>

Parameters:
Geen.

Antwoord.
Veld Type Beschrijving
getStatisticsLastUpdateResult StatUpdate[] Lijst van StatUpdateObjects. Een StatUpdate bestaat uit een type en een datum.

 

Beschrijvingen van objecten

 
Campagne-Type
Veld Type Beschrijving
campaignID xsd:int ID van de campagne.
campaignName xsd:string Naam van de campagne.
campaignBid BidInformation Biedingsinformatie van de campagne.
budgetID xsd:decimal ID van het door de campagne gebruikte budget.
remainingDays xsd:int Aantal dagen dat deze campagne met het bestaande budget kan worden uitgevoerd. Deze waarde wordt gebaseerd op het huidige uitgavepatroon.
status xsd:string Status van de campagne.
  • RUNNING: de campagne is momenteel actief.
  • NOT_RUNNING: De campagne is niet niet actief.
  • DEAD: de campagne is gearchiveerd (alleen lezen)
categoryBids CategoryBid[] Lijst van biedingsinformatie die aan een categorie is toegevoegd.


Categorie-Type
Veld Type Beschrijving
categoryID xsd:int ID van de categorie.
categoryName xsd:string Naam van de categorie (opgehaald uit de catelogusfeed)
avgPrice xsd:double Gemiddelde prijs van de producten in deze categorie.
numberOfProducts xsd:int Aantal getagde producten in deze categorie.
selected xsd:boolean 'True' als de categorie is geselecteerd (geselecteerd betekent beschikbaar voor bieden en rapporteren).


Budget-Type
Veld Type Beschrijving
budgetID xsd:int ID van het budget.
budgetName xsd:string Naam van het budget.
totalAmount xsd:int Totaalbedrag dat aan het budget is toegevoegd.
remainingBudget xsd:decimal Beschikbaar bedrag.
remainingBudgetUpdated xsd:dateTime Tijdstip waarop remainingBudget werd berekend.


Biedingsinformatie-Type
Veld Type Beschrijving
biddingStrategy xsd:string Strategie van het bod:
  • CPC: Kosten per klik
  • CPA: Kosten per actie
  • CPM: Kosten per duizend
Opmerking: alleen CPC wordt ondersteund.
cpcBid xsd:double Waarde van de kosten per klik.
cpaBid CPABid CPABid bestaat uit postClick, postView, commissie en percentage. (Nog niet beschikbaar).


Type categoriebod
Veld Type Beschrijving
campaignCategoryUID xsd:int De Global UID waarmee de categorie van de specifieke campagne wordt geïdentificeerd.
campaignID xsd:int ID van de campagne waarvoor dit categoriebod is gedaan.
categoryID xsd:int ID van de categorie waarvoor dit bod is gedaan.
selected xsd:boolean 'True' als de categorie is geselecteerd (geselecteerd betekent beschikbaar voor bieden en rapporteren).
bidInformation BidInformation Bodinformatie voor het categoriebod.


ReportJob-Type
Veld Type Beschrijving
reportSelector CategoryIDs
CampaignIDs
Lijst van categorie- en campagne-ID's waarover her rapport gegevens moet ophalen.
reportType xsd:string Uit te voeren rapporttype:
  • Campagne
  • Categorie
aggregationType xsd:string Het samenstellingstype voor het rapport:
  • Per uur
  • Per dag
startDate xsd:string Startdatum van het rapport (JJJJ-MM-DD)
endDate xsd:string Einddatum van het rapport (JJJJ-MM-DD).
selectedColumns ReportColumn[] Lijst van kolommen die zijn opgenomen in het rapport:
  • Klikken
  • Vertoningen
  • CTR
  • revcpc
  • ecpm
  • Kosten
  • verkoop
  • ConvRatio
  • orderValue
  • VerkoopPostView
  • ConvRatioPostView
  • orderWaardePostView
  • costOfSale
  • impressionWin
  • costPerOrder
isResultGzipped xsd:boolean 'True' betekent dat het rapport moet worden gezipt.

 

Was dit artikel nuttig?
Aantal gebruikers dat dit nuttig vond: 0 van 1
Mogelijk gemaakt door Zendesk