Method: guaranteedOrders.list

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

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

คำขอ HTTP

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

ต้องระบุ

ระบุเอนทิตี DV360 ที่มีการส่งคำขอ คำขอ LIST จะแสดงเฉพาะเอนทิตีคำสั่งซื้อที่รับประกันการแสดงผลซึ่งเข้าถึงเอนทิตี DV360 ที่ระบุภายใน accessor ได้ ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
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 Overview