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.

Comment afficher les rapports en utilisant L'API Criteo ?

Vous pouvez afficher un rapport en utilisant l'API Criteo en appelant les commandes suivantes : 
  1. clientLogin (connexion client)
  2. scheduleReportJob (programmer un rapport)
  3. getJobStatus (obtenir le statut du travail)
  4. getReportDownloadUrl (obtenir rapport télécharger Url)

 

Liste d'appels et de réponses API

 
1. clientLogin
Renvoie un authToken à utiliser dans tous les appels suivants.

Paramètres :
Champ type Description
Nom d'utilisateur xsd:string Nom de l'annonceur
mot de passe xsd:string Mot de passe de l'annonceur
source xsd:string Chaîne courte de caractères identifiant votre application, à des fins de connexion. La chaîne devra prendre la forme: "companyName-applicationName-versionID".

Réponse :
Champ type Description
clientLoginResult xsd:string Le clientLoginResult est la clé d'authentification (authToken) à utiliser dans tous les autres appels. Celui-ci est valable pendant 48 heures.
 

2. getAccount (obtenir compte)
Affiche des renseignements de base au sujet du compte

Paramètres : N/A

Réponse :
Champ type Description
Nom de l'annonceur xsd:string Nom de ce compte
email xsd:string Email du contact principale de l'annonceur
devise monétaire xsd:string Devise pour ce compte. Énumération
Fuseau horaire xsd:string Fuseau horaire pour ce compte. Énumération
pays xsd:string Pays pour ce compte. Énumération
 
3. getBudgets
Affiche la liste des budgets correspondant aux critères de sélection.

Paramètres :
Champ type Description
budgetSelector BudgetIDs[] Liste d'ID de budgets à extraire. Si celle-ci est vide, tous les budgets ont été extraits.

Réponse :
Champ type Description
getBudgetResults Budget[] Liste d'objets budgétaires
 
4. getCampaigns
Affiche la liste des campagnes correspondant aux critères de sélection.

Paramètres :
Champ type Description
campaignSelector CampaignSelector BudgetID, CampaignID, CampaignStatus et BiddingStrategy peuvent être utilisés pour extraire des campagnes.

Réponse :
Champ type Description
getCampaignResults Campaign[] Liste d'objets de campagne
 
5. getCategories
Affiche une liste de catégories correspondant aux critères sélectionnés.

Paramètres :
Champ type Description
categorySelector CategorySelector CategoryID et Selected peuvent être utilisés pour extraire des catégories.

Réponse :
Champ type Description
getCategoryResults Category[] Liste d'objets de catégories
 
6. mutateCategories
Actualise les catégories.

Paramètres :
Champ type Description
mutateCategories CategoryMutates[] Liste d'opérations "mutate". Seules les opérations SET sont supportées.

Réponse :
Champ type Description
jobResponse categoryMutateJobResponse[] Liste de categoryJobResponseObjects. Chaque opération a son propre jobID, pouvant être vérifié grâce à getJobStatus.
 
7. mutateCampaigns
Actualise les campagnes.

Paramètres :
Champ type Description
mutateCampaigns CampaignMutates[] Liste d'opérations "mutate". Seules les opérations SET sont supportées.


Réponse :
Champ type Description
jobResponse campaignMutateJobResponse[] Liste de campaignJobResponseObjects. Chaque opération a son propre jobID, pouvant être vérifié grâce à getJobStatus.


8. scheduleReportJob
Programme la création d'un rapport.

Paramètres :
Champ type Description
reportJob ReportJob Un objet reportJob décrivant le Rapport recherché est transmis.

Réponse :
Champ type Description
jobID xsd:int ID du travail recherché. Peut être utilisé dans getJobStatus et getReportDownloadURL.s
jobStatus xsd:string Statut de la demande. Si le reportJob a été accepté, "Pending" est affiché.
reportJob ReportJob Demande reportJob initiale


9. getJobStatus
Extrait le statut d'un travail en fonction de son ID.

Paramètres :
Champ type Description
jobID xsd:int ID du travail pour lequel le statut est extrait.

Réponse :
Champ type Description
getJobStatusResult xsd:string Statut du travail demandé. Énumération


10. getReportDownloadUrl
Retourne une URL depuis laquelle le rapport associé au job ID indiqué peut être téléchargé. Suite à l'appel de cette méthode, l'appelant peut effectuer un HTTP GET sur l'URL affichée afin d'extraire le rapport. Les rapports sont au format XML.

