Method: advertisers.list

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

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

ต้องระบุ partnerId เพียงรายการเดียว ระบบไม่รองรับการแสดงข้อมูลข้ามพาร์ทเนอร์

คำขอ HTTP

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

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

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

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

string (int64 format)

ต้องระบุ รหัสของพาร์ทเนอร์ที่ผู้ลงโฆษณาที่ดึงข้อมูลมาควรเป็นของพาร์ทเนอร์รายนั้น ระบบรองรับการแสดงผู้ลงโฆษณาสำหรับพาร์ทเนอร์ 1 รายในแต่ละครั้งเท่านั้น
pageSize

integer

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

string

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

string

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

  • advertiserId (ค่าเริ่มต้น)
  • displayName
  • entityStatus
  • updateTime

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

string

อนุญาตให้กรองตามช่องผู้ลงโฆษณา

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

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

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

  • advertiserId
  • displayName
  • entityStatus
  • updateTime (ป้อนในรูปแบบ ISO 8601 หรือ YYYY-MM-DDTHH:MM:SSZ)

ตัวอย่าง

  • ผู้ลงโฆษณาที่ใช้งานอยู่ทั้งหมดภายใต้พาร์ทเนอร์: entityStatus="ENTITY_STATUS_ACTIVE"
  • ผู้ลงโฆษณาทุกรายที่มีเวลาอัปเดตน้อยกว่าหรือเท่ากับ 2020-11-04T18:54:47Z (รูปแบบของ ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • ผู้ลงโฆษณาทุกรายที่มีเวลาอัปเดตมากกว่าหรือเท่ากับ 2020-11-04T18:54:47Z (รูปแบบของ ISO 8601): updateTime>="2020-11-04T18:54:47Z"

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

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

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

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

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

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

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

object (Advertiser)

รายชื่อผู้ลงโฆษณา

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

string

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

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

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

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

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