Method: guaranteedOrders.list

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

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

คำขอ HTTP

GET https://displayvideo.googleapis.com/v3/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_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"

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

ดูข้อมูลเพิ่มเติมได้ที่คู่มือกรองคำขอ LIST

พารามิเตอร์ Union 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