Method: guaranteedOrders.list

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

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

HTTP 要求

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

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

查詢參數

參數
pageSize

integer

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

string

這個符記可識別伺服器應傳回的結果頁面。通常，這是先前對 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 要求指南。

聯集參數 accessor。必填。

指出要求是在哪個 DV360 實體中提出。系統只會透過 LIST 要求傳回保證訂單實體，這些實體可供 accessor 中識別的 DV360 實體存取。accessor 只能是下列其中一項：
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。