Method: customLists.list

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

ลำดับจะกำหนดโดยพารามิเตอร์ orderBy

คำขอ HTTP

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

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

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

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

integer

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

string

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

string

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

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

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

string

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

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

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

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

  • displayName

ตัวอย่าง

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

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

ดูข้อมูลเพิ่มเติมได้ที่คู่มือคำขอLISTตัวกรอง
ต้องระบุ ระบุเอนทิตี DV360 ที่มีการส่งคำขอ คำขอ LIST จะแสดงผลเฉพาะเอนทิตีรายการที่กำหนดเองซึ่งเอนทิตี DV360 ที่ระบุภายใน accessor เข้าถึงได้ ต่อไปนี้คือรายการฟิลด์ที่ใช้ร่วมกันไม่ได้ ระบบจะตั้งค่าฟิลด์อย่างน้อย 1 รายการในการตอบกลับ
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 Overview