Method: guaranteedOrders.list

แสดงรายการคำสั่งซื้อที่รับประกันการแสดงผลที่ผู้ใช้ปัจจุบันเข้าถึงได้

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

คำขอ HTTP

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

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

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

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

integer

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

string

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

string

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

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

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

string

อนุญาตให้กรองตามฟิลด์คำสั่งซื้อที่รับประกันการแสดงผล

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

ฟิลด์ที่รองรับ: * guaranteedOrderId * exchange * displayName * status.entityStatus

ตัวอย่าง

  • คำสั่งซื้อที่รับประกันการแสดงผลที่ใช้งานอยู่ทั้งหมด: status.entityStatus="ENTITY_STATUS_ACTIVE"
  • คำสั่งซื้อที่มีการรับประกันซึ่งเป็นของ Google Ad Manager หรือ Rubicon Exchange: exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"

ช่องนี้ควรมีความยาวไม่เกิน 500 อักขระ

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

พารามิเตอร์การรวม accessor ต้องระบุ

ระบุว่าเอนทิตี DV360 ใดที่ส่งคำขอ คำขอ LIST จะแสดงผลเฉพาะเอนทิตีคำสั่งซื้อที่รับประกันการแสดงผลซึ่งเข้าถึงได้โดยเอนทิตี DV360 ที่ระบุภายใน accessor accessor ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
partnerId

string (int64 format)

รหัสของพาร์ทเนอร์ที่มีสิทธิ์เข้าถึงคำสั่งซื้อที่รับประกันการแสดงผล
advertiserId

string (int64 format)

รหัสของผู้ลงโฆษณาที่มีสิทธิ์เข้าถึงคำสั่งซื้อที่รับประกันการแสดงผล

เนื้อหาของคำขอ

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

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

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

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

object (GuaranteedOrder)

รายการคำสั่งซื้อที่รับประกันการแสดงผล

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

string

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

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

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

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

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