Method: customers.userLists.list

Список списков пользователей, которыми управляет указанный клиент Ads Data Hub.

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования 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 populateTime > "2012-04-21T11:30:00- 04:00"

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

UserListView

Перечислите, чтобы указать, какие поля включать в каждый список пользователей, возвращаемый API [userLists.list].

перечисления
USER_LIST_VIEW_UNSPECIFIED Значение по умолчанию/неустановленное. API по умолчанию будет использовать ПОЛНЫЙ вид.
BASIC Включите поля, кроме [recipientAdsDataLinks].
FULL Включите все.