Pagination

A API REST do Ad Manager fornece coleções de dados que geralmente estão na lista métodos. As coleções podem ser dimensionadas arbitrariamente e são paginadas na API de resposta.

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.

Se a pageSize não for definida ou for 0, o valor padrão de 50 será usado. Se o pageSize exceder o tamanho máximo de página de 1.000, a API forçará o tamanho da página até 1.000. Valores negativos resultam em um erro INVALID_ARGUMENT.

A API pode retornar menos resultados do que o número solicitado (incluindo zero resultados, mesmo que não no final da coleta. Use a presença do elemento nextPageToken para determinar se há resultados adicionais no coleção.

As mensagens de resposta para coleções definem um campo nextPageToken de string, que pode ser usada para recuperar a próxima página. O campo nextPageToken ficará vazio quando o fim da coleção for alcançado. Essa é a única maneira de determinar se você chegou ao fim de um coleção.

As mensagens de solicitação para coleções definem um campo pageToken de string opcional para avançar para a próxima página da coleção. São permitidas mudanças no pageSize em uma solicitação de páginas subsequentes. Todos os outros argumentos devem ser os mesmos. se algum argumento for diferente, a API retorna 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 número inteiro totalSize que representa o número total de entidades depois que a filtragem é aplicada. Este campo só é preenchida quando solicitada 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 orderBy de string a ser especificado ordem de classificação.

Os valores devem 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 para um campo, anexar um sufixo desc; por exemplo: foo desc, bar. Caracteres de espaço redundantes na sintaxe são ignorados. Os valores orderBy foo, bar desc, foo , bar desc e foo,bar desc 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.

Pular resultados

Os métodos para uma operação paginada definem um campo skip de número inteiro a ser ignorado resultados. O valor "skip" refere-se ao número de recursos individuais a serem pulados não o número de páginas.

Exemplo:

Uma solicitação sem token de página e um valor "skip" de 30 retorna uma única página de resultados a partir do 31o resultado.

Uma solicitação com um token de página correspondente ao 51o resultado (porque o primeiro 50 resultados foram retornados na primeira página) e um valor de 30 para pular retorna um uma única página de resultados começando com o 81o resultado.

Se for fornecido um valor "skip" que faz com que o cursor se mova além do fim do coleção de resultados, a resposta será 200 OK, com um conjunto de resultados vazio sem nextPageToken.