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.

Details van de Marketing-API

De Criteo-API is toegankelijk via deze url: https://api.criteo.com/marketing

Eindpunten

Authenticatie

Type

Eindpunt

Doel

Parameters

Opmerkingen

POST

/oauth2/token

Token ophalen waarmee u een aanvraag bij de API kunt posten

  • client_id (verplicht)
  • client_secret (verplicht)
  • grant_type (verplicht)

De token is geldig voor 300s

 

Beheer van adverteerders

Type

Eindpunt

Doel

Parameters

GET

/portfolio

Uw advertiser_Id(s) ophalen

Geen

GET

/advertiser/{advertiser_Id}/campaigns

Uw campagne(s) en categorieën voor een specifieke adverteerder ophalen

advertiser_Id (verplicht): string

GET

/advertiser/{advertiser_Id}/categories

Uw campagne(s) en categorieën voor een specifieke adverteerder ophalen

Filteren per categoriestatus

advertiser_Id (verplicht): int

enabledOnly: bool

GET

/advertiser/{advertiser_Id}/categories/{categoryHashCode}

Specifieke categorieën voor een specifieke adverteerder ophalen

advertiser_Id (verplicht)

categoryHashCode (verplicht)

 


Campagnebeheer

Type

Eindpunt

Doel

Parameters

GET

/campaigns/

Campagnes voor je portfolio ophalen

advertiser_Ids: string

campaignIds: string

campaignstatus: string

bidtype: string

GET

/campaigns/{campaignId}

Uw campagne en categorieën voor een specifieke campagne ophalen

campaignId (mandatory): int

GET

/campaigns/{campaignId}/categories

Uw campagne en categorieën voor een specifieke campagne ophalen

Filteren per categoriestatus

campaignId (mandatory): int

enabledOnly: string

GET

/campaigns/{campaignId}/categories/{categoryHashCode}

Specifieke campagnecategorieën uit uw portfolio ophalen

campaignId (mandatory): int

categoryHashCodes (mandatory): int

GET

/campaigns/bids

Uw bod of biedingen voor uw portfolio ophalen

advertiser_Ids: string

campaignIds: string

categoryHashCodes:string

bidType: string

campaignStatus: string

pendingChanges: bool

PUT

/campaigns/bids

Nieuwe bodwaarden instellen voor uw campagne of campagnecategorieën

bidChanges (mandatoy): string

 

Rapportage over campagnes

Type

Eindpunt

Doel

Parameters

Opmerkingen

POST

/statistics

Rapporten over advertentieprestaties ophalen

statsQuery (verplicht)

Details over dit eindpunt vindt u in de daarvoor bestemde sectie van de documentatie

 

Budgetbeheer

Type

Eindpunt

Doel

Parameters

GET

/budgets

Budget(ten) voor uw portfolio ophalen

advertiser_Ids: string

budgetIds: string

onlyActiveCampaigns:bool

 

Beheer van categorieën

Type

Eindpunt

Doel

Parameters

GET

/categories

Categorieën voor uw portfolio ophalen

campaign_Ids: : string

advertiser_Ids: string

categoryHashCodes: string

enabledOnly: bool

PUT

/categories

In- of uitgeschakelde categorieën

categoriesPerCatalog (verplicht)

 

Beheer van doelgroepen

Type

Eindpunt

Doel

Parameters

Opmerkingen

GET

/audiences

De lijst met doelgroepen ophalen

advertiser_Id : int

Als er geen adverteerders-ID wordt opgegeven, wordt het portfolio van de gebruiker geretourneerd

POST

 /audiences/userlist/ 

Een doelgroep maken

advertiser_Id : int

name: string

description:string

De doelgroep-ID is de volgende ID (die elke keer wordt verhoogd wanneer er een doelgroep wordt gemaakt)

PUT

/audiences/{audienceId} 

Doelgroepmetadata wijzigen

name: string

description: string

 

PATCH

/audiences/userlist/{audienceId}

Gebruikers toevoegen aan/verwijderen uit een doelgroep

operation: string (ADD  or REMOVE) 

schema: string (e-mail of madid)

identifiers: list of string

Beperkt tot 50.000 ID's per aanvraag.

ID's kunnen zijn:

e-mails: platte tekst, MD5 of SHA256 van MD5

MADID: IDFA of AAID

Opmerking: de API accepteert geen cookie-ID's van DMP's

DELETE 

/audiences/userlist/{audienceId}/users

Alle gebruikers uit een doelgroep verwijderen

   

DELETE 

/audiences/{audienceId}

Een doelgroep verwijderen

   

 

Parameters

Parameter

Gebruikt voor...

Details

client_id

Ophalen van token

Uw e-mail (zelfde aanmelding als voor Criteo Management Center)

client_secret

Ophalen van token

Uw wachtwoord (zelfde aanmelding als voor Criteo Management Center)

grant_type

Ophalen van token

Altijd gelijk aan "client_credentials"

advertiser_Id

Gegevens van een specifieke adverteerder ophalen

Opgehaald uit /portfolio-eindpunt

Opgehaald uit /advertisers eindpunt

Opgehaald uit /audience eindpunt

Opgehaald uit /audiences/userlist/ 

advertiser_Ids

Gegevens van specifieke adverteerders ophalen

