Pagination

Die Ad Manager REST API stellt Datensammlungen zur Verfügung, die meistens in List erstellt werden. . Sammlungen können eine beliebige Größe haben und werden in der API paginiert. Antworten.

Grundlagen

Anfragenachrichten für Sammlungen definieren ein optionales Ganzzahlfeld pageSize, um gibt die maximale Anzahl der zurückzugebenden Ergebnisse an.

Wenn pageSize nicht konfiguriert oder auf 0 festgelegt ist, wird der Standardwert 50 verwendet. Wenn pageSize die maximale Seitengröße von 1.000 überschreitet, erzwingt die API das Seitengröße auf 1.000 festlegen. Negative Werte führen zum Fehler INVALID_ARGUMENT.

Die API gibt möglicherweise weniger Ergebnisse als die angeforderte Anzahl zurück (einschließlich null) Ergebnisse), auch wenn sie nicht am Ende der Sammlung stehen. Nutzen Sie das Vorhandensein der Spalte nextPageToken, um festzustellen, ob zusätzliche Ergebnisse im .

Antwortnachrichten für Sammlungen definieren das Stringfeld nextPageToken, das kann verwendet werden, um die nächste Seite abzurufen. Das Feld nextPageToken ist leer, wenn das Ende der Sammlung erreicht haben. Dies ist die einzige Möglichkeit festzustellen, ob Sie das Ende eines .

In Anfragenachrichten für Sammlungen ist das optionale Stringfeld pageToken definiert um zur nächsten Seite der Sammlung zu gelangen. Änderungen an pageSize in einer Anfrage für nachfolgende Seiten sind zulässig. Alle anderen Argumente müssen gleich sein. Bei unterschiedlichen Argumenten gibt einen INVALID_ARGUMENT-Fehler zurück.

Beispiel

cURL

Erste Anfrage

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

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

Nächste Seitenanfrage

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

{
  "adUnits": [ ... ]
}

Gesamtgröße

Antwortnachrichten für Sammlungen enthalten eine Ganzzahl totalSize, die für Gesamtzahl der Entitäten nach Anwendung des Filters Dieses Feld enthält nur bei Anfrage im Feldmaske.

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

Bestellergebnisse

In Anfragenachrichten für Sammlungen wird das Stringfeld orderBy definiert, das angegeben werden soll. Sortierreihenfolge geordnet werden.

Die Werte sollten in einer durch Kommas getrennten Liste von Feldern angegeben werden. Beispiel: foo,bar. Die Standardsortierreihenfolge ist aufsteigend. Um eine absteigende Reihenfolge für ein Feld festzulegen, ein desc-Suffix anhängen. Beispiel: foo desc, bar. Überflüssige Leerzeichen in der Syntax werden ignoriert. Die orderBy-Werte foo, bar desc, foo , bar desc und foo,bar desc sind alle gleichwertig. Unterfelder werden mit dem Zeichen . angegeben, z. B. foo.bar oder address.street

Die Sortierung wird nur für einfache Felder unterstützt.

Ergebnisse überspringen

Methoden für einen paginierten Vorgang definieren ein ganzzahliges skip-Feld, das übersprungen werden soll Ergebnisse. Der Überspringungswert bezieht sich auf die Anzahl der einzelnen Ressourcen, nicht die Anzahl der Seiten.

Beispiel:

Bei einer Anfrage ohne Seitentoken und dem Wert 30 für das Überspringen wird eine einzelne Seite mit beginnend mit dem 31. Ergebnis.

Eine Anfrage mit einem Seitentoken, das dem 51. Ergebnis entspricht (da das erste 50 Ergebnisse auf der ersten Seite zurückgegeben.) und der Wert 30 für das Überspringen Seite mit Ergebnissen beginnend mit dem 81. Ergebnis.

Wenn ein Wert für das Überspringen angegeben ist, durch den der Cursor über das Ende des Sammlung von Ergebnissen erhalten, lautet die Antwort 200 OK mit einer leeren Ergebnismenge ohne nextPageToken.