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