Method: advertisers.insertionOrders.list

แสดงรายการใบสั่งซื้อการใส่โฆษณาในส่วนผู้ลงโฆษณา

ลําดับนั้นกําหนดโดยพารามิเตอร์ orderBy หากไม่ได้ระบุ filter โดย entityStatus ใบสั่งซื้อการใส่โฆษณาที่มี ENTITY_STATUS_ARCHIVED จะไม่รวมอยู่ในผลลัพธ์

คำขอ HTTP

GET https://displayvideo.googleapis.com/v1/advertisers/{advertiserId}/insertionOrders

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

พารามิเตอร์เส้นทาง

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

string (int64 format)

ต้องระบุ รหัสของผู้ลงโฆษณาที่จะแสดงใบสั่งซื้อการใส่โฆษณา

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

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

integer

ขนาดหน้าที่ขอ ต้องอยู่ระหว่าง 1 และ 100 หากไม่ระบุจะมีค่าเริ่มต้นเป็น 100 แสดงผลรหัสข้อผิดพลาด INVALID_ARGUMENT หากระบุค่าที่ไม่ถูกต้อง
pageToken

string

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

string

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

  • "displayName" (ค่าเริ่มต้น)
  • "entityStatus"
  • "updateTime" (เวลาอัปเดต)

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

string

อนุญาตให้กรองตามช่องใบสั่งซื้อการใส่โฆษณา

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

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

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

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

ตัวอย่าง

  • ใบสั่งซื้อการใส่โฆษณาทั้งหมดในแคมเปญ: campaignId="1234"
  • ใบสั่งซื้อการใส่โฆษณา ENTITY_STATUS_ACTIVE หรือ ENTITY_STATUS_PAUSED ทั้งหมดภายใต้ผู้ลงโฆษณา: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • ใบสั่งซื้อการใส่โฆษณาทั้งหมดที่มีเวลาอัปเดตน้อยกว่าหรือเท่ากับ 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 
{
  "insertionOrders": [
    {
      object (InsertionOrder)
    }
  ],
  "nextPageToken": string
}
ช่อง
insertionOrders[]

object (InsertionOrder)

รายการใบสั่งซื้อการใส่โฆษณา

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

string

โทเค็นเพื่อเรียกผลลัพธ์หน้าถัดไป ส่งต่อค่านี้ในฟิลด์ pageToken ในการเรียกครั้งต่อๆ ไปไปยังเมธอด insertionOrders.list เพื่อดึงผลลัพธ์หน้าถัดไป

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

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

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

สำหรับข้อมูลเพิ่มเติม โปรดดูที่ภาพรวมของ OAuth 2.0