การใส่เลขหน้า

Ad Manager API มีชุดข้อมูล ซึ่งโดยทั่วไปจะอยู่ในListวิธี คอลเล็กชันอาจมีขนาดเท่าใดก็ได้และจะแบ่งเป็นหน้าในคำตอบของ API

พื้นฐาน

ข้อความคําขอสําหรับคอลเล็กชันจะกําหนดช่องจำนวนเต็ม pageSize (ไม่บังคับ) เพื่อระบุจํานวนผลลัพธ์สูงสุดที่จะแสดง

ตั้งค่าพารามิเตอร์ pageSize เป็นจํานวนบวกที่น้อยกว่า 1000 หากคุณไม่ได้ตั้งค่าใดๆ หรือตั้งค่าพารามิเตอร์เป็น 0 API จะใช้ค่าเริ่มต้นเป็น 50 หากคุณตั้งค่าพารามิเตอร์เป็นค่าลบ API จะแสดงข้อผิดพลาด INVALID_ARGUMENT

ดูค่า pageSize สำหรับทรัพยากรที่เฉพาะเจาะจงได้จากเอกสารอ้างอิงเกี่ยวกับทรัพยากร เช่น AdBreaks

API อาจแสดงผลลัพธ์น้อยกว่าจำนวนที่ขอ (รวมถึงผลลัพธ์เป็น 0) แม้ว่าจะยังไม่ถึงจุดสิ้นสุดของคอลเล็กชันก็ตาม ใช้การมีอยู่ของช่อง nextPageToken เพื่อระบุว่ามีผลการค้นหาเพิ่มเติมในคอลเล็กชันหรือไม่

ข้อความตอบกลับสำหรับคอลเล็กชันจะกำหนดช่องสตริง nextPageToken ซึ่งใช้ดึงข้อมูลหน้าถัดไปได้ ช่อง nextPageToken จะว่างเปล่าเมื่อถึงส่วนท้ายของคอลเล็กชัน วิธีนี้เป็นวิธีเดียวที่จะระบุว่าคุณดูถึงส่วนท้ายของคอลเล็กชันแล้วหรือยัง

ข้อความขอคอลเล็กชันจะกำหนดช่องสตริง pageToken (ไม่บังคับ) เพื่อเลื่อนไปยังหน้าถัดไปในคอลเล็กชัน อนุญาตให้เปลี่ยนแปลง pageSize ในคำขอสำหรับหน้าเว็บต่อๆ ไป อาร์กิวเมนต์อื่นๆ ทั้งหมดต้องเหมือนกัน หากอาร์กิวเมนต์ใดไม่เหมือนกัน API จะแสดงข้อผิดพลาด INVALID_ARGUMENT

ตัวอย่าง

cURL

คำขอเริ่มต้น

curl https://admanager.googleapis.com/v1/networks/123456/adUnits?pageSize=500

{
  "adUnits": [ ... ],
  "nextPageToken": "eCGwAcs6hUerggzd2DGv"
}

คำขอหน้าถัดไป

curl https://admanager.googleapis.com/v1/networks/123456/adUnits?pageSize=500&pageToken=eCGwAcs6hUerggzd2DGv

{
  "adUnits": [ ... ]
}

ขนาดทั้งหมด

ข้อความตอบกลับสำหรับคอลเล็กชันจะให้จำนวนเต็ม totalSize ที่แสดงจํานวนเอนทิตีทั้งหมดหลังจากใช้การกรอง ระบบจะป้อนข้อมูลในช่องนี้เฉพาะเมื่อมีการขอในมาสก์ช่อง

GET https://admanager.googleapis.com/v1/networks/123456/adUnits?$fields=adUnits,nextPageToken,totalSize

สั่งซื้อผลการค้นหา

ข้อความคำขอสำหรับคอลเล็กชันจะกำหนดฟิลด์สตริง orderBy เพื่อระบุลําดับการจัดเรียง

ค่าควรเป็นรายการช่องที่คั่นด้วยคอมมา ตัวอย่างเช่น foo,bar ลำดับการจัดเรียงเริ่มต้นคือจากน้อยไปมาก หากต้องการระบุลําดับจากน้อยไปมากสําหรับช่อง ให้ใส่ส่วนต่อท้าย desc เช่น foo desc, bar ระบบจะไม่สนใจอักขระเว้นวรรคที่ซ้ำกันในส่วนไวยากรณ์ ค่า orderBy foo, bar desc, foo , bar desc และ foo,bar desc ทั้งหมดเทียบเท่ากัน ระบุช่องย่อยด้วยอักขระ . เช่น foo.bar หรือ address.street

ระบบรองรับการจัดเรียงเฉพาะในฟิลด์พื้นฐานเท่านั้น

ข้ามผลการค้นหา

วิธีการสําหรับการดำเนินการแบบแบ่งหน้าจะกําหนดฟิลด์ skip แบบจำนวนเต็มเพื่อข้ามผลลัพธ์ ค่าการข้ามหมายถึงจํานวนทรัพยากรแต่ละรายการที่จะข้าม ไม่ใช่จํานวนหน้า

เช่น

คำขอที่ไม่มีโทเค็นหน้าเว็บและค่าการข้าม 30 จะแสดงผลลัพธ์ 1 หน้าโดยเริ่มจากผลลัพธ์ที่ 31

คําขอที่มีโทเค็นหน้าเว็บซึ่งสอดคล้องกับผลการค้นหาที่ 51 (เนื่องจากผลการค้นหา 50 รายการแรกแสดงในหน้าแรก) และค่าการข้าม 30 จะแสดงผลการค้นหาหน้าเดียวที่เริ่มต้นด้วยผลการค้นหาที่ 81

หากระบุค่าการข้ามที่ทำให้เคอร์เซอร์เลื่อนผ่านจุดสิ้นสุดของชุดผลลัพธ์ การตอบกลับจะเป็น 200 OK ที่มีชุดผลลัพธ์ว่างโดยไม่มี nextPageToken

สำคัญ: คุณไม่ควรใช้ฟิลด์ skip แทนการแบ่งหน้า โทเค็นการแบ่งหน้าช่วยให้มั่นใจว่าการตอบกลับมาจากชุดผลลัพธ์เริ่มต้นเดียวกัน