Appels d’API

Consultez des exemples d’appels d’API pour utiliser le moteur de règles publicitaires.

Lire toutes les règles d’un compte

curl -G   \
-d 'fields=name,evaluation_spec,execution_spec,status'   \
-d 'access_token=<ACCESS_TOKEN>'   \
https://graph.facebook.com/<VERSION>/<AD_ACCOUNT_ID>/adrules_library

Lire une règle

curl -G   \
-d 'fields=name,evaluation_spec,execution_spec,status'   \
-d 'access_token=<ACCESS_TOKEN>'   \
https://graph.facebook.com/<VERSION>/<AD_RULE_ID>

Mettre à jour une règle

Pour mettre à jour une spécification, fournissez tous les champs, y compris ceux qui restent inchangés. L’exemple ci-dessous définit le déclencheur de règles sur un intervalle de 1 000 impressions. Pour mettre à jour le statut d’une règle, vous ne devez apporter aucune modification à ses spécifications.

curl \
-F 'evaluation_spec={
      "evaluation_type": ...,
      "trigger" : {
        "type": "STATS_MILESTONE",
        "field": "impressions",
        "value": 1000,
        "operator": "EQUAL"
      },
      "filters": ...
     ]
   }' \
-F 'access_token=<ACCESS_TOKEN>'   \
https://graph.facebook.com/<VERSION>/<AD_RULE_ID>

L’exemple ci-dessous met à jour les filtres de manière à sélectionner toutes les publicités qui ont plus de 200 clics. Les autres filtres, comme entity_type et time_preset, doivent aussi être inclus dans cette mise à jour.

curl \
-F 'evaluation_spec={
      "evaluation_type": ...,
      "filters" : [
       {
         "field": "clicks",
         "value": 200,
         "operator": "GREATER_THAN",
       },
       {
       ...
     ]
   }' \
-F 'access_token=<ACCESS_TOKEN>'   \
https://graph.facebook.com/<VERSION>/<AD_RULE_ID>

Supprimer une règle

curl -X DELETE \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<VERSION>/<AD_RULE_ID>

Accéder à l’historique des exécutions d’une règle

Un point de terminaison permet d’accéder à l’historique des exécutions de chaque règle. Par défaut, ce point de terminaison fournit des données pertinentes telles que les résultats et les actions. Vous pouvez aussi vérifier l’état de la règle à chaque exécution pour suivre ses modifications.

curl -G   \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<VERSION>/<AD_RULE_ID>/history

De plus, ce point de terminaison prend en charge trois mécanismes de filtrage des données : object_id, action et hide_no_changes. Vous pouvez filtrer les données par object_id ou par action pour obtenir uniquement les résultats d’un object_id ou d’un type d’action.

Vous pouvez également filtrer les résultats avec l’indicateur hide_no_changes pour exclure toutes les exécutions qui n’ont entraîné aucun changement. Il est possible de combiner ces filtres pour affiner les résultats.

curl -G   \
-d 'object_id=123' \
-d 'action=CHANGED_BID' \
-d 'hide_no_changes=true' \
-d "access_token=<ACCESS_TOKEN>" \
https://graph.facebook.com/<VERSION>/<AD_RULE_ID>/history

Accéder à l’historique des exécutions d’un compte

Un point de terminaison permet d’accéder aux données d’historique agrégées de toutes les règles associées à votre compte. Par défaut, ce point de terminaison fournit les mêmes données pertinentes que l’historique des exécutions d’une règle, mais inclut également l’ID de la règle pour chaque entrée.

Les entrées de ce point de terminaison sont classées par ordre chronologique inverse. Ce point de terminaison prend en charge les mêmes mécanismes de filtrage que plus haut : object_id, action et hide_no_changes.

curl -G   \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<VERSION>/<AD_ACCOUNT_ID>/adrules_history

Prévisualiser une règle

Un point de terminaison permet de prévisualiser l’évaluation d’une règle avec calendrier. Lorsqu’il reçoit une requête POST, ce point de terminaison renvoie une liste d’objets respectant tous les filtres actuellement spécifiés pour la règle.

curl \
-F 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<VERSION>/<AD_RULE_ID>/preview

Exécuter manuellement une règle

Un point de terminaison permet d’exécuter manuellement une règle avec calendrier. Lorsque ce point de terminaison reçoit une requête POST, l’exécution de la règle concernée est immédiatement planifiée.

curl \
-F 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<VERSION>/<AD_RULE_ID>/execute

Les résultats peuvent être récupérés via l’historique des exécutions une fois l’exécution de la règle terminée.

Lire les règles régissant un objet

Des points de terminaison permettent de lire toutes les règles régissant chaque publicité, ensemble de publicités et campagne publicitaire. Par défaut, une règle régit un objet si elle le référence de façon statique avec le filtre id ou de façon dynamique avec le filtre entity_type.

Ce point de terminaison prend également en charge une option pass_evaluation. Grâce à elle, vous pouvez limiter encore la liste des règles, selon que l’objet correspond ou non aux filtres de la règle à ce moment-là. Si pass_evaluation est true, nous renvoyons toutes les règles qui renverraient l’objet lors d’une prévisualisation. Si l’option est false, nous renvoyons toutes les règles qui ne le renverraient pas.

curl \
-F 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/<VERSION>/<AD_OBJECT_ID>/adrules_governed