Method: guaranteedOrders.list

列出目前使用者可存取的保證訂單。

順序是由 orderBy 參數定義。如未指定 filter entityStatus，結果中就不會顯示實體狀態為 ENTITY_STATUS_ARCHIVED 的保證訂單。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

查詢參數

參數
pageSize

integer

要求的頁面大小。必須介於 1 至 200 之間。如未指定，則會預設為 100。
pageToken

string

伺服器應傳回的結果頁面 ID 符記。通常這是先前呼叫 guaranteedOrders.list 方法時傳回的 nextPageToken 值。如未指定，系統會傳回第一頁的結果。
orderBy

string

用於排序清單的欄位。可接受的值如下：

  • displayName (預設)

預設排序順序為遞增。如要指定欄位的遞減順序，請在欄位名稱中加入「desc」後置字串。例如 displayName desc。
filter

string

允許依保證訂單欄位篩選。

  • 篩選運算式由一或多項限制組成。
  • 你可以使用 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 要求指南。

必填。

指出要求是在哪個 DV360 實體中提出。LIST 要求只會傳回 accessor 中識別的 DV360 實體可存取的保證訂單實體。以下列出互斥欄位。回應中最多會設定一個欄位：
partnerId

string (int64 format)

有權存取保證訂單的合作夥伴 ID。
advertiserId

string (int64 format)

有權存取保證訂單的廣告主 ID。
互斥欄位的結尾。

要求主體

要求主體必須為空白。

回應主體

如果成功，回應主體即會包含具有以下結構的資料：

JSON 表示法 
{
  "guaranteedOrders": [
    {
      object (GuaranteedOrder)
    }
  ],
  "nextPageToken": string
}
欄位
guaranteedOrders[]

object (GuaranteedOrder)

保證訂單清單。

如果清單為空，則不會顯示。
nextPageToken

string

用於擷取下一頁結果的權杖。在後續呼叫 guaranteedOrders.list 方法時，將這個值傳遞至 pageToken 欄位，即可擷取下一頁的結果。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱OAuth 2.0 Overview。