Penomoran halaman
LSA mendukung penomoran halaman untuk mengakomodasi permintaan snapshot besar dalam pengambilan (tarikan) beberapa halaman. Google akan menarik endpoint partner tertentu dengan parameter
maxresults
untuk membatasi jumlah maksimum penyedia layanan yang ditampilkan dalam
respons JSON. Partner akan mengisi token penomoran halaman ke dalam
kolom metadata.pagination.nextTokenParam
dalam respons JSON. Nilai token ini khusus partner dan digunakan untuk membuat URL halaman berikutnya. Kolom
nextTokenParam
tidak boleh diisi untuk halaman terakhir. Perhatikan bahwa objek metadata.pagination
harus selalu diisi (karena diperlukan dalam skema), meskipun halaman terakhir tidak akan memiliki kolom nextTokenParam
.
Selain itu, totalCount
menunjukkan jumlah total penyedia layanan (atau
reviewItems
dalam kasus feed ulasan) di semua halaman.
Misalnya, jika partner memiliki 200 penyedia dalam snapshot lengkap. Saat Google memulai transfer feed dengan URL http://www.partners.com/feeds/{version}/profile&maxresults=100
, halaman pertama harus menampilkan 100 penyedia partner pertama dengan metaData
berikut:
"metaData": {
"feedCategory":"SNAPSHOT",
"feedTimestampMicros":1532930955190163,
"apiVersion": "v1",
"pagination": {
"nextTokenParam": "yre7yiesar"
},
"totalCount":200
}
"serviceProviders": {....} // Contains 100 service provider objects.
Google akan mengurai nextTokenParam: "yre7yiesar"
dan akan memulai transfer kedua dengan URL:
http:partners.com/feeds/{version}/profile&nextpagetoken=yre7yiesar&maxresults=100
Halaman kedua akan menampilkan 100 penyedia terakhir. Mengingat halaman kedua juga merupakan halaman terakhir, nextTokenParam
tidak akan diisi (metaData
contoh di bawah), yang menunjukkan akhir penomoran halaman.
"metaData": {
"feedCategory":"SNAPSHOT",
"feedTimestampMicros":1532930955190164,
"apiVersion": "v1",
"pagination": {},
"totalCount":200
}
"serviceProviders": {....}
Perhatikan bahwa setelah mengambil semua halaman, jumlah total objek serviceProviders
(di semua halaman) harus sama dengan totalCount
yang ditunjukkan pada
pengambilan halaman pertama.