Method: accountTypes.accounts.userLists.list

Отображает списки пользователей.

Заголовки авторизации:

Этот метод поддерживает следующие необязательные заголовки, определяющие способ авторизации доступа к запросу через API:

  • login-account : (Необязательно) Имя ресурса учетной записи, в которой находится учетная запись Google, для которой были предоставлены учетные данные. Если не указано, используется имя учетной записи из запроса. Формат: accountTypes/{loginAccountType}/accounts/{loginAccountId}
  • linked-account : (Необязательно) Имя ресурса учетной записи с установленной связью продукта с login-account . Формат: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}

HTTP-запрос

GET https://datamanager.googleapis.com/v1/{parent=accountTypes/*/accounts/*}/userLists

В URL-адресе используется синтаксис транскодирования gRPC .

Параметры пути

Параметры
parent

string

Обязательно. Родительская учетная запись, которой принадлежит этот набор списков пользователей. Формат: accountTypes/{accountType}/accounts/{account}

Параметры запроса

Параметры
pageSize

integer

Необязательный параметр. Максимальное количество списков пользователей для возврата. Сервис может вернуть меньше этого значения. Если параметр не указан, будет возвращено не более 50 списков пользователей. Максимальное значение — 1000; значения выше 1000 будут преобразованы в 1000.

pageToken

string

Необязательный параметр. Токен страницы, полученный из предыдущего вызова userLists.list . Укажите его, чтобы получить следующую страницу.

При использовании постраничной навигации все остальные параметры, передаваемые в userLists.list , должны соответствовать вызову, который предоставил токен страницы.

filter

string

Необязательно. Строка фильтра . Все поля должны располагаться слева от каждого условия (например: display_name = "list 1" ). Поля должны быть указаны либо в формате camel case , либо в формате snake case . Не используйте комбинацию camel case и snake case.

Поддерживаемые операции:

  • AND
  • =
  • !=
  • >
  • >=
  • <
  • <=
  • : (имеет)

Поддерживаемые функции: - IN(field, value1, value2, ...) : возвращает true, если поле соответствует хотя бы одному из значений. Пример: IN(display_name, "name1", "name2")

Поддерживаемые поля:

  • id
  • display_name
  • description
  • membership_status
  • integration_code
  • access_reason
  • ingested_user_list_info.upload_key_types

Текст запроса

Тело запроса должно быть пустым.

Ответный текст

Ответное сообщение для userLists.list.

В случае успеха тело ответа будет содержать данные следующей структуры:

JSON-представление 
{
  "userLists": [
    {
      object (UserList)
    }
  ],
  "nextPageToken": string
}
Поля
userLists[]

object ( UserList )

Пользователь размещает список с указанного аккаунта.

nextPageToken

string

Токен, который можно отправить в качестве pageToken для получения следующей страницы. Если это поле опущено, последующих страниц не будет.

Области полномочий

Требуется следующая область действия OAuth:

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