Method: customLists.list

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

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

คำขอ HTTP

GET https://displayvideo.googleapis.com/v2/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 คำขอ
พารามิเตอร์การรวม accessor ต้องระบุ ระบุว่ามีการส่งคำขอมาจากเอนทิตี DV360 ใด คำขอ "รายการ" จะแสดงเฉพาะเอนทิตีในรายการที่กำหนดเองซึ่งเข้าถึงได้สำหรับเอนทิตี DV360 ที่ระบุภายใน accessor เท่านั้น accessor ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
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