A API Ad Manager fornece coleções de dados, mais comumente em métodos List. As coleções podem ter tamanhos arbitrários e são paginadas em respostas da API.
Noções básicas
As mensagens de solicitação para coleções definem um campo pageSize inteiro opcional para especificar o número máximo de resultados a serem retornados.
Defina o parâmetro pageSize como um número positivo menor que 1000. Se você não definir nenhum valor ou definir o parâmetro como zero, a API usará um valor padrão de 50. Se você definir o parâmetro como um valor negativo, a API retornará um erro INVALID_ARGUMENT.
Consulte a documentação de referência do recurso, por exemplo
AdBreaks,
para um valor pageSize específico do recurso.
A API pode retornar menos resultados do que o número solicitado (incluindo zero resultados), mesmo que não esteja no final da coleção. Use a presença do campo nextPageToken para determinar se há outros resultados na coleção.
As mensagens de resposta para coleções definem um campo de string nextPageToken, que pode ser usado para recuperar a próxima página. O campo nextPageToken fica vazio quando o final da coleção é atingido. Essa é a única maneira de determinar se você chegou ao final de uma coleção.
As mensagens de solicitação para coleções definem um campo de string pageToken opcional para avançar para a próxima página da coleção. As mudanças no pageSize em uma solicitação de páginas subsequentes são permitidas. Todos os outros argumentos precisam ser iguais. Se houver argumentos diferentes, a API retornará um erro INVALID_ARGUMENT.
Exemplo
cURL
Solicitação inicial
curl https://admanager.googleapis.com/v1/networks/123456/adUnits?pageSize=500
{
"adUnits": [ ... ],
"nextPageToken": "eCGwAcs6hUerggzd2DGv"
}
Solicitação da próxima página
curl https://admanager.googleapis.com/v1/networks/123456/adUnits?pageSize=500&pageToken=eCGwAcs6hUerggzd2DGv
{
"adUnits": [ ... ]
}
Tamanho total
As mensagens de resposta para coleções fornecem um totalSize inteiro que representa o número total de entidades após a aplicação da filtragem. Esse campo só é
preenchido quando solicitado na máscara de campo.
GET https://admanager.googleapis.com/v1/networks/123456/adUnits?$fields=adUnits,nextPageToken,totalSize
Ordenar resultados
As mensagens de solicitação para coleções definem um campo de string orderBy para especificar a ordem de classificação.
Os valores precisam ser uma lista de campos separados por vírgulas. Por exemplo, foo,bar. A ordem de classificação padrão é crescente. Para especificar a ordem decrescente de um campo,
anexe um desc sufixo. Por exemplo, foo desc, bar. Caracteres de espaço redundantes na sintaxe são ignorados. Os valores foo, bar desc, foo , bar desc e foo,bar desc de orderBy são equivalentes. Os subcampos são especificados
com um . caractere, como foo.bar ou address.street.
A ordenação só é compatível com campos primitivos.
Ignorar resultados
Os métodos para uma operação paginada definem um campo skip inteiro para ignorar resultados. O valor de ignorar se refere ao número de recursos individuais a serem ignorados, não ao número de páginas.
Exemplo:
Uma solicitação sem token de página e um valor de ignorar de 30 retorna uma única página de resultados começando com o 31º resultado.
Uma solicitação com um token de página correspondente ao 51º resultado (porque os primeiros 50 resultados foram retornados na primeira página) e um valor de ignorar de 30 retorna uma única página de resultados começando com o 81º resultado.
Se um valor de ignorar for fornecido e fizer com que o cursor passe do final da coleção de resultados, a resposta será 200 OK com um conjunto de resultados vazio sem nextPageToken.