Connexion

Bienvenue sur notre Centre de Support

Obtenez de l'aide sur l'intégration et sur vos campagnes.

Bienvenue sur notre Centre de Support. Obtenez de l'aide sur l'intégration et sur vos campagnes.

Détails de l'API Marketing

L'API Criteo est accessible par l'url : https://api.criteo.com/marketing

Points terminaux

Authentification

type

Point terminal

Objectif

Paramètres

Remarques

POST

/oauth2/token

Récupérer le jeton permettant de poster une requête à l'API.

  • client_id (obligatoire)
  • client_secret (obligatoire)
  • grant_type (obligatoire)

Le jeton sera valide pendant 300 s

 

Gestion de l'annonceur

type

Point terminal

Objectif

Paramètres

GET

/portfolio

Récupérer votre ou vos advertiser_Id(s)

Aucun

GET

/advertiser/{advertiser_Id}/campaigns

Récupérer le(s) campagne(s) et catégorie(s) d'un annonceur spécifique

advertiser_Id (obligatoire): string

GET

/advertiser/{advertiser_Id}/categories

Récupérer le(s) campagne(s) et catégorie(s) d'un annonceur spécifique

Filtrer sur la base du statut de la catégorie

advertiser_Id (obligatoire): int

enabledOnly: bool

GET

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

Récupérer les catégories spécifiques d'un annonceur

advertiser_Id (obligatoire)

categoryHashCode (obligatoire)

 


Gestion des campagnes

type

Point terminal

Objectif

Paramètres

GET

/campaigns/

Récupérer les campagnes de votre portfolio

advertiser_Ids: string

campaignIds: string

campaignstatus: string

bidtype: string

GET

/campaigns/{campaignId}

Récupérer la campagne et les catégories d'une campagne spécifique

campaignId (obligatoire): int

GET

/campaigns/{campaignId}/categories

Récupérer la campagne et les catégories d'une campagne spécifique

Filtrer sur la base du statut de la catégorie

campaignId (obligatoire): int

enabledOnly: string

GET

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

Récupérer les catégories spécifiques d'une campagne de votre portfolio

campaignId (obligatoire): int

categoryHashCodes (obligatoire): int

GET

/campaigns/bids

Récupérer la ou les enchère(s) de votre portfolio

advertiser_Ids: string

campaignIds: string

categoryHashCodes:string

bidType: string

campaignStatus: string

pendingChanges: bool

PUT

/campaigns/bids

Paramétrer de nouvelles valeurs pour les enchères de votre campagne ou catégories de campagnes

bidChanges (obligatoire): string

 

Communication des données de campagnes

type

Point terminal

Objectif

Paramètres

Remarques

POST

/statistics

Récupérer les rapports sur les performances des annonces

statsQuery (obligatoire)

Pour toutes les informations sur ce nœud périphérique, reportez-vous à la section dédiée

 

Gestion des budgets

type

Point terminal

Objectif

Paramètres

GET

/budgets

Récupérer le ou les budget(s) de votre portfolio

advertiser_Ids: string

budgetIds: string

onlyActiveCampaigns:bool

 

Gestion des catégories

type

Point terminal

Objectif

Paramètres

GET

/categories

Récupérer les catégories de votre portfolio

campaign_Ids: : string

advertiser_Ids: string

categoryHashCodes: string

enabledOnly: bool

PUT

/categories

Catégories activées ou désactivées

categoriesPerCatalog (obligatoire)

 

Gestion des audiences

type

Point terminal

Objectif

Paramètres

Remarques

GET

/audiences

Extraire la liste d'audiences

advertiser_Id : int

Si l'ID de l'annonceur n'est pas précisé, le portfolio de l'utilisateur s'affiche

POST

 /audiences/userlist/ 

Créer une audience

advertiser_Id : int

name: string

description:string

L'ID de l'audience est l'ID suivante (elle est modifiée à chaque fois qu'une audience est créée)

PUT

/audiences/{audienceId} 

Modifier les métadonnées d'une audience

name: string

description: string

 

PATCH

/audiences/userlist/{audienceId}

Ajouter/supprimer des utilisateurs dans une audience

operation: string (ADD  or REMOVE) 

schéma : string (e-mail ou madid)

identifiers: list of string

Limité à 50 000 identificateurs par requête.

Les identificateurs peuvent être

des e-mails : texte, MD5 ou SHA256 de MD5

MADID: IDFA ou AAID

Note: l'API n'accepte pas les id de cookies de DMP

DELETE 

/audiences/userlist/{audienceId}/users

Supprimer tous les utilisateurs d'une audience

   

DELETE 

/audiences/{audienceId}

Supprimer une audience

   

 

Paramètres

Paramètre

Utilisé pour...

Détails

client_id

Récupération de jeton

Votre adresse e-mail (même nom de connexion que pour Criteo Management Center)

client_secret

Récupération de jeton

Votre mot de passe (même nom de connexion que pour Criteo Management Center)

grant_type

Récupération de jeton

Toujours égal à "client_credentials"

advertiser_Id

Récupérer des données d'un annonceur en particulier

Récupéré depuis le point terminal /portfolio

Récupéré depuis le nœud périphérique /advertisers

Récupéré depuis le nœud périphérique /audience

Récupéré depuis /audiences/userlist/ 

advertiser_Ids

Récupérer les données d'annonceurs en particulier

Récupéré depuis le nœud périphérique /budget

Récupéré depuis le nœud périphérique /campaigns

Récupéré depuis le nœud périphérique /campaigns/bids

Récupéré depuis le nœud périphérique /categories

