Impaginazione

L'API REST Ad Manager fornisce raccolte di dati, solitamente nella scheda Elenco di machine learning. Le raccolte possono essere dimensionate arbitrariamente e impaginate nell'API diverse.

Nozioni di base

I messaggi di richiesta per le raccolte definiscono un campo pageSize intero facoltativo su cui specificare il numero massimo di risultati da restituire.

Se pageSize non viene configurato o se è pari a 0, viene utilizzato il valore predefinito 50. Se pageSize supera la dimensione massima della pagina pari a 1000, l'API costringe il valore dimensione pagina a 1000. I valori negativi generano un errore INVALID_ARGUMENT.

L'API potrebbe restituire meno risultati di quelli richiesti (incluso zero) dei risultati), anche se non alla fine della raccolta. Utilizza la presenza del componente nextPageToken per determinare se esistono ulteriori risultati nel .

I messaggi di risposta per le raccolte definiscono un campo di stringa nextPageToken, che può essere utilizzato per recuperare la pagina successiva. Il campo nextPageToken è vuoto quando la fine della raccolta è raggiunto. Questo è l'unico modo per determinare se hai raggiunto la fine di un .

I messaggi di richiesta per le raccolte definiscono una stringa facoltativa con il campo pageToken per passare alla pagina successiva della raccolta. Sono consentite modifiche a pageSize in una richiesta per le pagine successive. Tutti gli altri argomenti devono essere gli stessi. Se gli argomenti sono diversi, l'API restituisce un errore INVALID_ARGUMENT.

Esempio

cURL

Richiesta iniziale

curl https://admanager.googleapis.com/v1/networks/123456/adUnits?pageSize=500

{
  "adUnits": [ ... ],
  "nextPageToken": "eCGwAcs6hUerggzd2DGv"
}

Richiesta pagina successiva

curl https://admanager.googleapis.com/v1/networks/123456/adUnits?pageSize=500&pageToken=eCGwAcs6hUerggzd2DGv

{
  "adUnits": [ ... ]
}

Dimensione totale

I messaggi di risposta per le raccolte forniscono un numero intero totalSize che rappresenta il numero totale di entità dopo l'applicazione del filtro. Questo campo è limitato compilata quando richiesto nel maschera del campo.

GET https://admanager.googleapis.com/v1/networks/123456/adUnits?$fields=adUnits,nextPageToken,totalSize

Risultati degli ordini

I messaggi di richiesta per le raccolte definiscono una stringa da specificare per il campo orderBy di ordinamento.

I valori devono essere costituiti da un elenco di campi separati da virgole. Ad esempio: foo,bar. L'ordinamento predefinito è crescente. Per specificare l'ordine decrescente di un campo: aggiungi un suffisso desc; ad esempio: foo desc, bar. I caratteri degli spazi ridondanti nella sintassi vengono ignorati. Valori di orderBy foo, bar desc, foo , bar desc e foo,bar desc sono tutti equivalenti. I campi secondari vengono specificati con un carattere ., ad esempio foo.bar o address.street.

L'ordinamento è supportato solo per i campi primitivi.

Salta risultati

I metodi per un'operazione impaginata definiscono un campo skip intero da saltare che consentono di analizzare i dati e visualizzare i risultati. Il valore "ignora" si riferisce al numero di singole risorse da saltare, non il numero di pagine.

Ad esempio:

Una richiesta senza token di pagina e con un valore Salta pari a 30 restituisce una singola pagina di risultati che iniziano con il 31° risultato.

Una richiesta con un token di pagina corrispondente al 51° risultato (perché il primo Nella prima pagina sono stati restituiti 50 risultati, mentre il valore Ignora 30 restituisce un valore singola pagina di risultati che inizia dall'81° risultato.

Se viene fornito un valore Ignora che fa spostare il cursore oltre la fine del raccolta di risultati, la risposta è 200 OK con un risultato vuoto impostato senza nextPageToken.