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

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

พื้นฐาน

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

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

โปรดดูเอกสารประกอบการอ้างอิงทรัพยากร เช่น AdBreaks, เพื่อดูค่า pageSize ที่เฉพาะเจาะจงของทรัพยากร

API อาจแสดงผลลัพธ์น้อยกว่าจำนวนที่ขอ (รวมถึงไม่มีผลลัพธ์) แม้ว่าจะไม่ได้อยู่ที่ส่วนท้ายของคอลเล็กชันก็ตาม ใช้การมีอยู่ของฟิลด์ 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 จะแสดงผลลัพธ์หน้าเดียวโดยเริ่มจากผลลัพธ์ที่ 31

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

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

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