Skip to main content

API pour les développeurs

Avec l'API de la plateforme, il est possible d'automatiser toutes les fonctionnalités qui se trouvent dans le panneau d'administration.

1. Que peuvent automatiser les annonceurs ?
  • Campagnes/groupes, variations, offres et formats publicitaires
  • Ciblage/blocage des options de ciblage, des catégories
  • Objectifs
  • Obtenir des statistiques, y compris des données sur les utilisateurs d'adblock
  • Budget journalier, financement des comptes, types de paiement
  • Nom de la page d'atterrissage, URL et algorithme de partage du trafic
2. Que peuvent automatiser les éditeurs ?
  • Formats et zones publicitaires
  • Sites, vérifications d'URL
  • Bloquer des types d'annonces et des catégories de produits
  • Obtenir toutes les statistiques, y compris les données relatives aux utilisateurs d'adblocks
  • Prix d'enchère par format publicitaire/géo, modèles de tarification
  • Types de paiement
3. Comment utiliser l'API
  • L'interface de l'API est rapide et facile à utiliser
  • Il suffit de sélectionner un paramètre et d'appuyer sur le bouton Try It Out pour générer automatiquement un code
4. Télécharger la documentation technique

Comment utiliser l'API de la plateforme​

Nous venons de mettre à jour l'API de notre plateforme à la version 2. Cette dernière version vous permet d'automatiser toutes les fonctionnalités du panneau d'administration. Vous pouvez utiliser l'API pour des processus simples tels que l'automatisation de tâches répétitives pour vous faire gagner du temps, ainsi que pour des projets plus complexes tels que le changement de bannières à la volée.

Caractéristiques​

Les éditeurs et les annonceurs disposent d'un large éventail de fonctionnalités. Voici un résumé de ce qui peut être automatisé :

Annonceurs​

  • Campagnes individuelles/groupes, variations, offres, formats publicitaires.
  • Ciblage/blocage des options de ciblage, des catégories, de la séparation des jours.
  • Objectifs.
  • Obtenir des statistiques, y compris des données sur les utilisateurs d'adblock.
  • Budget quotidien, financement des comptes, types de paiement.
  • Nom de la page d'atterrissage, URL et algorithme de partage du trafic.

Éditeurs​

  • Formats et zones publicitaires.
  • Sites, vérifications d'URL.
  • Bloquer des types d'annonces et des catégories de produits.
  • Tirer toutes les statistiques, y compris les données sur les utilisateurs d'adblock.
  • Prix des enchères par format publicitaire/géo, modèles de tarification.
  • Types de paiement.
Avant de commencer​

L'interface API présente une liste de titres de groupes. Cliquez sur un groupe et toutes les options disponibles s'afficheront.

list api

Verbes HTTP​

L'API prend en charge le sous-ensemble suivant de verbes HTTP. Veuillez noter que toutes les fonctionnalités ne prennent pas en charge tous les verbes.

API uses

C'est parti !

Mise en place​

Pour accéder aux demandes d'API restreintes, un jeton de session doit être défini. Pour définir un jeton, vous devez disposer d'un compte valide.

La création de jetons API est disponible dans le menu Mon profil. Sélectionnez Tokens API.

my profile

Cliquez sur New API Token.

api tokens

Saisissez le nom du Token, pour ce tutoriel nous avons appelé le nôtre 'testToken' puis cliquez sur Save.

L'identifiant du jeton est créé.

token id

Connexion à l'API​

Dans l'interface API, cliquez sur le bouton Login en haut à droite de l'écran et entrez votre nom d'utilisateur et votre mot de passe ou fournissez un jeton API. Cliquez sur Envoyer et une demande de connexion sera envoyée à l'API pour récupérer un jeton de session valide. Ce jeton sera ensuite utilisé pour valider toutes les demandes d'API que vous souhaitez effectuer au cours de la session.

api login

api login

Comment faire une demande à l'API​

Si nous prenons l'exemple du groupe Campagnes, cliquez dessus et le groupe s'agrandira pour afficher la liste des demandes disponibles :

Cliquez sur la demande que vous souhaitez automatiser. Dans cet exemple, nous demanderons les données pour le CID 1923724 en utilisant :

get campaign

Cliquez sur Get campaign (Obtenir une campagne), ce qui ouvre la fenêtre. Entrez le numéro d'identification de la campagne dans le champ :

campaign id

Cliquez ensuite sur le bouton Essayer maintenant. Le corps de la réponse générera le code automatiquement.

response body

Un code de réponse de 200 signifie qu'il peut être utilisé.

Comment interrompre une campagne​

Voici un autre exemple. Sélectionnez d'abord la bonne fonction dans le groupe Campagnes :

campaign pause

Cliquez sur Pause pour une ou plusieurs campagnes. Une fois ouvert, cliquez sur la valeur de l'exemple, puis sur la boîte jaune, ce qui collera automatiquement la structure json dans la boîte du corps.

pause

La valeur actuelle est zéro. Remplacez le zéro par le CID que vous souhaitez mettre en pause. Cliquez ensuite sur le bouton Essayer pour générer le code nécessaire.

campaign id

Comment mettre à jour la tarification d'une campagne​

Sélectionnez la fonction correcte :

campaign id

Cliquez sur Mettre à jour une campagne, pour ouvrir la fenêtre. Ajoutez le CID dans le champ "campaign id" puis cliquez sur "Example Value", cliquez sur la case jaune qui copiera la structure json dans la case "body".

Ce code contient plusieurs fonctions différentes, mais nous voulons le code de tarification de la campagne. Supprimez donc la partie du code dont vous n'avez pas besoin, en laissant le code de tarification de la campagne dans la case, comme ci-dessous :

campaign id

Nous devons maintenant modifier deux éléments dans le corps de la boîte, le modèle (la liste des valeurs liées au modèle de tarification figure ci-dessous).


CampaignPricing {
model (integer, optional): Campaign pricing model (1: CPC, 2: CPM, 3: CPA, 4: Smart CPM, 5: CPV) = [‘1’, ‘2’, ‘3’, ‘4’, ‘5’],
price (number, optional): Campaign price
}

Nous allons rester avec le CPC et nous laisserons donc le modèle à 1

Nous devons maintenant changer le prix de zéro au prix que nous voulons. Nous allons le remplacer par 200, ce qui signifie que le nouveau prix sera de 200 cents ou deux euros.

campaign id

Il suffit ensuite de cliquer sur le bouton Essayer pour générer le code. C'est facile !

Comme vous pouvez le constater, l'API regorge de fonctionnalités à automatiser, la seule limite étant votre imagination pour débloquer le pouvoir de l'automatisation.

Enfin, n'oubliez pas de vous abonner à notre lettre d'information sur l'API, que vous trouverez en bas de l'interface de l'API, afin de recevoir les dernières nouvelles et mises à jour.