Die Ad Manager API bietet Datensammlungen, die am häufigsten in List-Methoden enthalten sind. Sammlungen können beliebig groß sein und werden in API-Antworten paginiert.
Grundlagen
In Anfragenachrichten für Sammlungen wird ein optionales pageSize-Ganzzahlfeld definiert, um die maximale Anzahl der zurückzugebenden Ergebnisse anzugeben.
Legen Sie für den Parameter pageSize eine positive Zahl fest, die kleiner als 1000 ist. Wenn Sie keinen Wert festlegen oder den Parameter auf null setzen, verwendet die API den Standardwert 50. Wenn Sie den Parameter auf einen negativen Wert festlegen, gibt die API einen INVALID_ARGUMENT-Fehler zurück.
Einen ressourcenspezifischen pageSize-Wert finden Sie in der Referenzdokumentation zur Ressource, z. B. AdBreaks.
Die API gibt möglicherweise weniger Ergebnisse als angefordert zurück (einschließlich null Ergebnissen), auch wenn dies nicht das Ende der Sammlung ist. Anhand des Vorhandenseins des Felds nextPageToken können Sie feststellen, ob in der Sammlung zusätzliche Ergebnisse vorhanden sind.
In Antwortnachrichten für Sammlungen wird ein Stringfeld nextPageToken definiert, mit dem die nächste Seite abgerufen werden kann. Das Feld nextPageToken ist leer, wenn das Ende der Sammlung erreicht ist. Nur so können Sie feststellen, ob Sie das Ende einer Sammlung erreicht haben.
In Anfragenachrichten für Sammlungen wird ein optionales pageToken-Feld definiert, um zur nächsten Seite in der Sammlung zu wechseln. Änderungen an der pageSize in einer Anfrage für nachfolgende Seiten sind zulässig. Alle anderen Argumente müssen identisch sein. Wenn sich Argumente unterscheiden, gibt die API einen INVALID_ARGUMENT-Fehler zurück.
Beispiel
cURL
Erste Anfrage
curl https://admanager.googleapis.com/v1/networks/123456/adUnits?pageSize=500
{
"adUnits": [ ... ],
"nextPageToken": "eCGwAcs6hUerggzd2DGv"
}
Anfrage für die nächste Seite
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 die Gesamtzahl der Einheiten nach dem Anwenden von Filtern darstellt. Dieses Feld wird nur ausgefüllt, wenn es in der Feldmaske angefordert wird.
GET https://admanager.googleapis.com/v1/networks/123456/adUnits?$fields=adUnits,nextPageToken,totalSize
Ergebnisse sortieren
In Anfragenachrichten für Sammlungen wird ein orderBy-Feld vom Typ „String“ definiert, um die Sortierreihenfolge anzugeben.
Die Werte sollten eine durch Kommas getrennte Liste von Feldern sein. Beispiel: foo,bar. Die Standardsortierreihenfolge ist aufsteigend. Wenn Sie ein Feld absteigend sortieren möchten, hängen Sie das Suffix desc an, z. B. 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 Ganzzahlfeld skip, um Ergebnisse zu überspringen. Der Überspringungswert bezieht sich auf die Anzahl der einzelnen Ressourcen, die übersprungen werden sollen, nicht auf die Anzahl der Seiten.
Beispiel:
Bei einer Anfrage ohne Seitentoken und einem Überspringungswert von 30 wird eine einzelne Seite mit Ergebnissen zurückgegeben, die mit dem 31. Ergebnis beginnt.
Bei einer Anfrage mit einem Seitentoken, das dem 51. Ergebnis entspricht (da die ersten 50 Ergebnisse auf der ersten Seite zurückgegeben wurden), und einem Überspringen-Wert von 30 wird eine einzelne Ergebnisseite zurückgegeben, die mit dem 81. Ergebnis beginnt.
Wenn ein Skip-Wert angegeben wird, der dazu führt, dass der Cursor über das Ende der Ergebnismenge hinaus verschoben wird, ist die Antwort 200 OK mit einer leeren Ergebnismenge ohne nextPageToken.