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

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

พื้นฐาน

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

หากไม่ได้ตั้งค่า pageSize หรือ 0 ระบบจะใช้ค่าเริ่มต้น 50 หาก pageSize มีขนาดเกินขนาดสูงสุดที่ 1, 000 หน้า API จะบังคับให้ เป็นขนาด 1000 ค่าลบจะทำให้เกิดข้อผิดพลาด INVALID_ARGUMENT

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 จะแสดงผลหน้าเว็บเดียวของ ผลลัพธ์ตั้งแต่วันที่ 31 เป็นต้นไป

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

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

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