Method: advertisers.locationLists.list

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

HTTP 要求

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

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

路徑參數

參數
advertiserId

string (int64 format)

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

查詢參數

參數
pageSize

integer

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

pageToken

string

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

通常這是先前呼叫 locationLists.list 方法後傳回的 nextPageToken 值。如未指定,系統會傳回第一頁的結果。

orderBy

string

清單排序依據的欄位。可接受的值為:

  • locationListId (預設)
  • displayName

預設的排序順序是遞增。如要為欄位指定遞減順序,請在欄位名稱中加入後置字串「desc」。範例:displayName desc

filter

string

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

支援的語法:

  • 篩選器運算式由一或多項限制組成。
  • 限制可以使用 ANDOR 邏輯運算子合併。一系列限制會間接使用 AND
  • 限制的形式為 {field} {operator} {value}
  • 運算子必須是 EQUALS (=)
  • 支援的欄位:
    • locationType

示例:

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

要求主體

要求主體必須為空白。

回應主體

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

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 總覽