Method: customLists.list

รายการที่กำหนดเอง

ลําดับนั้นกําหนดโดยพารามิเตอร์ orderBy

คำขอ HTTP

GET https://displayvideo.googleapis.com/v1/customLists

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์การค้นหา

พารามิเตอร์
pageSize

integer

ขนาดหน้าที่ขอ ต้องอยู่ระหว่าง 1 และ 200 หากไม่ระบุจะมีค่าเริ่มต้นเป็น 100 แสดงผลรหัสข้อผิดพลาด INVALID_ARGUMENT หากระบุค่าที่ไม่ถูกต้อง
pageToken

string

โทเค็นที่ระบุหน้าผลลัพธ์ที่เซิร์ฟเวอร์ควรแสดงผล โดยทั่วไปแล้วจะเป็นค่าของ nextPageToken ที่ส่งคืนจากการเรียกเมธอด customLists.list ก่อนหน้านี้ หากไม่ได้ระบุ ระบบจะแสดงผลหน้าแรกของผลการค้นหา
orderBy

string

ช่องที่ใช้จัดเรียงรายการ ค่าที่ยอมรับได้ มีดังนี้

  • customListId (ค่าเริ่มต้น)
  • displayName

ลำดับการจัดเรียงเริ่มต้นคือจากน้อยไปมาก ในการระบุลำดับจากมากไปน้อยสำหรับช่อง ให้ใส่คำต่อท้าย "desc" ควรเพิ่มลงในชื่อช่อง ตัวอย่าง: displayName desc
filter

string

อนุญาตให้กรองตามช่องรายการที่กำหนดเอง

ไวยากรณ์ที่รองรับ:

  • นิพจน์ตัวกรองสำหรับรายการที่กำหนดเองสามารถมีข้อจำกัดได้ไม่เกิน 1 ข้อ
  • โดยข้อจำกัดจะอยู่ในรูปแบบ {field} {operator} {value}
  • ทุกช่องต้องใช้โอเปอเรเตอร์ HAS (:)

ฟิลด์ที่รองรับ:

  • displayName

ตัวอย่าง

  • รายการที่กำหนดเองทั้งหมดซึ่งชื่อที่แสดงมีคำว่า "Google": displayName:"Google"

ช่องนี้ควรมีความยาวไม่เกิน 500 อักขระ

โปรดดูข้อมูลเพิ่มเติมในคำแนะนำเกี่ยวกับคำขอตัวกรองLIST
advertiserId

string (int64 format)

รหัสของผู้ลงโฆษณา DV360 ที่มีสิทธิ์เข้าถึงรายการที่กำหนดเองที่ดึงข้อมูลมา

เนื้อหาของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "customLists": [
    {
      object (CustomList)
    }
  ],
  "nextPageToken": string
}
ช่อง
customLists[]

object (CustomList)

ลิสต์รายการที่กำหนดเอง

รายการนี้จะหายไปหากว่างเปล่า
nextPageToken

string

โทเค็นเพื่อเรียกผลลัพธ์หน้าถัดไป ส่งต่อค่านี้ในฟิลด์ pageToken ในการเรียกครั้งต่อๆ ไปไปยังเมธอด customLists.list เพื่อดึงผลลัพธ์หน้าถัดไป

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/display-video

สำหรับข้อมูลเพิ่มเติม โปรดดูที่ภาพรวมของ OAuth 2.0