Method: partners.list

列出目前使用者可存取的合作夥伴。

順序是由 orderBy 參數定義。

HTTP 要求

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

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

查詢參數

參數
pageSize

integer

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

string

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

string

用來排序清單的欄位。可接受的值為：

  • displayName

預設排序順序為遞增。如要針對欄位指定遞減順序，則應於欄位名稱後方加上「desc」，例如 displayName desc。
filter

string

可按照合作夥伴欄位進行篩選。

支援的語法：

  • 篩選器運算式由一或多個限制組成。
  • 限制條件可以透過 AND 或 OR 邏輯運算子結合。一系列限制會隱含使用 AND。
  • 限制的格式為 {field} {operator} {value}。
  • 所有欄位都必須使用 EQUALS (=) 運算子。

支援的欄位：

  • entityStatus

範例：

  • 所有有效合作夥伴：entityStatus="ENTITY_STATUS_ACTIVE"

這個欄位的長度不得超過 500 個半形字元。

詳情請參閱篩選器 LIST 要求指南。

要求主體

要求主體必須為空白。

回應主體

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

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

object (Partner)

合作夥伴清單。

如果清單為空白，則不會顯示這項資訊。
nextPageToken

string

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

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱 OAuth 2.0 總覽。