Method: spaces.messagePins.list

Liệt kê các tin nhắn được ghim trong một không gian. Người dùng có thể ghim các tin nhắn quan trọng trong không gian để dễ dàng truy cập. Để biết thêm thông tin, hãy xem bài viết Ghim hoặc bỏ ghim cuộc trò chuyện trong Google Chat.

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.spaces.pins.readonly
  • https://www.googleapis.com/auth/chat.spaces.pins
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces

Yêu cầu HTTP

GET https://chat.googleapis.com/v1/{parent=spaces/*}/messagePins

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

Tham số đường dẫn

Tham số
parent

string

Bắt buộc. Không gian mẹ sở hữu bộ sưu tập các mục được ghim Định dạng: spaces/{space}

Tham số truy vấn

Thông số
pageSize

integer

Không bắt buộc. Số lượng ghim tin nhắn tối đa được trả về. Dịch vụ có thể trả về ít thông báo hơn giá trị này. Giá trị tối đa là 100. Nếu bạn sử dụng giá trị lớn hơn 100, giá trị đó sẽ tự động thay đổi thành 100. Nếu không chỉ định, tối đa 100 ghim tin nhắn sẽ được trả về. Giá trị âm sẽ trả về lỗi INVALID_ARGUMENT.
pageToken

string

Không bắt buộc. Mã thông báo trang nhận được từ một lệnh gọi ghim tin nhắn danh sách trước đó. Cung cấp thông số này để truy xuất trang tiếp theo.

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

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

Thông báo phản hồi cho các ghim tin nhắn trong trang thông tin.

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 
{
  "messagePins": [
    {
      object (MessagePin)
    }
  ],
  "nextPageToken": string
}
Trường
messagePins[]

object (MessagePin)

Tin nhắn được ghim trong không gian đã chỉ định.
nextPageToken

string

Bạn có thể gửi mã thông báo dưới dạng pageToken để truy xuất trang kết quả tiếp theo. Nếu trống, tức là không có trang nào 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.spaces.pins
  • https://www.googleapis.com/auth/chat.spaces.pins.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly

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