La API de Ad Manager proporciona colecciones de datos, por lo general, en Listmétodos. Las colecciones pueden tener un tamaño arbitrario y se paginan en las respuestas de la API.
Conceptos básicos
Los mensajes de solicitud para las colecciones definen un campo pageSize entero opcional para especificar la cantidad máxima de resultados que se devolverán.
Establece el parámetro pageSize en un número positivo inferior a 1000. Si no estableces ningún valor o configuras el parámetro en cero, la API usará un valor predeterminado de 50. Si configuras el parámetro con un valor negativo, la API devolverá un error INVALID_ARGUMENT.
Consulta la documentación de referencia de recursos, por ejemplo, AdBreaks, para obtener un valor de pageSize específico del recurso.
Es posible que la API devuelva menos resultados que la cantidad solicitada (incluidos cero resultados), incluso si no se encuentra 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 para las colecciones definen un campo de cadena nextPageToken, que se puede usar para recuperar la página siguiente. El campo nextPageToken está vacío cuando se llega al final de la recopilación. Esta es la única forma de determinar si llegaste al final de una colección.
Los mensajes de solicitud para las colecciones definen un campo de cadena pageToken opcional para avanzar a la siguiente página de la colección. Se permiten cambios en pageSize en una solicitud de páginas posteriores. Todos los demás argumentos deben ser iguales. Si alguno es diferente, la API devuelve 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 para las colecciones proporcionan un número entero totalSize que representa la cantidad total de entidades después de que se aplica el filtrado. Este campo solo se propaga cuando se solicita en la máscara de campos.
GET https://admanager.googleapis.com/v1/networks/123456/adUnits?$fields=adUnits,nextPageToken,totalSize
Ordenar los resultados
Los mensajes de solicitud para las colecciones definen un campo de cadena orderBy 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 de orderBy, foo, bar desc, foo , bar desc y foo,bar desc son todos equivalentes. Los subcampos se especifican con un carácter ., como foo.bar o address.street.
El ordenamiento solo se admite en campos primitivos.
Omitir resultados
Los métodos para una operación paginada definen un campo skip de número entero para omitir resultados. El valor de omisión hace referencia a la cantidad de recursos individuales que se omitirán, no a la cantidad de páginas.
Por ejemplo:
Una solicitud sin token de página y con un valor de omisión de 30 devuelve una sola página de resultados que comienza con el resultado número 31.
Una solicitud con un token de página correspondiente al resultado 51 (porque los primeros 50 resultados se devolvieron en la primera página) y un valor de omisión de 30 devuelve 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 colección de resultados, la respuesta es 200 OK con un conjunto de resultados vacío sin nextPageToken.