Method: customers.userLists.list

指定した Ads Data Hub 顧客によって管理されているユーザーリストを一覧表示します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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 ANDpopulateTime > "2012-04-21T1
view

enum (UserListView)

各ユーザーリストに含めるフィールドを指定します。
showDeleted

boolean

true に設定すると、削除されたユーザーリストがレスポンスに含まれます。

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

userLists.list リクエストに対するレスポンス。指定した Ads Data Hub 顧客が管理するユーザーリストが含まれます。

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 あらゆるデータを含める。