For the complete documentation index, see llms.txt. This page is also available as Markdown.

API développeur

Avec l’API de la plateforme, il est possible d’automatiser toutes les fonctionnalités disponibles dans le panneau d’administration.

1. Que peuvent automatiser les annonceurs ?
  • Campagnes/groupes, variantes, offres et formats publicitaires

  • Ciblage/blocage des options de ciblage, catégories

  • Objectifs

  • Récupérer des statistiques, y compris les données des utilisateurs utilisant un adblock

  • Budget quotidien, financement du compte, types de paiement

  • Nom de la page de destination, URL et algorithme de répartition du trafic

2. Que peuvent automatiser les éditeurs ?
  • Formats publicitaires et zones publicitaires

  • Sites, vérifications d’URL

  • Bloquer les types de publicités et les catégories de produits

  • Récupérer toutes les statistiques, y compris les données des utilisateurs utilisant un adblock

  • Prix d’enchère par format publicitaire/GEO, modèles de tarification

  • Types de paiement

3. Comment utiliser l’API
  • L’interface de l’API est rapide et facile à utiliser

  • Sélectionnez simplement un paramètre et appuyez sur le Essayez bouton pour générer automatiquement le code

4. Télécharger la documentation technique

Comment utiliser l’API de la plateforme

Nous venons de mettre à jour notre API de plateforme vers la version 2. Cette dernière version vous permet d’automatiser chacune des fonctionnalités du panneau d’administration. Vous pouvez utiliser l’API pour des processus simples, comme l’automatisation de tâches répétitives pour gagner du temps, jusqu’à des projets plus complexes, comme la modification à la volée des créations de bannières.

Fonctionnalités

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

Annonceurs

  • Campagnes individuelles/de groupe, variantes, offres, formats publicitaires.

  • Ciblage/blocage des options de ciblage, catégories, répartition par tranche horaire.

  • Objectifs.

  • Récupération des statistiques, y compris les données des utilisateurs utilisant un adblock.

  • Budget quotidien, financement du compte, types de paiement.

  • Nom de la page de destination, URL et algorithme de répartition du trafic.

Éditeurs

  • Formats publicitaires et zones publicitaires.

  • Sites, vérifications d’URL.

  • Bloquer les types de publicités et les catégories de produits.

  • Récupération de toutes les statistiques, y compris les données des utilisateurs utilisant un adblock.

  • Prix d’enchère par format publicitaire/GEO, modèles de tarification.

  • Types de paiement.

Avant de commencer

L’interface de l’API affiche une liste de titres de groupes. Cliquez sur un groupe et toutes les options disponibles se dérouleront.

liste de l’API

Verbes HTTP

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

Utilisations de l’API

Commençons !

Configuration

Afin d’accéder aux requêtes 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 d’un jeton API est disponible dans votre Mon profil menu. Sélectionnez Jetons API.

mon profil

Cliquez sur Nouveau jeton API.

jetons API

Saisissez le nom du jeton, pour ce tutoriel nous avons appelé le nôtre « testToken », puis cliquez sur Enregistrer.

L’identifiant du jeton est créé.

identifiant du jeton

Connexion à l’API

Dans l’interface de l’API, cliquez sur le Connexion bouton en haut à droite de l’écran et saisissez votre nom d’utilisateur et votre mot de passe ou fournissez un jeton API. Cliquez sur Envoyer et une requête de connexion sera envoyée à l’API afin de récupérer un jeton de session valide. Ce jeton sera ensuite utilisé pour valider toutes les requêtes API que vous souhaitez effectuer pendant la session.

connexion à l’API
connexion à l’API

Comment effectuer une requête à l’API

Prenons l’exemple du groupe Campaigns ; cliquez dessus et le groupe s’ouvrira pour afficher les requêtes disponibles :

Cliquez sur la requête que vous souhaitez automatiser ; dans cet exemple, nous demanderons les données du CID 1923724 en utilisant :

obtenir la campagne

Cliquez sur Obtenir la campagne ce qui agrandit la fenêtre. Saisissez le numéro d’identifiant de campagne dans le champ :

identifiant de campagne

Ensuite, cliquez sur le Essayez maintenant bouton. Le corps de la réponse générera automatiquement le code.

corps de la réponse

Un code de réponse de 200 signifie qu’il peut être utilisé sans problème.

Comment mettre une campagne en pause

Voici un autre exemple. Sélectionnez d’abord la fonction correcte dans le groupe Campaigns :

pause de campagne

Cliquez sur Mettre en pause pour une ou plusieurs campagnes. Une fois ouvert, cliquez sur Example Value, puis cliquez sur la case jaune ; cela collera automatiquement la structure JSON dans la zone du corps.

pause

La valeur actuelle est maintenant zéro, donc remplacez le zéro par le CID que vous voulez mettre en pause. Ensuite, cliquez sur le Essayez bouton pour générer le code nécessaire.

identifiant de campagne

Comment mettre à jour la tarification d’une campagne

Sélectionnez la fonction correcte :

identifiant de campagne

Cliquez sur Mettre à jour une campagne, pour ouvrir la fenêtre. Ajoutez le CID dans le champ d’identifiant de campagne, puis cliquez sur Valeur d’exemple, cliquez sur la case jaune qui copiera la structure JSON dans la zone du corps.

Ce code contient plusieurs fonctions différentes, mais nous voulons le code de tarification de la campagne, alors supprimez la partie du code qui n’est pas nécessaire en ne laissant dans la zone que le code de tarification de la campagne, comme ci-dessous :

identifiant de campagne

Maintenant, nous devons modifier deux choses dans la zone du corps : le modèle (ci-dessous se trouve une liste des valeurs liées à chaque modèle de tarification).

Nous allons rester sur CPC, donc nous laisserons model à 1

Il faut maintenant changer le prix de zéro au prix souhaité. Nous allons le changer à 200, ce qui signifie que le nouveau prix sera de 200 centimes, soit deux euros.

identifiant de campagne

Puis cliquez simplement sur le Essayez bouton pour générer le code. Facile !

Comme vous pouvez le voir, l’API regorge de fonctionnalités à automatiser ; la seule limite est votre imagination pour exploiter la puissance de l’automatisation.

Enfin, assurez-vous de vous abonner à notre newsletter API, que vous trouverez en bas de l’interface de l’API, afin de recevoir les dernières actualités et mises à jour.

Ce contenu vous a-t-il été utile ?