Paramètres :
Champ type Description
jobID xsd:int Le job ID pour lequel l'URL de téléchargement est récupérée.

Réponse :
Champ type Description
jobURL xsd:string URL complète dans laquelle le rapport peut être téléchargé.


11. getStatisticsLastUpdate
Affiche une liste d'objets StatUpdate pour indiquer la "clôture des comptes" pour le Type de statistique correspondant (ClicksAndImpressions, Sales for now).

Paramètres :
Aucun.

Réponse :
Champ type Description
getStatisticsLastUpdateResult StatUpdate[] Liste de StatUpdateObjects. Une StatUpdate contient un type et une date.

 

Description des objets

 
Type Campaign

Champ type Description
campaignID xsd:int ID de la campagne
campaignName xsd:string Nom de la campagne
campaignBid BidInformation Informations sur les enchères de la campagne
budgetID xsd:decimal ID du budget que la campagne utilise.
remainingDays xsd:int Nombre de jour restants avant que le budget ne soit intégralement consommé par la campagne. Cette valeur est estimée en fonction du rythme actuel des dépenses.
Statut xsd:string Statut de la campagne :
  • RUNNING : la campagne est actuellement active
  • NOT_RUNNING : la campagne est inactive.
  • DEAD : la campagne est archivée (mode lecture seule)
categoryBids CategoryBid[] Liste des BidInformations (informations au sujet des enchères) associées à une catégorie.


Type Category
Champ type Description
categoryID xsd:int ID de la catégorie
categoryName xsd:string Nom de la catégorie (extraite du Flux du catalogue).
avgPrice xsd:double Prix moyen des produits dans cette catégorie.
numberOfProducts xsd:int Nombre de produits taggés avec cette catégorie.
selected xsd:boolean Vrai si la catégorie est sélectionnée (sélectionnée signifie disponible pour les enchères et le reporting).


Type Budget
Champ type Description
budgetID xsd:int ID du budget.
budgetName xsd:string Nom du budget.
totalAmount xsd:int Montant total associé à ce budget.
remainingBudget xsd:decimal Montant disponible.
remainingBudgetUpdated xsd:dateTime Heure à laquelle le budget restant a été calculé.


Type BidInformation
Champ type Description
biddingStrategy xsd:string Stratégie d'enchère :
  • CPC : coût par clic
  • CPA : coût par action
  • CPM : coût pour mille
NB : Seul CPC est supporté.
cpcBid xsd:double Valeur du coût par clic.
cpaBid CPABid CPABid contient les post-clics, les post-visualisations, les commissions et les pourcentages. (non supporté pour le moment).


Type CategoryBid
Champ type Description
campaignCategoryUID xsd:int UID global identifiant la catégorie pour une campagne spécifique.
campaignID xsd:int ID de la campagne sur laquelle l'enchère pour cette catégorie s'applique.
categoryID xsd:int ID de la catégorie pour laquelle cette enchère s'applique.
selected xsd:boolean Vrai si la catégorie est sélectionnée (sélectionnée signifie disponible pour les enchères et le reporting).
bidInformation BidInformation BidInformation (informations sur les enchères) pour l'enchère de la catégorie.


Type ReportJob
Champ type Description
reportSelector CategoryIDs
CampaignIDs
Liste de catégories ou d'ID des campagnes desquelles le rapport doit extraire les données.
reportType xsd:string Type de rapport à effectuer :
  • campagne
  • Catégorie
aggregationType xsd:string Type d'agrégation pour le rapport :
  • horaire (par heure)
  • quotidien (par jour)
startDate xsd:string Date de début du rapport (JJJJ-MM-AA).
endDate xsd:string Date de fin du rapport (JJ-MM-AA).
selectedColumns ReportColumn[] Liste de colonnes sollicitées dans le rapport :
  • clics
  • Impressions
  • ctr (taux de clics)
  • revcpc
  • cpm (coût équivalent pour mille impressions)
  • coût
  • ventes
  • convRate (taux de conversion)
  • valeur d'une commande
  • salesPostView (ventes post-impression)
  • convRatePostView (taux de conversion post-impression)
  • orderValuePostView (montant des commandes post-impression)
  • Coût de revient
  • Impression Win (part des impressions remportées face à des concurrents)
  • costPerOrder (coût par commande)
isResultGzipped xsd:boolean Vrai si le rapport doit être converti en zip.

 

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