La API de Ad Manager proporciona colecciones de datos, por lo general, en métodos List. Las colecciones pueden tener un tamaño arbitrario y se paginan en las respuestas de la API.
Conceptos básicos
Los mensajes de solicitud de colecciones definen un campo opcional de número entero pageSize para especificar la cantidad máxima de resultados que se mostrarán.
Establece el parámetro pageSize en un número positivo menor que 1000. Si
no estableces ningún valor o estableces el parámetro en cero, la API usa un valor predeterminado
de 50. Si configuras el parámetro en un valor negativo, la API mostrará un error INVALID_ARGUMENT.
Consulta la documentación de referencia de los recursos, por ejemplo, AdBreaks, para obtener un valor pageSize específico del recurso.
Es posible que la API devuelva menos resultados que la cantidad solicitada (incluidos cero resultados), incluso si no está al final de la colección. Usa la presencia del campo nextPageToken para determinar si hay resultados adicionales en la colección.
Los mensajes de respuesta de las colecciones definen un campo nextPageToken de cadena, que se puede usar para recuperar la siguiente página. El campo nextPageToken está vacío cuando se llega al final de la colección. Esta es la única forma de determinar si llegaste al final de una colección.
Los mensajes de solicitud de colecciones definen un campo opcional de cadena pageToken para avanzar a la siguiente página de la colección. Se permiten cambios en el pageSize en una solicitud para páginas posteriores. Todos los demás argumentos deben ser iguales. Si alguno de ellos es diferente, la API muestra un error INVALID_ARGUMENT.
Ejemplo
cURL
Solicitud inicial
curl https://admanager.googleapis.com/v1/networks/123456/adUnits?pageSize=500
{
"adUnits": [ ... ],
"nextPageToken": "eCGwAcs6hUerggzd2DGv"
}
Solicitud de página siguiente
curl https://admanager.googleapis.com/v1/networks/123456/adUnits?pageSize=500&pageToken=eCGwAcs6hUerggzd2DGv
{
"adUnits": [ ... ]
}
Tamaño total
Los mensajes de respuesta de las colecciones proporcionan un número entero totalSize que representa la cantidad total de entidades después de aplicar el filtrado. Este campo solo se propaga cuando se solicita en la máscara de campo.
GET https://admanager.googleapis.com/v1/networks/123456/adUnits?$fields=adUnits,nextPageToken,totalSize
Ordena los resultados
Los mensajes de solicitud de colecciones definen un campo orderBy de cadena para especificar el orden de clasificación.
Los valores deben ser una lista de campos separados por comas. Por ejemplo: foo,bar. El orden de clasificación predeterminado es ascendente. Para especificar el orden descendente de un campo, agrega un sufijo desc; por ejemplo: foo desc, bar. Se ignoran los caracteres de espacio redundantes en la sintaxis. Los valores orderBy foo, bar desc, foo , bar desc y foo,bar desc son equivalentes. Los subcampos se especifican con un carácter ., como foo.bar o address.street.
El orden solo se admite en campos primitivos.
Omitir resultados
Los métodos de una operación paginada definen un campo skip de número entero para omitir los resultados. El valor de omisión se refiere a la cantidad de recursos individuales que se omitirán, no a la cantidad de páginas.
Por ejemplo:
Una solicitud sin un token de página y un valor de omisión de 30 muestra una sola página de resultados que comienza con el resultado 31.
Una solicitud con un token de página que corresponde al resultado 51 (porque los primeros 50 resultados se mostraron en la primera página) y un valor de omisión de 30 muestra una sola página de resultados que comienza con el resultado 81.
Si se proporciona un valor de omisión que hace que el cursor se mueva más allá del final de la recopilación de resultados, la respuesta es 200 OK con un conjunto de resultados vacío sin nextPageToken.