Method: customEmojis.list

Перечисляет пользовательские смайлы, видимые авторизованному пользователю.

Требует аутентификации пользователя .

HTTP-запрос

GET https://chat.googleapis.com/v1/customEmojis

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

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

Параметры
pageSize

integer

Необязательный. Возвращено максимальное количество пользовательских смайлов. Служба может возвращать меньше пользовательских смайлов, чем это значение. Если не указано, значение по умолчанию — 25. Максимальное значение — 200; значения выше 200 изменяются на 200.

pageToken

string

Необязательный. (При возобновлении предыдущего запроса.)

Токен страницы, полученный в результате вызова специального эмодзи из предыдущего списка. Предоставьте это, чтобы получить следующую страницу.

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

filter

string

Необязательный. Фильтр запроса.

Поддерживает фильтрацию по создателю.

Чтобы фильтровать по создателю, необходимо указать допустимое значение. В настоящее время только creator("users/me") и NOT creator("users/me") могут фильтровать пользовательские смайлы по тому, были ли они созданы вызывающим пользователем или нет.

Например, следующий запрос возвращает пользовательские смайлы, созданные вызывающим абонентом:

creator("users/me")

Недействительные запросы отклоняются сервером с ошибкой INVALID_ARGUMENT .

Тело запроса

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

Тело ответа

Ответ на список пользовательских смайлов.

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

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

object ( CustomEmoji )

Неупорядоченный список. Список пользовательских смайлов на запрошенной (или первой) странице.

nextPageToken

string

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

Области авторизации

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

  • https://www.googleapis.com/auth/chat.customemojis

Дополнительную информацию см. в руководстве по авторизации .