Method: googleAudiences.list

列出 Google 目標對象。

順序由 orderBy 參數定義。

HTTP 要求

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

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

查詢參數

參數
pageSize

integer

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

pageToken

string

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

orderBy

string

用來排序清單的欄位。可接受的值如下:

  • googleAudienceId (預設)
  • displayName

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

filter

string

可依 Google 目標對象欄位進行篩選。

支援的語法:

  • Google 目標對象的篩選器運算式最多只能包含一個限制。
  • 限制的形式為 {field} {operator} {value}
  • 所有欄位都必須使用 HAS (:) 運算子。

支援的欄位:

  • displayName

範例:

  • 顯示名稱含有「Google」的所有 Google 目標對象:displayName:"Google"

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

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

聯集參數 accessor。必要欄位。指出發出請求的是哪個 DV360 實體。列表要求只會傳回 Google 目標對象實體,這些實體可供 accessor 中識別的 DV360 實體存取。accessor 只能是下列其中一項:
partnerId

string (int64 format)

可存取擷取的 Google 目標對象的合作夥伴 ID。

advertiserId

string (int64 format)

可存取擷取的 Google 目標對象的廣告主 ID。

要求主體

要求主體必須為空白。

回應主體

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

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

object (GoogleAudience)

Google 目標對象清單。

如果留空,這份清單就不會顯示。

nextPageToken

string

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

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱 OAuth 2.0 總覽