Ad Manager REST API menyediakan kumpulan data, biasanya dalam Daftar metode. Koleksi dapat diatur ukurannya secara arbitrer dan diberi nomor halaman di API yang dihasilkan.
Dasar-dasar
Meminta pesan untuk koleksi akan menentukan kolom pageSize bilangan bulat opsional untuk
menetapkan jumlah hasil maksimum yang akan ditampilkan.
Jika pageSize tidak disetel atau 0, nilai default 50 akan digunakan.
Jika pageSize melebihi ukuran halaman maksimum 1.000, API akan memaksa
ukuran halaman menjadi 1000.
Nilai negatif menghasilkan error INVALID_ARGUMENT.
API mungkin menampilkan lebih sedikit hasil dari jumlah yang diminta (termasuk nol
hasil), meskipun tidak di akhir kumpulan. Gunakan keberadaan
nextPageToken untuk menentukan apakah ada hasil tambahan di kolom
pengumpulan data.
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 dari
pengumpulan data.
Meminta pesan untuk koleksi menentukan kolom pageToken string opsional
untuk maju ke halaman berikutnya dalam kumpulan laporan.
Perubahan pada pageSize dalam permintaan untuk halaman berikutnya diizinkan.
Semua argumen lainnya harus sama; jika ada argumen yang berbeda, API
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 menyediakan bilangan bulat totalSize yang mewakili
jumlah total entitas setelah pemfilteran diterapkan. Bidang ini hanya
diisi saat diminta dalam
mask kolom.
GET https://admanager.googleapis.com/v1/networks/123456/adUnits?$fields=adUnits,nextPageToken,totalSize
Hasil pesanan
Meminta pesan untuk koleksi menentukan kolom orderBy string yang akan ditentukan
tata urutan penyortiran.
Nilai harus berupa daftar kolom yang dipisahkan koma. Misalnya: foo,bar.
Tata urutan default adalah menaik. Untuk menentukan urutan menurun pada sebuah kolom,
menambahkan akhiran desc; misalnya: foo desc, bar.
Karakter spasi redundan 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 dasar.
Lewati hasil
Metode untuk operasi yang diberi nomor halaman menentukan kolom skip bilangan bulat yang akan dilewati
hasil pengujian tersebut. Nilai lewati mengacu pada jumlah resource individual yang harus dilewati,
bukan jumlah halaman.
Contoh:
Permintaan tanpa token halaman dan nilai lewati 30 menampilkan satu halaman hasil yang dimulai dengan hasil ke-31.
Permintaan dengan token halaman yang sesuai dengan hasil ke-51 (karena yang 50 hasil ditampilkan di halaman pertama) dan nilai lewati 30 menampilkan hasil penelusuran yang dimulai dari hasil ke-81.
Jika nilai lewati diberikan yang menyebabkan kursor bergerak melewati akhir
kumpulan hasil, responsnya adalah 200 OK dengan hasil kosong yang ditetapkan tanpa
nextPageToken.