0%

API REST Criteo pour les revendeurs

API REST Criteo pour les revendeurs

Retrouvez ci-dessous tous les concepts clés de l'API REST du Criteo Reseller Program, conçue pour vous aider à gérer les enchères et les budgets des revendeurs pour chaque campagne.


S'AUTHENTIFIER SUR L'API

Nous utilisons JWT qui fournit un système de jetons d'authentification pour notre API REST. Pour émettre des appels vers notre API, vous devez associer un jeton à l'un de ces appels.

Pour obtenir votre jeton, émettez un appel POST au nœud périphérique /oauth2/token, avec les paramètres client_id et client secret (cf. section "Comment démarrer").


RÉCUPÉRER VOTRE AdvertiserID

Récupérez votre AdvertiserID (identifiant annonceur) en émettant un appel GET au nœud périphérique /portfolio/.


RÉCUPÉRER VOTRE CampaignID

Récupérez votre CampaignID (identifiant campagne) en émettant un appel GET au nœud périphérique /sellers/.


AJOUTER UN REVENDEUR AU CRITEO RESELLER PROGRAM 

Avant d'ajouter un nouveau revendeur, assurez-vous qu'il soit correctement repéré sur le catalogue de flux de produits partagé au préalable avec Criteo. 
Pour vous assurer que votre revendeur est correctement repéré, liez la colonne nom du revendeur à l'identifiant de revendeur unique, indiquant le nom du revendeur pour chacun des produits fournis dans le flux.

 


