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