Ad Manager API menyediakan kumpulan data, yang paling umum dalam metode
List. Koleksi dapat berukuran arbitrer dan diberi nomor halaman dalam respons
API.
Dasar-dasar
Pesan permintaan untuk koleksi menentukan kolom pageSize bilangan bulat opsional untuk menentukan jumlah maksimum hasil yang akan ditampilkan.
Tetapkan parameter pageSize ke angka positif, kurang dari 1000. Jika Anda tidak menetapkan nilai apa pun atau menetapkan parameter ke nol, API akan menggunakan nilai default 50. Jika Anda menetapkan parameter ke nilai negatif, API akan menampilkan error INVALID_ARGUMENT.
Lihat dokumentasi referensi resource, misalnya
AdBreaks,
untuk mengetahui nilai pageSize khusus resource.
API mungkin menampilkan lebih sedikit hasil daripada jumlah yang diminta (termasuk hasil
nol), meskipun tidak di akhir koleksi. Gunakan keberadaan
kolom nextPageToken untuk menentukan apakah ada hasil tambahan dalam
koleksi.
Pesan respons untuk koleksi menentukan kolom nextPageToken string, yang
dapat digunakan untuk mengambil halaman berikutnya. Kolom nextPageToken kosong saat
akhir koleksi tercapai. Ini adalah satu-satunya cara untuk menentukan apakah Anda
telah mencapai akhir koleksi.
Pesan permintaan untuk koleksi menentukan kolom pageToken string opsional untuk melanjutkan ke halaman berikutnya dalam koleksi. Perubahan pada pageSize dalam
permintaan untuk halaman berikutnya diizinkan. Semua argumen lainnya harus sama;
jika ada argumen yang berbeda, API akan menampilkan error INVALID_ARGUMENT.
Contoh
cURL
Permintaan awal
curl https://admanager.googleapis.com/v1/networks/123456/adUnits?pageSize=500
{
"adUnits": [ ... ],
"nextPageToken": "eCGwAcs6hUerggzd2DGv"
}
Permintaan halaman berikutnya
curl https://admanager.googleapis.com/v1/networks/123456/adUnits?pageSize=500&pageToken=eCGwAcs6hUerggzd2DGv
{
"adUnits": [ ... ]
}
Ukuran total
Pesan respons untuk koleksi memberikan bilangan bulat totalSize yang mewakili jumlah total entity setelah pemfilteran diterapkan. Kolom ini hanya
diisi jika diminta dalam mask kolom.
GET https://admanager.googleapis.com/v1/networks/123456/adUnits?$fields=adUnits,nextPageToken,totalSize
Mengurutkan hasil
Pesan permintaan untuk koleksi menentukan kolom orderBy string untuk menentukan
urutan pengurutan.
Nilai harus berupa daftar kolom yang dipisahkan koma. Misalnya: foo,bar. Urutan pengurutan default adalah menaik. Untuk menentukan urutan menurun untuk kolom,
tambahkan akhiran desc; misalnya: foo desc, bar. Karakter spasi
yang berlebihan dalam sintaksis akan diabaikan. Nilai orderBy foo, bar desc, foo , bar desc, dan foo,bar desc semuanya setara. Subkolom ditentukan
dengan karakter ., seperti foo.bar atau address.street.
Pengurutan hanya didukung di kolom primitif.
Lewati hasil
Metode untuk operasi yang di-paging menentukan kolom skip bilangan bulat untuk melewati
hasil. Nilai lewati mengacu pada jumlah setiap resource yang akan dilewati,
bukan jumlah halaman.
Contoh:
Permintaan tanpa token halaman dan nilai lewati 30 akan menampilkan satu halaman hasil yang dimulai dengan hasil ke-31.
Permintaan dengan token halaman yang sesuai dengan hasil ke-51 (karena 50 hasil pertama ditampilkan di halaman pertama) dan nilai lewati 30 akan menampilkan satu halaman hasil yang dimulai dengan hasil ke-81.
Jika nilai lewati diberikan yang menyebabkan kursor berpindah melewati akhir kumpulan hasil, responsnya adalah 200 OK dengan kumpulan hasil kosong tanpa nextPageToken.