Method: advertisers.list

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

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

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

คำขอ HTTP

GET https://displayvideo.googleapis.com/v5/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