Method: customEmojis.list

Liệt kê các biểu tượng cảm xúc tuỳ chỉnh mà người dùng đã xác thực có thể thấy.

Chỉ tài khoản Google Workspace mới sử dụng được biểu tượng cảm xúc tuỳ chỉnh và quản trị viên phải bật biểu tượng cảm xúc tuỳ chỉnh cho tổ chức. Để biết thêm thông tin, hãy xem bài viết Tìm hiểu về biểu tượng cảm xúc tuỳ chỉnh trong Google Chat và Quản lý quyền sử dụng biểu tượng cảm xúc tuỳ chỉnh.

Yêu cầu xác thực người dùng bằng một trong các phạm vi uỷ quyền sau:

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

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số truy vấn

Thông số
pageSize

integer

Không bắt buộc. Số lượng biểu tượng cảm xúc tuỳ chỉnh tối đa được trả về. Dịch vụ có thể trả về ít biểu tượng cảm xúc tuỳ chỉnh hơn giá trị này. Nếu không được chỉ định, giá trị mặc định sẽ là 25. Giá trị tối đa là 200; các giá trị trên 200 sẽ được thay đổi thành 200.
pageToken

string

Không bắt buộc. (Nếu tiếp tục từ một truy vấn trước đó.)

Mã thông báo trang nhận được từ lệnh gọi biểu tượng cảm xúc tuỳ chỉnh trong danh sách trước đó. Cung cấp giá trị này để truy xuất trang tiếp theo.

Khi phân trang, giá trị bộ lọc phải khớp với lệnh gọi đã cung cấp mã thông báo trang. Việc truyền một giá trị khác có thể dẫn đến kết quả không mong muốn.
filter

string

Không bắt buộc. Bộ lọc truy vấn.

Hỗ trợ lọc theo nhà sáng tạo.

Để lọc theo nhà sáng tạo, bạn phải chỉ định một giá trị hợp lệ. Hiện tại, chỉ creator("users/me") và NOT creator("users/me") được chấp nhận để lọc biểu tượng cảm xúc tuỳ chỉnh theo việc biểu tượng cảm xúc đó có phải do người dùng gọi tạo ra hay không.

Ví dụ: truy vấn sau đây trả về biểu tượng cảm xúc tuỳ chỉnh do phương thức gọi tạo:

creator("users/me")

Các truy vấn không hợp lệ sẽ bị từ chối kèm theo lỗi INVALID_ARGUMENT.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Nội dung phản hồi để liệt kê biểu tượng cảm xúc tuỳ chỉnh.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "customEmojis": [
    {
      object (CustomEmoji)
    }
  ],
  "nextPageToken": string
}
Trường
customEmojis[]

object (CustomEmoji)

Danh sách không theo thứ tự. Danh sách biểu tượng cảm xúc tuỳ chỉnh.
nextPageToken

string

Một mã thông báo mà bạn có thể gửi dưới dạng pageToken để truy xuất trang kết quả tiếp theo. Nếu trống, sẽ không có trang tiếp theo.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.