Pagination

L'API REST Ad Manager fournit des collections de données, le plus souvent sous forme de liste méthodes. Les collections peuvent être de taille arbitraire et sont paginées dans l'API. réponses.

Principes de base

Les messages de requête pour les collections définissent un champ facultatif de type entier pageSize pour spécifier le nombre maximal de résultats à renvoyer.

Si pageSize n'est pas défini ou s'il est défini sur 0, la valeur par défaut de 50 est utilisée. Si pageSize dépasse la taille de page maximale de 1 000, l'API force la sur 1 000. Les valeurs négatives génèrent une erreur INVALID_ARGUMENT.

L'API peut renvoyer moins de résultats que le nombre demandé (y compris zéro) des résultats de recherche), même si ce n'est pas le cas à la fin de la collection. Utilisez la présence du paramètre le champ nextPageToken pour déterminer s'il existe d'autres résultats dans le collection.

Les messages de réponse pour les collections définissent un champ nextPageToken de chaîne, qui peut servir à récupérer la page suivante. Le champ nextPageToken est vide lorsque la fin de la collection est atteint. C'est le seul moyen de déterminer si vous avez atteint la fin d'une collection.

Les messages de requête pour les collections définissent un champ de chaîne facultatif pageToken. pour passer à la page suivante de la collection. Les modifications du pageSize dans une requête pour les pages suivantes sont autorisées. Tous les autres arguments doivent être identiques. si certains arguments sont différents, l'API renvoie une erreur INVALID_ARGUMENT.

Exemple

cURL

Demande initiale

curl https://admanager.googleapis.com/v1/networks/123456/adUnits?pageSize=500

{
  "adUnits": [ ... ],
  "nextPageToken": "eCGwAcs6hUerggzd2DGv"
}

Demande de page suivante

curl https://admanager.googleapis.com/v1/networks/123456/adUnits?pageSize=500&pageToken=eCGwAcs6hUerggzd2DGv

{
  "adUnits": [ ... ]
}

Taille totale

Les messages de réponse pour les collections fournissent un totalSize entier qui représente le nombre total d'entités après l'application du filtrage. Ce champ est uniquement renseignés à la demande masque de champ.

GET https://admanager.googleapis.com/v1/networks/123456/adUnits?$fields=adUnits,nextPageToken,totalSize

Classer les résultats

Les messages de requête pour les collections définissent un champ orderBy de chaîne à spécifier. ordre de tri.

Les valeurs doivent être une liste de champs séparés par une virgule. Exemple : foo,bar. Par défaut, l'ordre de tri est croissant. Pour spécifier l'ordre décroissant pour un champ, ajouter un suffixe desc ; Exemple: foo desc, bar. Les espaces redondants dans la syntaxe sont ignorés. Les valeurs orderBy foo, bar desc, foo , bar desc et foo,bar desc sont tous équivalents. Les sous-champs sont spécifiés avec un caractère ., comme foo.bar ou address.street

Le tri n'est possible que pour les champs primitifs.

Ignorer les résultats

Les méthodes d'une opération paginée définissent un champ skip entier à ignorer résultats. La valeur "Ignorer" fait référence au nombre de ressources individuelles à ignorer. et non le nombre de pages.

Exemple :

Une requête sans jeton de page et une valeur de désactivation de 30 renvoie une seule page de en commençant par le 31e résultat.

Une requête avec un jeton de page correspondant au 51e résultat (car le premier 50 résultats ont été renvoyés sur la première page) et un saut de 30 renvoie une une seule page de résultats à partir du 81e résultat.

Si une valeur d'omission est fournie et que le curseur se déplace au-delà de la fin de la de résultats, la réponse est 200 OK avec un ensemble de résultats vide sans nextPageToken