Podział na strony

Interfejs API typu REST Ad Managera udostępnia zbiory danych, najczęściej w przypadku list . Kolekcje mogą mieć dowolny rozmiar i są dzielone na strony w interfejsie API odpowiedzi.

Podstawy

Komunikaty żądania dotyczące kolekcji definiują opcjonalną liczbę całkowitą pageSize w polu określa maksymalną liczbę wyników do zwrócenia.

Jeśli pageSize nie jest skonfigurowana lub ma wartość 0, używana jest wartość domyślna, czyli 50. Jeśli pageSize przekracza maksymalny rozmiar strony wynoszący 1000, interfejs API wymusza wartość rozmiar strony do 1000. Wartości ujemne dają błąd INVALID_ARGUMENT.

Interfejs API może zwrócić mniej wyników niż wymagana liczba (w tym 0) nawet jeśli nie kończy się na końcu zbioru. Skorzystaj z obecności tagu nextPageToken, aby określić, czy są dodatkowe wyniki w kolekcji.

Komunikaty odpowiedzi dotyczące kolekcji definiują pole nextPageToken ciągu znaków, które może posłużyć do pobrania następnej strony. Pole nextPageToken jest puste, gdy koniec kolekcji jest udało się dotrzeć. Jest to jedyny sposób, aby ustalić, czy reklama dotarła do końca kolekcji.

Komunikaty żądania dotyczące kolekcji definiują opcjonalny ciąg znaków pageToken aby przejść do następnej strony w kolekcji. Zmiany elementu pageSize w żądaniu wyświetlenia kolejnych stron są dozwolone. Wszystkie inne argumenty muszą być takie same; jeśli dowolne argumenty są różne, interfejs API zwraca błąd INVALID_ARGUMENT.

Przykład

cURL

Wstępne żądanie

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

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

Żądanie następnej strony

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

{
  "adUnits": [ ... ]
}

Całkowity rozmiar

Komunikaty z odpowiedziami na temat kolekcji zawierają liczbę całkowitą totalSize, która odpowiada łączną liczbę elementów po zastosowaniu filtra. To pole jest tylko jest wypełniany na żądanie w maski pola.

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

Wyniki wyszukiwania

Komunikaty żądania dotyczące kolekcji definiują pole orderBy z ciągiem znaków, które należy określić kolejność sortowania.

Wartości powinny mieć postać listy pól rozdzielanej przecinkami. Na przykład: foo,bar. Domyślna kolejność sortowania to rosnąco. Aby określić kolejność malejącą dla pola, dołącz sufiks desc; na przykład: foo desc, bar. Zbędne znaki spacji w składni są ignorowane. Wartości orderBy foo, bar desc, foo , bar desc i foo,bar desc są równoważne. Pola podrzędne są określane za pomocą znaku ., np. foo.bar lub address.street

Sortowanie jest obsługiwane tylko w przypadku pól podstawowych.

Pomiń wyniki

Metody operacji podziału na strony definiują pole skip z liczbą całkowitą, które ma być pomijane wyników. Wartość pominięcia odnosi się do liczby poszczególnych zasobów do pominięcia, a nie liczbę stron.

Na przykład:

Żądanie bez tokena strony z wartością pominięcia 30 zwraca jedną stronę wyników, zaczynając od 31. wyniku.

Żądanie z tokenem strony odpowiadającym 51 wynikowi (ponieważ pierwszy wynik na pierwszej stronie zostało zwróconych 50 wyników), a wartość pominięcia 30 powoduje zwrócenie Pojedyncza strona wyników, zaczynając od 81. wyniku.

Jeśli zostanie podana wartość pominięcia, która powoduje, że kursor przesuwa się poza koniec zbiór wyników, odpowiedź to 200 OK z pustym zestawem wyników bez argumentu nextPageToken