Method: sellers.orders.list

列出訂單。

  • 例如 GET /v1/sellers/321/orders
  • 傳回訂單清單和權杖，如果成功的話，可擷取下一頁。
  • 如果使用者沒有賣方或賣方 ID 的存取權，則傳回錯誤代碼 PERMISSION_DENIED。
  • 如果賣家提供的頁面大小或網頁符記無效，則會傳回錯誤代碼 INVALID_ARGUMENT。

HTTP 要求

GET https://dv360outofhomeseller.googleapis.com/v1/{parent=sellers/*}/orders

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

路徑參數

參數
parent

string

必要欄位。擁有這個訂單集合的父項。格式：Seller/{seller}

查詢參數

參數
pageSize

integer

傳回的項目數量上限。服務傳回的產品數量可能會少於這個值。允許的訂單數上限為 1000。如未指定，最多將傳回 1000 筆訂單。
pageToken

string

先前的 List 要求 (如果有的話) 傳回的 nextPageToken 值。
filter

string

清單篩選器。目前支援外部 ID 和狀態篩選，語法如下：「externalId = [EXTERNAL_ID]」和「state = [STATE]」邏輯運算子 AND 和 OR 可用來鏈結篩選器。
orderBy

string

依據字串指定的結果排序順序。目前支援依 updateTime 排序，請提供「updateTime」取得依 updateTime 遞增排序的結果，或按「updateTime desc」排序以遞減順序排列

要求主體

要求主體必須為空白。

回應主體

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

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

object (Order)

訂單清單。
nextPageToken

string

用於擷取下一頁結果的符記。在對 orders.list 方法的後續呼叫時，將這個值傳入 pageToken 欄位，即可擷取下一頁的結果。

授權範圍

需要下列 OAuth 範圍：

  • https://www.googleapis.com/auth/doubleclickbidmanager

詳情請參閱 OAuth 2.0 總覽。