Method: partners.list

แสดงรายชื่อพาร์ทเนอร์ที่ผู้ใช้ปัจจุบันเข้าถึงได้

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

คำขอ HTTP

GET https://displayvideo.googleapis.com/v3/partners

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

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

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

integer

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

string

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

string

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

  • displayName

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

string

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

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

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

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

  • entityStatus

ตัวอย่าง

  • พาร์ทเนอร์ที่มีการใช้งานทั้งหมด: entityStatus="ENTITY_STATUS_ACTIVE"

ฟิลด์นี้ควรมีความยาวไม่เกิน 500 อักขระ

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

เนื้อความของคำขอ

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

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

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

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

object (Partner)

รายชื่อพาร์ทเนอร์

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

string

โทเค็นเพื่อดึงข้อมูลผลลัพธ์หน้าถัดไป ส่งค่านี้ในช่อง pageToken ในการเรียกใช้เมธอด partners.list ครั้งถัดไปเพื่อดึงข้อมูลผลลัพธ์หน้าถัดไป

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

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

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

ดูข้อมูลเพิ่มเติมได้ที่OAuth 2.0 Overview