Récupéré depuis le nœud périphérique /statistics

Vous pouvez demander de multiples advertiser_Ids en les séparant par des virgules, ex : 1,2,3

enabledOnly

Filtrer par liste de catégories

Récupéré depuis les nœuds périphériques /categories

Récupéré depuis le nœud périphérique /advertiser/{advertiser_id}/categories

Récupéré depuis le nœud périphérique /campaigns/{campaignid}/categories

active

mettre à jour le statut de la catégorie

Récupéré depuis les nœuds périphériques /categories

categoryHashCode

Récupérer des données d'une catégorie en particulier

Mettre à jour le statut d'une catégorie spécifique

Récupéré depuis le nœud périphérique /advertiser/{advertiser_id}/categories/{categoriesHashCode}

categoryHashCodes

Récupérer des données de catégories en particulier

Mettre à jour la valeur de l'enchère des catégories d'une campagne

Récupéré depuis le nœud périphérique /categories

Récupéré depuis le nœud périphérique /campaigns/bids

Récupéré depuis le nœud périphérique /campaigns/{campaignid}//categories/{categoriesHashCode}

Vous pouvez demander de multiples categoryhashcodes en les séparant par des virgules, ex : 1,2,3

budgetIds

Récupération des données de budget en particulier

Récupéré depuis le nœud périphérique /budgets

onlyactiveCampaigns

Filtrer les campagnes par statut

Récupéré depuis le nœud périphérique /budgets

campaignID

Récupérer les données spécifiques d'une campagne

Mettre à jour la valeur de l'enchère d'une campagne

Récupéré depuis le nœud périphérique /campaigns/{campaignid}

Récupéré depuis le nœud périphérique /campaigns/{campaignid}/categories

Récupéré depuis le nœud périphérique /campaigns/{campaignid}/categories/{categoriesHashCode}

Récupéré depuis le nœud périphérique /campaigns/bids

campaignIds

Récupérer les données spécifiques des campagnes

Récupéré depuis le nœud périphérique /campaigns

Récupéré depuis le nœud périphérique /campaigns/bids

Récupéré depuis le nœud périphérique /categories

Vous pouvez demander de multiples campaignids en les séparant par des virgules, ex :  1,2,3

bidType

Filtrer par type d'enchère

Récupéré depuis le nœud périphérique /campaigns

Récupéré depuis le nœud périphérique /campaigns/bids

bidValue

Mettre à jour la valeur de l'enchère des catégories d'une campagne

Récupéré depuis le nœud périphérique /campaigns/bids

campaignStatus

Filtrer sur la base du statut de la campagne

Récupéré depuis le nœud périphérique /campaigns

Récupéré depuis le nœud périphérique /campaigns/bids

pendingChanges

Filtrer la campagne sur la base des modifications en cours ou effectuées

Récupéré depuis le nœud périphérique /campaigns/bids

catalogId

Mettre à jour le statut de la catégorie

Récupéré depuis les nœuds périphériques /categories

audienceId

Mettre à jour une audience spécifique

Récupéré depuis /audiences/ 

name

Mettre à jour le nom de l'audience

Récupéré depuis le nœud périphérique  /audiences/userlist/ 

Récupéré depuis le nœud périphérique  /audiences/{audience_id} 

description

Mettre à jour la description de l'audience

Récupéré depuis le nœud périphérique  /audiences/userlist/ 

Récupéré depuis le nœud périphérique  /audiences/{audience_id} 

opération

Modifier l'audience

Récupéré depuis le nœud périphérique /audiences/userlist/{audience_id} 

La valeur doit être choisie parmi : AJOUTER/EFFACER

schéma

Type de données d'audience

Récupéré depuis le nœud périphérique  /audiences/userlist/{audience_id} 

identificateurs

Liste d'identificateurs d'utilisateurs

Récupéré depuis le nœud périphérique  /audiences/{audience_id} 

reportType

Exporter les rapports statistiques

Récupéré depuis le nœud périphérique /statistics

La valeur doit être choisie parmi : performance de la campagne / rapport DPA Facebook DPA / Rapport de transaction ID

ignoreXDevice

Exporter les rapports statistiques

Récupéré depuis le nœud périphérique /statistics

startDate

Exporter les rapports statistiques

Récupéré depuis le nœud périphérique /statistics

endDate

Exporter les rapports statistiques

Récupéré depuis le nœud périphérique /statistics

dimensions

Exporter les rapports statistiques

Récupéré depuis le nœud périphérique /statistics

Max. 3 dimensions

metrics

Exporter les rapports statistiques

Récupéré depuis le nœud périphérique /statistics

Les métriques doivent être choisies depuis l'IU MC

format

Exporter les rapports statistiques

Récupéré depuis le nœud périphérique /statistics

La valeur doit être choisie parmi : XML, JSON, CSV, EXCEL, HTML

devise monétaire

Exporter les rapports statistiques

Récupéré depuis le nœud périphérique /statistics

La valeur doit correspondre au code devise ISO

Fuseau horaire

Exporter les rapports statistiques

Récupéré depuis le nœud périphérique /statistics

La valeur doit être choisie parmi : GMT / PST / JST 


Codes de réponse

Code de réponse

Raison

200

Réussite

400

Requête incorrecte, erreur de syntaxe

401

Échec d'authentification

403

Accès interdit

429

Limite de débit atteinte, pas plus de 200 requêtes par minute par client

500

Erreur inconnue

Cet article vous a-t-il été utile ?
Utilisateurs qui ont trouvé cela utile : 0 sur 0
Réalisé par Zendesk