Opgehaald uit /budget eindpunt

Opgehaald uit /campaigns eindpunt

Opgehaald uit /campaigns/bids eindpunt

Opgehaald uit /categories eindpunt

Opgehaald uit /statistics eindpunt

U kunt meerdere advertiser_Ids aanvragen door deze van elkaar te scheiden met komma's, bijvoorbeeld 1,2,3

enabledOnly

Lijst met categorieën filteren

Opgehaald uit /categories eindpunten

Opgehaald uit /advertiser/{advertiser_id}/categories eindpunt

Opgehaald uit /campaigns/{campaignid}/categories eindpunt

enabled

categoriestatus bijwerken

Opgehaald uit /categories eindpunten

categoryHashCode

Gegevens van een specifieke categorie ophalen

Status van een specifieke categorie bijwerken

Opgehaald uit /advertiser/{advertiser_id}/categories/{categoriesHashCode} eindpunt

categoryHashCodes

Gegevens van specifieke categorieën ophalen

Bodwaarde van specifieke campagnecategorieën bijwerken

Opgehaald uit /categories eindpunt

Opgehaald uit /campaigns/bids eindpunt

Opgehaald uit /campaigns/{campaignid}//categories/{categoriesHashCode} eindpunt

U kunt meerdere categoryhashcodes aanvragen door deze van elkaar te scheiden met komma's, bijvoorbeeld 1,2,3

budgetIds

Gegevens van een specifiek budget ophalen

Opgehaald uit /budgets eindpunt

onlyactiveCampaigns

Campagnes filteren op status

Opgehaald uit /budgets eindpunt

campaignID

Gegevens van specifieke campagne ophalen

Bodwaarde van specifieke campagne bijwerken

Opgehaald uit /campaigns/{campaignid} eindpunt

Opgehaald uit /campaigns/{campaignid}/categories eindpunt

Opgehaald uit /campaigns/{campaignid}/categories/{categoriesHashCode} eindpunt

Opgehaald uit /campaigns/bids eindpunt

campaignIds

Gegevens van specifieke campagnes ophalen

Opgehaald uit /campaigns eindpunt

Opgehaald uit /campaigns/bids eindpunt

Opgehaald uit /categories eindpunt

U kunt meerdere campaignids aanvragen door deze van elkaar te scheiden met komma's, bijvoorbeeld 1,2,3

bidType

Filteren op bodtypen

Opgehaald uit /campaigns eindpunt

Opgehaald uit/campaigns/bids eindpunt

bidValue

Bodwaarde van specifieke campagnecategorieën bijwerken

Opgehaald uit/campaigns/bids eindpunt

campaignStatus

Filteren per camoagnestatus

Opgehaald uit /campaigns eindpunt

Opgehaald uit /campaigns/bids eindpunt

pendingChanges

Campagne filteren met in behandeling zijnde of doorgevoerde wijzigingen

Opgehaald uit /campaigns/bids eindpunt

catalogId

Categoriestatus bijwerken

Opgehaald uit /categories eindpunten

audienceId

Een specifieke doelgroep bijwerken

Opgehaald uit /audiences/ 

name

Naam van doelgroep bijwerken

Opgehaald uit /audiences/userlist/ eindpunt

Opgehaald uit /audiences/{audience_id} eindpunt

description

Beschrijving van doelgroep bijwerken

Opgehaald uit /audiences/userlist/ eindpunt

Opgehaald uit /audiences/{audience_id} eindpunt

operation

Actie voor een doelgroep

Opgehaald uit /audiences/userlist/{audience_id} eindpunt

Waarde moet het volgende zijn: ADD / REMOVE

schema

Type doelgroepgegevens

Opgehaald uit /audiences/userlist/{audience_id} eindpunt

identifiers

Lijst met gebruikers-ID's

Opgehaald uit /audiences/{audience_id} eindpunt

reportType

Statistiekenrapport exporteren

Opgehaald uit /statistics

De waarde moet een van de volgende zijn: Campagneprestaties / Rapport Facebook DPA / Rapport Transactie-ID

ignoreXDevice

Statistiekenrapport exporteren

Opgehaald uit /statistics

startDate

Statistiekenrapport exporteren

Opgehaald uit /statistics

endDate

Statistiekenrapport exporteren

Opgehaald uit /statistics

dimensions

Statistiekenrapport exporteren

Opgehaald uit /statistics

Max 3 dimensies

metrics

Statistiekenrapport exporteren

Opgehaald uit /statistics

Metingen moeten worden opgehaald uit MC UI

format

Statistiekenrapport exporteren

Opgehaald uit /statistics

Waarde moet een van de volgende zijn: XML, JSON, CSV, EXCEL, HTML

currency

Statistiekenrapport exporteren

Opgehaald uit /statistics

Waarde moet een ISO-valutacode zijn

timezone

Statistiekenrapport exporteren

Opgehaald uit /statistics

Waarde moet een van de volgende zijn: GMT / PST / JST 


Reactiecodes

Reactiecode

Reden

200

Gelukt

400

Verkeerde aanvraag, ongeldige syntaxis

401

Authenticatie mislukt

403

Toegang verboden

429

Limiet bereikt, niet meer dan 200 aanvragen per minuut, per klant

500

Onbekende fout

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