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

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

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

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

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

  • displayName

ตัวอย่าง

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

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

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