Method: customers.userLists.list

列出由指定廣告資料中心客戶管理的使用者名單。

HTTP 要求

GET https://adsdatahub.googleapis.com/v1/{parent=customers/*}/userLists

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

路徑參數

參數
parent

string

必要，上層客戶資源名稱，例如 'customers/123'。

查詢參數

參數
pageSize

integer

要傳回的項目數量上限。如果值為 0，伺服器會決定要傳回的使用者清單數量。
pageToken

string

使用先前的呼叫傳回的網頁權杖，用於要求下一頁的搜尋結果。
filter

string

篩選器篩選器範例：title = "user*" AND title = "*name*" AND -type = FREQUENCY_BASED AND createEmail = "creator@email.com" AND listSize > 10 AND fillTime > "2012-04-21T&t;2012-04-21Tquot;2012-04-21Tquot;2012-04-21T&tt2012-04-21T&tt2012-04-21Tquot;2012-04-21T&tt2012-04-21T&tt2012-04-21T&tt2012-04-21T&tt20T2:10:2012"2012-01-21T&tt;2012-01-20&tt;2012-01-20&&tt;
view

enum (UserListView)

指定要在每個使用者名單中納入哪些欄位。
showDeleted

boolean

如果設為 True，系統會在回應中納入已刪除的使用者名單。

要求主體

要求主體必須為空白。

回應主體

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

回應 userLists.list 要求。包含由指定廣告資料中心客戶管理的使用者名單。

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

object (UserList)

使用者名單。
nextPageToken

string

可用來要求下一頁結果的權杖。如果沒有其他結果，這個欄位就會留空。

授權範圍

需要下列 OAuth 範圍：

  • https://www.googleapis.com/auth/adsdatahub

使用者清單檢視

用來表示 [userLists.list] API 傳回的每份使用者名單中的哪些欄位。

列舉
USER_LIST_VIEW_UNSPECIFIED 預設 / 未設定的值。API 將預設為 FULL 檢視畫面。
BASIC 包含 [recipientAdsDataLinks] 以外的欄位。
FULL 請提供所有項目。