Method: advertisers.list

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

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

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

คำขอ HTTP

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

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

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

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

string (int64 format)

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

pageSize

integer

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

pageToken

string

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

orderBy

string

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

  • 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