La API de REST de Ad Manager proporciona colecciones de datos, generalmente en List. . Las colecciones pueden tener un tamaño arbitrario y se paginan en la API de respuestas ante incidentes.
Conceptos básicos
Los mensajes de solicitud para colecciones definen un campo opcional pageSize de número entero para
especificar la cantidad máxima de resultados que se mostrarán.
Si no se establece pageSize o si es 0, se usa el valor predeterminado de 50.
Si pageSize supera el tamaño máximo de página de 1,000, la API coerciona
tamaño de la página a 1,000.
Los valores negativos generan un error INVALID_ARGUMENT.
Es posible que la API muestre menos resultados que la cantidad solicitada (incluido cero).
los resultados), incluso si no es así al final de la recopilación. Usa la presencia del
nextPageToken para determinar si hay resultados adicionales en el
de elementos no utilizados.
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 estará vacío cuando el final de la colección sea
alcanzada. Esta es la única forma de determinar si llegaste al final de un
de elementos no utilizados.
Los mensajes de solicitud para colecciones definen el campo opcional pageToken de una cadena.
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 de los argumentos 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 totalSize entero que representa
la cantidad total de entidades después de aplicar el filtro. Este campo es solo
completar cuando se solicita en la
máscara de campo.
GET https://admanager.googleapis.com/v1/networks/123456/adUnits?$fields=adUnits,nextPageToken,totalSize
Resultados del pedido
Los mensajes de solicitud para colecciones definen un campo de cadena orderBy para especificar.
como orden de clasificación.
Los valores deben ser una lista de campos separados por comas. Por ejemplo: foo,bar.
El orden predeterminado es ascendente. Para especificar el orden descendente para un campo,
agrega un sufijo desc; por ejemplo: foo desc, bar.
Se ignoran los caracteres de espacio redundantes de la sintaxis. Los valores 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
Solo se admite el ordenamiento en campos primitivos.
Omitir resultados
Los métodos para una operación de paginación definen un campo skip de número entero que se omitirá
resultados. El valor de omisión se refiere a la cantidad de recursos individuales que se deben omitir,
no 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 a partir del resultado número 31.
Una solicitud con un token de página que corresponde al resultado número 51 (porque el primer 50 resultados se mostraron en la primera página) y un valor de omisión de 30 devuelve un 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 desplace 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