Method: guaranteedOrders.list

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

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

HTTP 要求

GET https://displayvideo.googleapis.com/v2/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 總覽。