Après les étapes ci-dessus, vous pourrez nous envoyer les budgets et enchères de vos revendeurs grâce aux nœuds périphériques préalablement décrits, comme suit :

  • PUT /v1/sellers/bids pour nous envoyer le CPC du revendeur 
  • POST /v1/sellers/budgets pour nous envoyer le budget du revendeur

 


    EFFACER LES DONNÉES D'UN REVENDEUR DU CRITEO RESELLER PROGRAM

    Pour supprimer un revendeur du Criteo Reseller Program, arrêtez simplement l'activité du revendeur au sein même de la campagne (voir la section "Comment supprimer un revendeur").

    Vous pouvez aussi supprimer les produits du revendeur de votre flux de produits. Cette action ne prend toutefois effet que lorsque Criteo procède à l'intégration du flux et de la catégorie. Le rajout de ces produits prendra plus de temps, et nécessitera une nouvelle intégration du flux et de la catégorie. Après sa suppression du flux, les statistiques du revendeur ne seront plus disponibles.


    LANCER UNE CAMPAGNE   

    Pour lancer une campagne Criteo Reseller program, vous devez fournir un flux produit dédié contenant les produits de tous les revendeurs ajoutés dans le programme. Notez que chacun de ces produits doit comporter l'identifiant unique du revendeur dans le champ revendeur.

     

    Votre campagne sera automatiquement créée dès l'intégration de votre flux.
    Pour être active, votre campagne a besoin d'au moins un revendeur dont le budget et l'enchère sont déjà établis. Vous pouvez les envoyer par les nœuds périphériques PUT /v1/sellers/bids et POST /v1/sellers /budgets. 



    ARRÊTER UNE CAMPAGNE ACTIVE
    Pour arrêter une campagne Criteo Reseller Program dans son intégralité (pour tous les revendeurs), contactez votre Responsable de compte.  



    METTRE UN REVENDEUR SUR PAUSE

    Pour interrompre l'activité d'un revendeur au sein d'une campagne, réglez son budget sur "inactif". Le système cessera ensuite d'afficher des annonces pour les produits de ce revendeur.

    Pour appliquer le statut "inactif" à un budget, vous devez émettre un appel PUT au nœud périphérique /sellers/budgets tel que décrit ci-dessous :

    • PUT /sellers/budgets avec status = Inactive


    ARRÊTER UN REVENDEUR DONT LE BUDGET EST PRESQUE INTÉGRALEMENT UTILISÉ 

    Il n'y a rien à faire de votre côté. Nous anticipons l'épuisement du budget de tous les revendeurs et mettons fin à leurs campagnes dès que leur budget s'épuise.

    ÉTABLIR DES BUDGETS ET DES CPC

    Pour établir un budget ou un CPC pour un revendeur spécifique, vous aurez besoin des nœuds périphériques suivants :

    • Pour l'initialisation et la mise à jour des enchères : émettre un appel PUT au nœud périphérique /sellers/bids
    • Budgets :
      • Pour l'initialisation : émettre un appel POST au nœud périphérique /v1/sellers/budgets
      • Pour la mise à jour du budget : émettre un appel PUT au nœud périphérique /v1/sellers/budgets


    AUGMENTER DES BUDGETS ET DES CPC

    Pour augmenter les budgets et CPC d'un revendeur spécifique, vous devez émettre un appel PUT aux nœuds périphériques /v1/sellers/budgets et /v1/sellers/bids.


    DIMINUER LES CPC

    Si votre revendeur souhaite diminuer son CPC, vous devez émettre un appel POST au nœud périphérique /v1/sellers/bids.


    DIMINUER LES BUDGETS

    Si votre revendeur souhaite diminuer son budget, vous devez régler le statut sur "Inactive" (inactif) - ceci mettra fin aux affichages sur le budget existant le jour (J) où l'action est exécutée. Vous pouvez ensuite créer un nouveau budget à la valeur diminuée (voir la section "Comment créer un nouveau budget"). Cette action sera exécutée à J+1, heure UTC.

    EXEMPLE :

    Jour 0 : le revendeur a initialement établi un budget d'un montant de 1000$ sur sa campagne Criteo Reseller Program.

    Jour 2 : le revendeur a toujours un budget de 800$ MAIS décide de réduire ce budget à 500$.

    Vous devez alors émettre les appels suivants :

    • Appel PUT au nœud périphérique /sellers/budgets/
      • Réglez le status (statut) sur Inactive (inactif)
      • (nul besoin de spécifier un montant de budget ici, car le status a la priorité)
    • Appel POST au nœud périphérique /sellers/budgets/
      • Réglez le montant amount à 500
      • (nul besoin de spécifier le status ici ; s'il est laissé vide, nous supposerons qu'il est active (actif))

     CRÉER DES BUDGETS

    Vous pouvez créer un nouveau budget dans un des deux cas suivants :

    • Vous ne disposez d'aucun budget pour la journée en cours
    • Votre budget est inactif pour la journée en cours

    Pour créer un nouveau budget de revendeur, vous devez :

    • Appel POST au nœud périphérique /sellers/budgets/

    Le nouveau budget sera actif :

    • dès sa création si vous n'avez aucun budget pour la journée en cours
    • le lendemain de la création si votre budget est inactif pour la journée en cours


    CORRIGER UN BUDGET MAL SAISI 

    Tout d'abord, votre revendeur devra vous fournir le budget mis à jour.
    Il existe ensuite trois scénarios menant à des actions différentes :

    • Vous êtes en possession du nouveau budget et celui-ci est moins élevé que le budget initialement configuré :
      • Appliquez les étapes décrites dans la section Comment diminuer un budget/CPC
    • Vous êtes en possession du nouveau budget, et celui-ci est plus élevé que le budget initialement configuré :
      • Appliquez les étapes décrites dans la section "Comment augmenter un budget/CPC"
    • Vous n'êtes pas en possession du nouveau budget/budget correct :
      • Appliquez les étapes décrites dans la section "Comment supprimer un revendeur"

    CORRIGER UN CPC MAL SAISI

    Tout d'abord, votre revendeur devra vous fournir le CPC mis à jour. Émettez ensuite un appel PUT au nœud périphérique sellers/bids/ pour configurer l'enchère mise à jour.

    QUE FAIRE LORSQU'UN REVENDEUR CHANGE DE NOM SUR VOTRE PLATE-FORME ?

    Notre API dépend essentiellement du sellerName pour gérer les enchères et les budgets, tout changement de nom d'un revendeur crée automatiquement une nouvelle entrée dans notre système. Cette dernière n'est pas liée au nom précédent du revendeur.
    En bref, si un revendeur change de nom sur votre plate-forme, vous devrez :

    • Mettre votre flux produit à jour avec le nouveau sellerName
    • Initialiser l'enchère et le budget de votre revendeur en nous envoyant des instructions PUT /v1/sellers/bids et POST /v1/sellers/budgets.

     


    ANALYSER LES BUDGETS UTILISÉS PAR LES REVENDEURS

    Pour obtenir un aperçu du budget dépensé pour un revendeur dédié sur une campagne du Criteo Reseller Program, émettez un appel GET au nœud périphérique /v1/sellers. Ces informations seront disponibles sous spentAmount (montant dépensé).

    ANALYSER LES BUDGETS RESTANTS DES REVENDEURS

    Pour obtenir un aperçu du budget dépensé pour un revendeur dédié sur une campagne du Criteo Reseller Program, émettez un appel GET au nœud périphérique /v1/sellers. Ces informations seront disponibles sous remainingAmount (montant dépensé).

    Communication de données

    Vous pouvez émettre un appel POST au nœud périphérique /v1/sellers/stats. L'accès aux clics et aux coûts n'est possible qu'au niveau du revendeur, jusqu'à une granularité quotidienne.

    Vous pouvez utiliser au maximum 3 dimensions, dont obligatoirement celle du revendeur.

    Dimensions disponibles :

    • AdvertiserID (iD annonceur)
    • campaignID
    • Revendeur – obligatoire
    • Année
    • Semaine
    • Jour

    Métriques disponibles :

    • annonces
    • clics
    • AdvertiserCost (coût annonceur)
    0%