Vous pouvez récupérer les prospects avec la fonctionnalité Webhooks ou la récupération groupée.
Pour récupérer des champs spécifiques de publicités, tels que ad_id
, campaign_id
, vous aurez besoin des éléments suivants :
pages_manage_metadata
, en cas d’utilisation des Webhooks Pour récupérer toutes les données de prospects et les données au niveau des publicités, vous aurez besoin des éléments suivants :
Remarque : si ce ou cette admin de page n’a jamais personnalisé de prospects ni accordé d’autorisation d’accès à l’aide du gestionnaire d’accès aux prospects, l’ENSEMBLE des admins de page disposent de l’autorisation d’accès aux prospects. Si l’autorisation d’accès aux prospects est personnalisée par les admins de l’entreprise, l’autorisation d’accès aux prospects pour une simple admin de page dépend de la configuration de l’admin de l’entreprise.
Le plafond est de 200 × 24, multiplié par le nombre de prospects créés au cours des 90 derniers jours pour une page Facebook. Si vous passez plus d’appels durant les dernières 24 heures, votre requête renvoie une erreur.
Envoyez une requête GET
au point de terminaison /ads/lead_gen/export_csv/
, où les formats de date sont des horodatages de type POSIX
ou UNIX
:
curl -i -X GET "https://www.facebook.com/ads/lead_gen/export_csv/ ?id=<FORM_ID> &type=form &from_date=1482698431 &to_date=1482784831"
from_date
n’est pas défini ou si sa valeur est antérieure à la date de création du formulaire, cette dernière est utilisée.Si le paramètre to_date
n’est pas défini ou si sa valeur est postérieure à la date actuelle, cette dernière est utilisée.
Il est possible que certaines entrées du fichier TSV ne contiennent pas d’ID publicité ni d’ID de groupe publicitaire, pour l’une des raisons suivantes :
is_organic
affiche la valeur 1
dans le fichier TSV. Sinon, il affiche la valeur 0
.Obtenez des mises à jour en temps réel pour les publicités à formulaire.
Consultez notre guide de démarrage sur les webhooks pour configurer votre point de terminaison et votre webhook.
Générez un token de page longue durée pour récupérer les données en continu, sans vous soucier de son expiration.
Consultez notre guide Webhooks pour les pages pour savoir comment installer votre application sur une page.
Lors de la création de prospects, votre application reçoit la réponse Webhook suivante :
array( "object" => "page", "entry" => array( "0" => array( "id" => 153125381133, "time" => 1438292065, "changes" => array( "0" => array( "field" => "leadgen", "value" => array( "leadgen_id" => 123123123123, "page_id" => 123123123, "form_id" => 12312312312, "adgroup_id" => 12312312312, "ad_id" => 12312312312, "created_time" => 1440120384 ) ), "1" => array( "field" => "leadgen", "value" => array( "leadgen_id" => 123123123124, "page_id" => 123123123, "form_id" => 12312312312, "adgroup_id" => 12312312312, "ad_id" => 12312312312, "created_time" => 1440120384 ) ) ) ) ) )
Vous pouvez utiliser le paramètre leadgen_id
pour récupérer des données associées au prospect :
curl -X GET \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v21.0/{lead-id}/
Si l’opération réussit, votre application reçoit la réponse suivante :
{ "created_time": "2015-02-28T08:49:14+0000", "id": "<LEAD_ID>", "ad_id": "<AD_ID>", "form_id": "<FORM_ID>", "field_data": [{ "name": "car_make", "values": [ "Honda" ] }, { "name": "full_name", "values": [ "Joe Example" ] }, { "name": "email", "values": [ "joe@example.com" ] }, { "name": "selected_dealer", "values": [ "99213450" ] }], ... }
Vous pouvez voir un exemple de cette implémentation dans notre dépôt Github.
Les applications créées après le 2 juillet 2018 doivent utiliser l’autorisation leads_retrieval
pour récupérer des prospects.
Le paramètre leads
existe au niveau des nœuds du groupe publicitaire et du formulaire. Il renvoie toutes les données associées à leurs objets spécifiques. Étant donné qu’un formulaire peut être réutilisé dans de nombreuses publicités, celui-ci peut générer beaucoup plus de prospects qu’une publicité qui l’a diffusé.
Pour récupérer les prospects de manière groupée par publicité :
curl -X GET \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v21.0/{adgroup-id}/leads
Pour récupérer les prospects par formulaire :
curl -G \ -d 'access_token=<ACCESS_TOKEN>' \ -d 'fields=created_time,id,ad_id,form_id,field_data' \ https://graph.facebook.com/<API_VERSION>/<FORM_ID>/leads
Réponse :
{ "data": [ { "created_time": "2018-02-28T08:49:14+0000", "id": "<LEAD_ID>", "ad_id": "<AD_ID>", "form_id": "<FORM_ID>", "field_data": [ { "name": "car_make", "values": [ "Honda" ] }, { "name": "full_name", "values": [ "Joe Example" ] }, { "name": "email", "values": [ "joe@example.com" ] }, ], ... } ], "paging": { "cursors": { "before": "OTc2Nz3M8MTgyMzU1NDMy", "after": "OTcxNjcyOTg8ANTI4NzE4" } } }
Les questions de la carte des magasins ne sont pas différentes des autres questions. Ces questions possèdent également un ID de champ mappé avec les autres questions lors de la création du formulaire. Elles seront envoyées de la même façon que les autres questions. La valeur transmise émanera du Numéro de magasin du lieu sélectionné.
Par exemple, supposons qu’une question de la carte des magasins possède selected_dealer
comme ID de champ. Pour récupérer les prospects de manière groupée, vous pouvez appeler :
curl -G \ -d 'access_token=<ACCESS_TOKEN>' \ -d 'fields=created_time,id,ad_id,form_id,field_data' \ https://graph.facebook.com/<API_VERSION>/<FORM_ID>/leads
Réponse :
{ "data": [ { "created_time": "2018-02-28T08:49:14+0000", "id": "<LEAD_ID>", "ad_id": "<AD_ID>", "form_id": "<FORM_ID>", "field_data": [ { "name": "car_make", "values": [ "Honda" ] }, { "name": "full_name", "values": [ "Joe Example" ] }, { "name": "email", "values": [ "joe@example.com" ] }, { "name": "selected_dealer", "values": [ "99213450" ] } ], ... } ], "paging": { "cursors": { "before": "OTc2Nz3M8MTgyMzU1NDMy", "after": "OTcxNjcyOTg8ANTI4NzE4" } } }
Le champ field_data
ne contient pas les réponses aux cases que l’utilisateur ou l’utilisatrice peut cocher dans les limitations de responsabilité personnalisées. Pour les récupérer, utilisez le champ custom_disclaimer_responses
.
curl -X GET \ "https://graph.facebook.com/<API_VERSION>/<LEADGEN_ID>? fields=custom_disclaimer_responses"
Réponse :
{ "custom_disclaimer_responses": [ { "checkbox_key": "optional_1", "is_checked": "1" }, { "checkbox_key": "optional_2", "is_checked": "" } ], "id": "1231231231" }
Dans cet exemple, les prospects sont filtrés en fonction de l’horodatage. Le format Unix doit être utilisé.
curl -X GET \
-d 'filtering=[
{
"field": "time_created",
"operator": "GREATER_THAN",
"value": 1731608702
}
]' \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v21.0/{adgroup-id}/leads
Le champ operator
contient l’une des valeurs suivantes.
Opérateur·trice | Signification |
---|---|
| Filtre les valeurs inférieures à l’horodatage. |
| Filtres les valeurs supérieures à l’horodatage. |
| Filtre les valeurs supérieures ou égales à l’horodatage. |
Si le formulaire comporte des ID de champs personnalisés, les champs et les valeurs renvoyés seront ceux spécifiés par les ID.