Pagination

Afin de prendre en charge un nombre maximal plus important de campagnes et une récupération efficace de toutes les entités associées à un compte, l’Ads API prend désormais en charge la pagination sur de nombreux endpoints GET. Le mécanisme de pagination est simple à utiliser et très similaire à la pagination basée sur des curseurs de l’API REST, comme décrit dans Using cursors to navigate collections.

​

Prise en main

Pour certaines requêtes GET, nous acceptons désormais les paramètres de requête cursor et count, qui sont tous deux facultatifs. Si une réponse contient plus de count entités, ces endpoints renvoient désormais les count premières entités et incluent une clé next_cursor dans le JSON de la réponse.

GET https://ads-api.x.com/5/accounts/abc1/campaigns?count=50

{
  "data": \[...\],
  "next_cursor": "c-3yvu1pzhd3i7",
  "request": {...}
}

Pour obtenir la série de réponses suivante, vous devez ajouter le paramètre cursor à vos paramètres de requête :

GET https://ads-api.x.com/5/accounts/abc1/campaigns?cursor=c-3yvu1pzhd3i7&count=50

{
  "data": \[...\],
  "next_cursor": "c-3w3zdyg8ywan",
  "request": {...}
}

​

Approfondir

Pour la plupart des endpoints, la valeur maximale de count est 1 000, la valeur minimale est 1 et la valeur par défaut est 200.

La valeur fournie par next_cursor est toujours une chaîne de caractères et doit être considérée comme opaque ; son implémentation est susceptible de changer. Si moins de count entités sont renvoyées dans la page actuelle du jeu de résultats, la valeur de next_cursor sera null.

Remarque : les endpoints d’analytics ne prennent pas en charge ce style de pagination. La pagination sur les endpoints de statistiques est prise en charge en spécifiant des périodes de temps. Consultez la documentation de ces endpoints pour plus d’informations.