Method: advertisers.reachForecast.retrievePlannableUserLists

擷取可用於預測的第一方和第三方使用者名單。

HTTP 要求

GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/reachForecast:retrievePlannableUserLists

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

路徑參數

參數
advertiserId

string (int64 format)

必填。廣告主的 ID，用於擷取可規劃的使用者名單。

查詢參數

參數
pageSize

integer

(選用步驟) 要求的頁面大小。必須介於 1 至 5000 之間。如未指定，則預設為 5000。
pageToken

string

(選用步驟) 這個符記可識別伺服器應傳回的結果頁面。通常這是先前呼叫 reachForecast.retrievePlannableUserLists 方法時傳回的 nextPageToken 值。如未指定，系統會傳回第一頁的結果。
filter

string

(選用步驟) 可依可規劃使用者名單屬性篩選。

支援的語法：

  • 篩選運算式由一或多項限制組成。
  • 限制條件可透過 AND 或 OR 邏輯運算子合併。
  • 限制的格式為 {field} {operator} {value}。
  • displayName 欄位必須使用 HAS (:) 運算子。
  • 其他所有欄位都必須使用 EQUALS (=) 運算子。

支援的欄位：

  • plannableStatus
  • displayName
  • userListType
  • name

範例：

  • 所有可規劃的使用者名單：plannableStatus="PLANNABLE"
  • 可規劃的使用者名單，顯示名稱包含「購物」：plannableStatus="PLANNABLE" AND displayName:"Shopping"
  • 第一方使用者名單：userListType="FIRST_PARTY"

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

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

要求主體

要求主體必須為空白。

回應主體

對 reachForecast.retrievePlannableUserLists 的回應。

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

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

object (PlannableUserList)

僅供輸出。可規劃的使用者名單清單。
nextPageToken

string

僅供輸出。用來擷取下一頁結果的符記。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱OAuth 2.0 Overview。

PlannableUserList

可規劃的使用者名單，用於預測觸及率。

JSON 表示法 
{
  "displayName": string,
  "userListType": enum (UserListType),
  "name": string,
  "plannableStatus": enum (PlannableStatus)
}
欄位
displayName

string

僅供輸出。使用者清單的顯示名稱。
userListType

enum (UserListType)

僅供輸出。使用者名單類型。
name

string

僅供輸出。用於識別使用者名單的資源名稱。

格式：advertisers/{advertiserId}/userLists/{user_list_id}
plannableStatus

enum (PlannableStatus)

僅供輸出。使用者名單的可規劃狀態。

UserListType

使用者名單類型。

列舉
USER_LIST_TYPE_UNSPECIFIED 未指定使用者名單類型。
FIRST_PARTY 第一方使用者名單。
THIRD_PARTY 第三方使用者名單。

PlannableStatus

指出清單是否可規劃的狀態。

列舉
PLANNABLE_STATUS_UNSPECIFIED 未指定可規劃狀態。
PLANNABLE 使用者名單可規劃。
UNPLANNABLE 使用者名單無法規劃。