Ad Manager API menyediakan kumpulan data, yang paling umum dalam metode List. Kumpulan dapat berukuran arbitrer dan diberi nomor halaman dalam respons API.
Dasar-dasar
Pesan permintaan untuk kumpulan menentukan kolom pageSize bilangan bulat opsional untuk menentukan jumlah maksimum hasil yang akan ditampilkan.
Tetapkan parameter pageSize ke bilangan 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 nilai pageSize khusus resource.
API mungkin menampilkan lebih sedikit hasil daripada jumlah yang diminta (termasuk nol hasil), meskipun tidak di akhir kumpulan. Gunakan keberadaan kolom nextPageToken untuk menentukan apakah ada hasil tambahan dalam kumpulan.
Pesan respons untuk kumpulan menentukan kolom nextPageToken string, yang dapat digunakan untuk mengambil halaman berikutnya. Kolom nextPageToken kosong saat akhir kumpulan tercapai. Ini adalah satu-satunya cara untuk menentukan apakah Anda telah mencapai akhir kumpulan.
Pesan permintaan untuk kumpulan menentukan kolom pageToken string opsional untuk melanjutkan ke halaman berikutnya dalam kumpulan. 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 kumpulan menyediakan totalSize bilangan bulat 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
Urutkan hasil
Pesan permintaan untuk kumpulan menentukan kolom orderBy string untuk menentukan urutan pengurutan.
Nilai harus berupa daftar kolom yang dipisahkan koma. Misalnya: foo,bar. Susunan 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 pada kolom primitif.
Lewati hasil
Metode untuk operasi yang diberi nomor halaman menentukan kolom skip bilangan bulat untuk melewati hasil. Nilai lewati mengacu pada jumlah resource individual 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 bergerak melewati akhir kumpulan hasil, responsnya adalah 200 OK dengan kumpulan hasil kosong tanpa nextPageToken.