Method: advertisers.locationLists.list

根據指定的廣告主 ID 列出位置清單。

HTTP 要求

GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/locationLists

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

路徑參數

參數
advertiserId

string (int64 format)

必要欄位。擷取的位置清單所屬的 DV360 廣告主 ID。

查詢參數

參數
pageSize

integer

要求的頁面大小。必須介於 1 至 200 之間。如果未設定，預設值為 100。如果指定無效值，則會傳回錯誤代碼 INVALID_ARGUMENT。
pageToken

string

用於識別伺服器應傳回之結果頁面的符記。

一般而言，這是從先前呼叫 locationLists.list 方法傳回的 nextPageToken 值。如未指定，系統會傳回第一頁的結果。
orderBy

string

清單排序依據的欄位。可接受的值如下：

  • locationListId (預設)
  • displayName

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

string

可依地點清單欄位進行篩選。

支援的語法：

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

支援的欄位：

  • locationType

範例：

  • 所有區域地點清單：locationType="TARGETING_LOCATION_TYPE_REGIONAL"
  • 所有鄰近位置清單：locationType="TARGETING_LOCATION_TYPE_PROXIMITY"

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

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

要求主體

要求主體必須為空白。

回應主體

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

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

object (LocationList)

位置清單清單。

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

string

用來擷取下一頁結果的符記。

在後續對 locationLists.list 方法的呼叫中，將這個值傳遞至 pageToken 欄位，即可擷取下一頁的結果。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱 OAuth 2.0 總覽。