Package google.chat.v1

ButtonList

Danh sách các nút.

ResponseType

Chỉ nhập. Loại phản hồi của ứng dụng Chat.

string

Chỉ nhập. URL để người dùng xác thực hoặc định cấu hình. (Chỉ dành cho các loại phản hồi REQUEST_CONFIG.)

DialogAction

Chỉ nhập. Phản hồi cho một sự kiện tương tác liên quan đến hộp thoại. Phải đi kèm với ResponseType.Dialog.

UpdatedWidget

Chỉ nhập. Phản hồi của tiện ích đã cập nhật.

SelectionItem

Một mảng gồm các đối tượng SelectionItem.

string

Mã của tiện ích đã cập nhật. Mã này phải khớp với mã của tiện ích đã kích hoạt yêu cầu cập nhật.

SelectionItems

Danh sách kết quả tự động hoàn thành tiện ích

Code

Mã trạng thái.

string

Thông báo gửi cho người dùng về trạng thái yêu cầu của họ. Nếu không đặt, hệ thống sẽ gửi một thông báo chung dựa trên status_code.

AnnotationType

Loại chú thích này.

int32

Độ dài của chuỗi con trong nội dung thư văn bản thuần tuý mà chú thích này tương ứng.

int32

Chỉ mục bắt đầu (dựa trên 0, bao gồm cả 0) trong nội dung thông báo văn bản thuần tuý tương ứng với chú thích này.

UserMentionMetadata

Siêu dữ liệu về lượt đề cập người dùng.

SlashCommandMetadata

Siêu dữ liệu cho lệnh dấu gạch chéo.

RichLinkMetadata

Siêu dữ liệu của đường liên kết đa dạng thức.

string

Chỉ có đầu ra. URL lưu trữ hình ảnh GIF.

string

Không bắt buộc. Tên tài nguyên của tệp đính kèm, ở dạng spaces/{space}/messages/{message}/attachments/{attachment}.

string

Chỉ có đầu ra. Tên tệp gốc của nội dung, chứ không phải đường dẫn đầy đủ.

string

Chỉ có đầu ra. Loại nội dung (loại MIME) của tệp.

string

Chỉ có đầu ra. URL hình thu nhỏ sẽ được dùng để xem trước tệp đính kèm cho người dùng. Ứng dụng nhắn tin không được sử dụng URL này để tải nội dung đính kèm xuống.

string

Chỉ có đầu ra. URL tải xuống cần được dùng để cho phép người dùng tải tệp đính kèm xuống. Ứng dụng nhắn tin không được sử dụng URL này để tải nội dung đính kèm xuống.

Source

Chỉ có đầu ra. Nguồn của tệp đính kèm.

AttachmentDataRef

Không bắt buộc. Tham chiếu đến dữ liệu tệp đính kèm. Trường này dùng để tạo hoặc cập nhật tin nhắn có tệp đính kèm hoặc dùng API nội dung nghe nhìn để tải dữ liệu tệp đính kèm xuống.

DriveDataRef

Chỉ có đầu ra. Tham chiếu đến tệp đính kèm trên Google Drive. Trường này được dùng với API Google Drive.

string

Không bắt buộc. Tên tài nguyên của dữ liệu tệp đính kèm. Trường này được dùng với API nội dung nghe nhìn để tải dữ liệu tệp đính kèm xuống.

string

Không bắt buộc. Mã thông báo mờ chứa tham chiếu đến tệp đính kèm đã tải lên. Được ứng dụng coi là một chuỗi mờ và dùng để tạo hoặc cập nhật tin nhắn Chat có tệp đính kèm.

string

Bắt buộc nếu thông báo có nhiều thẻ. Giá trị nhận dạng duy nhất của thẻ trong thông báo.

Card

Thẻ. Kích thước tối đa là 32 KB.

string

Không gian của tài nguyên phòng Chat được liên kết.

Định dạng spaces/{space}

string

Luồng của tài nguyên phòng Chat được liên kết.

Định dạng spaces/{space}/threads/{thread}

string

Thông báo của tài nguyên phòng Chat được liên kết.

Định dạng spaces/{space}/messages/{message}

string

Bắt buộc. Tên tài nguyên của không gian chế độ nhập.

Định dạng spaces/{space}

Space

Không gian cho chế độ nhập.

CardHeader

Tiêu đề của thẻ. Tiêu đề thường chứa một tiêu đề và một hình ảnh.

Section

Các phần được phân tách bằng một đường phân cách.

CardAction

Các hành động của thẻ này.

string

Tên thẻ.

string

Nhãn này từng xuất hiện trong mục trình đơn thao tác.

OnClick

Thao tác onclick cho mục hành động này.

string

Bạn phải chỉ định tiêu đề. Tiêu đề có chiều cao cố định: nếu bạn chỉ định cả tiêu đề và phụ đề, thì mỗi tiêu đề sẽ chiếm một dòng. Nếu chỉ có tiêu đề được chỉ định, thì tiêu đề sẽ chiếm cả hai dòng.

string

Phụ đề của tiêu đề thẻ.

ImageStyle

Loại hình ảnh (ví dụ: đường viền vuông hoặc đường viền tròn).

string

URL của hình ảnh trong tiêu đề thẻ.

string

Tiêu đề của phần. Hỗ trợ văn bản được định dạng. Để biết thêm thông tin về cách định dạng văn bản, hãy xem bài viết Định dạng văn bản trong ứng dụng Google Chat và Định dạng văn bản trong tiện ích bổ sung của Google Workspace.

WidgetMarkup

Một phần phải chứa ít nhất một tiện ích.

CustomEmoji

Bắt buộc. Biểu tượng cảm xúc tuỳ chỉnh cần tạo.

string

Bắt buộc. Tên tài nguyên của không gian mà bạn muốn tạo gói thành viên.

Định dạng: spaces/{space}

Membership

Bắt buộc. Mối quan hệ thành viên cần tạo.

Trường memberType phải chứa người dùng đã điền sẵn các trường user.name và user.type. Máy chủ sẽ chỉ định tên tài nguyên và ghi đè mọi nội dung được chỉ định.

Khi tạo mối quan hệ thành viên cho một người dùng thực, ứng dụng Chat phải sử dụng một số phạm vi uỷ quyền và đặt giá trị cụ thể cho một số trường:

• Khi xác thực dưới dạng người dùng, bạn phải có phạm vi uỷ quyền chat.memberships.

• Khi xác thực với tư cách là một ứng dụng, bạn phải áp dụng phạm vi uỷ quyền chat.app.memberships. Bạn có thể xác thực dưới dạng ứng dụng trong

• Đặt user.type thành HUMAN và đặt user.name theo định dạng users/{user}, trong đó {user} có thể là địa chỉ email của người dùng. Đối với người dùng trong cùng một tổ chức Workspace, {user} cũng có thể là id của người dùng trong People API hoặc id của người dùng trong Directory API. Ví dụ: nếu mã hồ sơ người dùng của People API cho [email protected] là 123456789, thì bạn có thể thêm người dùng vào không gian bằng cách đặt membership.member.name thành users/[email protected] hoặc users/123456789.

Khi tạo mối quan hệ thành viên cho chính mình, ứng dụng Chat phải xác thực dưới dạng người dùng] và sử dụng phạm vi chat.memberships.app, đặt user.type thành BOT và đặt user.name thành users/app.

bool

Không bắt buộc. Khi true, phương thức này sẽ chạy bằng đặc quyền của quản trị viên Google Workspace của người dùng.

Người dùng gọi phải là quản trị viên Google Workspace có đặc quyền quản lý cuộc trò chuyện và cuộc trò chuyện trong không gian.

Yêu cầu phạm vi OAuth 2.0 chat.admin.memberships.

Bạn không thể tạo gói thành viên ứng dụng hoặc tạo gói thành viên cho người dùng bên ngoài tổ chức Google Workspace của quản trị viên bằng quyền quản trị.

string

Bắt buộc. Tên tài nguyên của không gian để tạo thông báo.

Định dạng spaces/{space}

Message

Bắt buộc. Nội dung thư.

string

Không bắt buộc. Không dùng nữa: Chuyển sang dùng thread.thread_key. Mã nhận dạng của chuỗi. Hỗ trợ tối đa 4.000 ký tự. Để bắt đầu hoặc thêm vào một chuỗi tin nhắn, hãy tạo một tin nhắn và chỉ định threadKey hoặc thread.name. Để biết ví dụ về cách sử dụng, hãy xem phần Bắt đầu hoặc trả lời chuỗi tin nhắn.

string

Không bắt buộc. Mã yêu cầu duy nhất cho thông báo này. Việc chỉ định mã yêu cầu hiện có sẽ trả về thông báo được tạo bằng mã đó thay vì tạo thông báo mới.

MessageReplyOption

Không bắt buộc. Chỉ định xem một tin nhắn có bắt đầu một chuỗi tin nhắn hay trả lời một chuỗi tin nhắn. Chỉ được hỗ trợ trong không gian được đặt tên.

Khi phản hồi các hoạt động tương tác của người dùng, trường này sẽ bị bỏ qua. Đối với các lượt tương tác trong một chuỗi tin nhắn, tin nhắn trả lời sẽ được tạo trong cùng một chuỗi tin nhắn. Nếu không, tin nhắn trả lời sẽ được tạo dưới dạng chuỗi mới.

string

Không bắt buộc. Mã tuỳ chỉnh của một thư. Cho phép ứng dụng Chat nhận, cập nhật hoặc xoá tin nhắn mà không cần lưu trữ mã nhận dạng do hệ thống chỉ định trong tên tài nguyên của tin nhắn (được biểu thị trong trường name của tin nhắn).

Giá trị cho trường này phải đáp ứng các yêu cầu sau:

• Bắt đầu bằng client-. Ví dụ: client-custom-name là mã tuỳ chỉnh hợp lệ, nhưng custom-name thì không.
• Chứa tối đa 63 ký tự và chỉ chứa chữ cái viết thường, số và dấu gạch nối.
• Là duy nhất trong một không gian. Ứng dụng Chat không thể sử dụng cùng một mã nhận dạng tuỳ chỉnh cho nhiều tin nhắn.

Để biết thông tin chi tiết, hãy xem phần Gán tên cho thư.

string

Bắt buộc. Thông báo nơi tạo lượt thể hiện cảm xúc.

Định dạng spaces/{space}/messages/{message}

Reaction

Bắt buộc. Phản ứng cần tạo.

Space

Bắt buộc. Bạn phải điền các trường displayName và spaceType. Chỉ hỗ trợ SpaceType.SPACE và SpaceType.GROUP_CHAT. Bạn chỉ có thể sử dụng SpaceType.GROUP_CHAT nếu đặt importMode thành true.

Nếu bạn nhận được thông báo lỗi ALREADY_EXISTS, hãy thử một displayName khác. Một không gian hiện có trong tổ chức Google Workspace có thể đã sử dụng tên hiển thị này.

Không gian name được chỉ định trên máy chủ nên mọi nội dung được chỉ định trong trường này sẽ bị bỏ qua.

string

Không bắt buộc. Giá trị nhận dạng duy nhất cho yêu cầu này. Bạn nên dùng mã nhận dạng duy nhất (UUID) ngẫu nhiên. Việc chỉ định mã yêu cầu hiện có sẽ trả về không gian được tạo bằng mã đó thay vì tạo không gian mới. Việc chỉ định mã yêu cầu hiện có từ cùng một ứng dụng Chat với một người dùng đã xác thực khác sẽ trả về lỗi.

string

Giá trị nhận dạng. Tên tài nguyên của biểu tượng cảm xúc tuỳ chỉnh, do máy chủ chỉ định.

Định dạng customEmojis/{customEmoji}

string

Chỉ có đầu ra. Khoá duy nhất cho tài nguyên biểu tượng cảm xúc tuỳ chỉnh.

string

Không bắt buộc. Không thể thay đổi. Tên do người dùng cung cấp cho biểu tượng cảm xúc tuỳ chỉnh, tên này phải là duy nhất trong tổ chức.

Bắt buộc khi tạo biểu tượng cảm xúc tuỳ chỉnh, nếu không thì chỉ xuất.

Tên biểu tượng cảm xúc phải bắt đầu và kết thúc bằng dấu hai chấm, phải viết thường và chỉ được chứa các ký tự chữ và số, dấu gạch ngang và dấu gạch dưới. Bạn nên dùng dấu gạch ngang và dấu gạch dưới để phân tách các từ, nhưng không được dùng liên tiếp.

Ví dụ: :valid-emoji-name:

string

Chỉ có đầu ra. URL hình ảnh của biểu tượng cảm xúc tuỳ chỉnh, có hiệu lực ít nhất 10 phút. Xin lưu ý rằng giá trị này không được điền vào nội dung phản hồi khi tạo biểu tượng cảm xúc tuỳ chỉnh.

CustomEmojiPayload

Không bắt buộc. Chỉ nhập. Dữ liệu tải trọng. Bắt buộc khi biểu tượng cảm xúc tuỳ chỉnh được tạo.

bytes

Bắt buộc. Chỉ nhập. Hình ảnh dùng cho biểu tượng cảm xúc tuỳ chỉnh.

Trọng tải phải dưới 256 KB và kích thước của hình ảnh phải từ 64 đến 500 pixel. Các quy định hạn chế này có thể thay đổi.

string

Bắt buộc. Chỉ nhập. Tên tệp hình ảnh.

Đuôi tệp được hỗ trợ: .png, .jpg, .gif.

string

Bắt buộc. Tên tài nguyên của biểu tượng cảm xúc tuỳ chỉnh cần xoá.

Định dạng customEmojis/{customEmoji}

Bạn có thể sử dụng tên biểu tượng cảm xúc làm bí danh cho {customEmoji}. Ví dụ: customEmojis/:example-emoji:, trong đó :example-emoji: là tên biểu tượng cảm xúc cho một biểu tượng cảm xúc tuỳ chỉnh.

string

Bắt buộc. Tên tài nguyên của gói thành viên cần xoá. Ứng dụng trò chuyện có thể xoá gói thành viên của người dùng hoặc của chính ứng dụng. Các ứng dụng nhắn tin không thể xoá gói thành viên của các ứng dụng khác.

Khi xoá gói thành viên của người dùng, bạn phải có phạm vi chat.memberships và định dạng spaces/{space}/members/{member}. Bạn có thể sử dụng email này làm email đại diện cho {member}. Ví dụ: spaces/{space}/members/[email protected], trong đó [email protected] là email của người dùng Google Chat.

Khi xoá gói thành viên của ứng dụng, bạn phải có phạm vi chat.memberships.app và định dạng spaces/{space}/members/app.

Định dạng: spaces/{space}/members/{member} hoặc spaces/{space}/members/app.

bool

Không bắt buộc. Khi true, phương thức này sẽ chạy bằng các đặc quyền quản trị viên Google Workspace của người dùng.

Người dùng gọi phải là quản trị viên Google Workspace có đặc quyền quản lý cuộc trò chuyện và cuộc trò chuyện trong không gian.

Yêu cầu phạm vi OAuth 2.0 chat.admin.memberships.

Bạn không thể xoá gói thành viên của ứng dụng trong một không gian bằng quyền quản trị.

string

Bắt buộc. Tên tài nguyên của thông báo.

Định dạng spaces/{space}/messages/{message}

Nếu đã đặt mã tuỳ chỉnh cho thông báo của mình thì bạn có thể sử dụng giá trị từ trường clientAssignedMessageId cho {message}. Để biết thông tin chi tiết, hãy xem phần Gán tên cho thư.

bool

Không bắt buộc. Khi true, việc xoá một thư cũng sẽ xoá các thư trả lời theo chuỗi của thư đó. Khi false, nếu một thư có các tin nhắn trả lời theo chuỗi, thì thao tác xoá sẽ không thành công.

Chỉ áp dụng khi xác thực dưới dạng người dùng. Không có hiệu lực khi xác thực dưới dạng ứng dụng Chat.

string

Bắt buộc. Tên của phản ứng muốn xoá.

Định dạng spaces/{space}/messages/{message}/reactions/{reaction}

string

Bắt buộc. Tên tài nguyên của không gian cần xoá.

Định dạng spaces/{space}

bool

Không bắt buộc. Khi true, phương thức này sẽ chạy bằng đặc quyền của quản trị viên Google Workspace của người dùng.

Người dùng gọi phải là quản trị viên Google Workspace có đặc quyền quản lý cuộc trò chuyện và không gian trên Chat.

Yêu cầu chat.admin.delete phạm vi OAuth 2.0.

DeletionType

Cho biết người đã xoá thư.

Card

Chỉ nhập. Nội dung của hộp thoại, được hiển thị ở chế độ phương thức. Ứng dụng Google Chat không hỗ trợ các thực thể thẻ sau: DateTimePicker, OnChangeAction.

ActionStatus

Chỉ nhập. Trạng thái của yêu cầu gọi hoặc gửi hộp thoại. Hiển thị trạng thái và thông báo cho người dùng (nếu cần). Ví dụ: trong trường hợp xảy ra lỗi hoặc thành công.

Dialog

Chỉ nhập. Hộp thoại cho yêu cầu.

string

Mã nhận dạng của tệp trên Drive. Sử dụng với API Drive.

DriveDataRef

DriveDataRef tham chiếu đến một tệp trên Google Drive.

string

Loại mime của tài nguyên Google Drive được liên kết.

string

Không bắt buộc. Biểu tượng cảm xúc cơ bản được biểu thị bằng một chuỗi unicode.

CustomEmoji

Chỉ có đầu ra. Biểu tượng cảm xúc tuỳ chỉnh.

Emoji

Chỉ có đầu ra. Biểu tượng cảm xúc được liên kết với các lượt thể hiện cảm xúc.

int32

Chỉ có đầu ra. Tổng số lượt thể hiện cảm xúc bằng biểu tượng cảm xúc được liên kết.

string

Bắt buộc. Tên tài nguyên của người dùng để tìm tin nhắn trực tiếp.

Định dạng: users/{user}, trong đó {user} là id cho người trong API People hoặc id cho người dùng trong API Directory. Ví dụ: nếu mã hồ sơ API People là 123456789, bạn có thể tìm thấy tin nhắn trực tiếp với người đó bằng cách sử dụng users/123456789 làm name. Khi xác thực là người dùng, bạn có thể sử dụng email làm bí danh cho {user}. Ví dụ: users/[email protected], trong đó [email protected] là email của người dùng Google Chat.

string

Bắt buộc. Tên tài nguyên của tệp đính kèm, ở dạng spaces/{space}/messages/{message}/attachments/{attachment}.

string

Bắt buộc. Tên tài nguyên của biểu tượng cảm xúc tuỳ chỉnh.

Định dạng customEmojis/{customEmoji}

Bạn có thể sử dụng tên biểu tượng cảm xúc làm bí danh cho {customEmoji}. Ví dụ: customEmojis/:example-emoji:, trong đó :example-emoji: là tên biểu tượng cảm xúc cho một biểu tượng cảm xúc tuỳ chỉnh.

string

Bắt buộc. Tên tài nguyên của gói thành viên cần truy xuất.

Để nhận tư cách thành viên riêng trong ứng dụng bằng cách sử dụng xác thực người dùng, bạn có thể tuỳ ý sử dụng spaces/{space}/members/app.

Định dạng: spaces/{space}/members/{member} hoặc spaces/{space}/members/app

Bạn có thể sử dụng email của người dùng làm bí danh cho {member}. Ví dụ: spaces/{space}/members/[email protected], trong đó [email protected] là email của người dùng Google Chat.

bool

Không bắt buộc. Khi true, phương thức này sẽ chạy bằng các đặc quyền quản trị viên Google Workspace của người dùng.

Người dùng gọi phải là quản trị viên Google Workspace có đặc quyền quản lý cuộc trò chuyện và cuộc trò chuyện trong không gian.

Yêu cầu phạm vi OAuth 2.0 chat.admin.memberships hoặc chat.admin.memberships.readonly.

Bạn không thể mua gói thành viên ứng dụng trong không gian khi sử dụng quyền quản trị.

string

Bắt buộc. Tên tài nguyên của thông báo.

Định dạng spaces/{space}/messages/{message}

Nếu đã đặt mã nhận dạng tuỳ chỉnh cho thông báo, bạn có thể sử dụng giá trị trong trường clientAssignedMessageId cho {message}. Để biết thông tin chi tiết, hãy xem phần Đặt tên cho thông báo.

string

Bắt buộc. Tên tài nguyên của sự kiện không gian.

Định dạng spaces/{space}/spaceEvents/{spaceEvent}

string

Bắt buộc. Định dạng: users/{user}/spaces/{space}/spaceNotificationSetting

• users/me/spaces/{space}/spaceNotificationSetting, HOẶC
• users/[email protected]/spaces/{space}/spaceNotificationSetting, HOẶC
• users/123456789/spaces/{space}/spaceNotificationSetting. Lưu ý: Chỉ cho phép mã nhận dạng người dùng hoặc email của phương thức gọi trong đường dẫn.

string

Bắt buộc. Tên tài nguyên của trạng thái đọc không gian cần truy xuất.

Chỉ hỗ trợ nhận trạng thái đọc cho người dùng gọi.

Để tham chiếu đến người dùng gọi, hãy đặt một trong những giá trị sau:

• Bí danh me. Ví dụ: users/me/spaces/{space}/spaceReadState.

• Địa chỉ email Workspace của họ. Ví dụ: users/[email protected]/spaces/{space}/spaceReadState.

• Mã nhận dạng người dùng của họ. Ví dụ: users/123456789/spaces/{space}/spaceReadState.

Định dạng: users/{user}/spaces/{space}/spaceReadState

string

Bắt buộc. Tên tài nguyên của không gian, ở dạng spaces/{space}.

Định dạng spaces/{space}

bool

Không bắt buộc. Khi true, phương thức này sẽ chạy bằng các đặc quyền quản trị viên Google Workspace của người dùng.

Người dùng gọi phải là quản trị viên Google Workspace có đặc quyền quản lý cuộc trò chuyện và cuộc trò chuyện trong không gian.

Yêu cầu các phạm vi OAuth 2.0 chat.admin.spaces hoặc chat.admin.spaces.readonly.

string

Bắt buộc. Tên tài nguyên của trạng thái đọc luồng cần truy xuất.

Chỉ hỗ trợ nhận trạng thái đọc cho người dùng gọi.

Để tham chiếu đến người dùng gọi, hãy đặt một trong những giá trị sau:

• Bí danh me. Ví dụ: users/me/spaces/{space}/threads/{thread}/threadReadState.

• Địa chỉ email Workspace của họ. Ví dụ: users/[email protected]/spaces/{space}/threads/{thread}/threadReadState.

• Mã nhận dạng người dùng của họ. Ví dụ: users/123456789/spaces/{space}/threads/{thread}/threadReadState.

Định dạng: users/{user}/spaces/{space}/threads/{thread}/threadReadState

string

Tên tài nguyên cho một Google Group.

Biểu thị một nhóm trong Cloud Identity Groups API.

Định dạng: nhóm/{group}

int32

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ị lớn nhất là 200; các giá trị trên 200 được thay đổi thành 200.

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 chuyển một giá trị khác có thể dẫn đến kết quả không mong muốn.

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 dựa trên việc các biểu tượng này có do người dùng gọi tạo hay không.

Ví dụ: truy vấn sau đây sẽ 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ị máy chủ từ chối bằng lỗi INVALID_ARGUMENT.

CustomEmoji

Danh sách không theo thứ tự. Danh sách biểu tượng cảm xúc tuỳ chỉnh trên trang được yêu cầu (hoặc trang đầu tiên).

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.

string

Bắt buộc. Tên tài nguyên của không gian cần tìm nạp danh sách thành viên.

Định dạng: spaces/{space}

int32

Không bắt buộc. Số lượng gói thành viên tối đa cần trả về. Dịch vụ có thể trả về ít hơn giá trị này.

Nếu bạn không xác định, hệ thống sẽ trả lại tối đa 100 gói hội viên.

Giá trị tối đa là 1000. Nếu bạn sử dụng giá trị lớn hơn 1000, giá trị này sẽ tự động thay đổi thành 1000.

Giá trị âm sẽ trả về lỗi INVALID_ARGUMENT.

string

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

Khi phân trang, tất cả các thông 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 chuyển các giá trị khác nhau sang các thông số khác có thể dẫn đến kết quả không mong muốn.

string

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

Bạn có thể lọc tư cách thành viên theo vai trò (role) và loại của thành viên (member.type).

Để lọc theo vai trò, hãy đặt role thành ROLE_MEMBER hoặc ROLE_MANAGER.

Để lọc theo loại, hãy đặt member.type thành HUMAN hoặc BOT. Bạn cũng có thể lọc member.type bằng toán tử !=.

Để lọc theo cả vai trò và loại, hãy sử dụng toán tử AND. Để lọc theo vai trò hoặc loại, hãy sử dụng toán tử OR.

Bạn bắt buộc phải sử dụng member.type = "HUMAN" hoặc member.type != "BOT" khi đặt use_admin_access thành true. Các bộ lọc loại thành viên khác sẽ bị từ chối.

Ví dụ: các truy vấn sau đây là hợp lệ:

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

member.type != "BOT"

Các truy vấn sau không hợp lệ:

member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

Máy chủ có lỗi INVALID_ARGUMENT từ chối các truy vấn không hợp lệ.

bool

Không bắt buộc. Khi true, cũng trả về các gói hội viên liên kết với một Google Group, ngoài các loại gói hội viên khác. Nếu bạn đặt filter, thì hệ thống sẽ không trả về những gói thành viên của Google Group không khớp với tiêu chí lọc.

bool

Không bắt buộc. Khi true, cũng trả về các gói thành viên được liên kết với thành viên invited, ngoài các loại gói thành viên khác. Nếu bạn đặt bộ lọc, thì các gói thành viên invited không khớp với tiêu chí bộ lọc sẽ không được trả về.

Hiện yêu cầu xác thực người dùng.

bool

Không bắt buộc. Khi true, phương thức này sẽ chạy bằng các đặc quyền quản trị viên Google Workspace của người dùng.

Người dùng gọi phải là quản trị viên Google Workspace có đặc quyền quản lý cuộc trò chuyện và cuộc trò chuyện trong không gian.

Yêu cầu phạm vi OAuth 2.0 chat.admin.memberships.readonly hoặc chat.admin.memberships.

Bạn không thể đăng danh sách gói thành viên ứng dụng trong không gian khi sử dụng quyền quản trị.

Membership

Danh sách không theo thứ tự. Danh sách gói thành viên trong trang được yêu cầu (hoặc trang đầu tiên).

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.

string

Bắt buộc. Tên tài nguyên của không gian để liệt kê tin nhắn.

Định dạng spaces/{space}

int32

Không bắt buộc. Số lượng thư tối đa được trả về. Dịch vụ có thể trả về ít thông báo hơn giá trị này.

Nếu không chỉ định, hệ thống sẽ trả về tối đa 25.

Giá trị tối đa là 1000. Nếu bạn sử dụng giá trị lớn hơn 1000, giá trị đó sẽ tự động thay đổi thành 1000.

Giá trị âm sẽ trả về lỗi INVALID_ARGUMENT.

string

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

Khi phân trang, tất cả các thông 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 chuyển các giá trị khác nhau sang các thông số khác có thể dẫn đến kết quả không mong muốn.

string

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

Bạn có thể lọc tin nhắn theo ngày (create_time) và chuỗi tin nhắn (thread.name).

Để lọc thư theo ngày tạo, hãy chỉ định create_time bằng dấu thời gian ở định dạng RFC-3339 và dấu ngoặc kép đôi. Ví dụ: "2023-04-21T11:30:00-04:00". Bạn có thể sử dụng toán tử lớn hơn > để liệt kê các thông báo được tạo sau một dấu thời gian hoặc toán tử nhỏ hơn < để liệt kê các thông báo được tạo trước một dấu thời gian. Để lọc tin nhắn trong một khoảng thời gian, hãy sử dụng toán tử AND giữa hai dấu thời gian.

Để lọc theo chuỗi tin nhắn, hãy chỉ định thread.name, có định dạng là spaces/{space}/threads/{thread}. Bạn chỉ có thể chỉ định một thread.name cho mỗi truy vấn.

Để lọc theo cả chuỗi tin nhắn và ngày, hãy sử dụng toán tử AND trong truy vấn.

Ví dụ: các truy vấn sau đây là hợp lệ:

create_time > "2012-04-21T11:30:00-04:00"

create_time > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

create_time > "2012-04-21T11:30:00+00:00" AND

create_time < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

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

string

Không bắt buộc. Cách sắp xếp danh sách thư. Chỉ định giá trị cho đơn đặt hàng bằng một thao tác đặt hàng. Sau đây là các giá trị hợp lệ cho toán tử sắp xếp:

• ASC để tăng dần.

• DESC để giảm dần.

Thứ tự mặc định là create_time ASC.

bool

Không bắt buộc. Liệu có bao gồm thư đã xoá hay không. Tin nhắn đã xoá bao gồm thời gian xoá và siêu dữ liệu về việc xoá, nhưng không có nội dung tin nhắn.

Message

Danh sách tin nhắn.

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, sẽ không có trang tiếp theo.

string

Bắt buộc. Tin nhắn mà người dùng đã phản ứng.

Định dạng spaces/{space}/messages/{message}

int32

Không bắt buộc. Số lượt thể hiện cảm xúc tối đa được trả về. Dịch vụ có thể trả về ít lượt bày tỏ cảm xúc hơn giá trị này. Nếu bạn không 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.

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 phản ứng danh sách trước đó. Cung cấp mã 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 chuyển một giá trị khác có thể dẫn đến kết quả không mong muốn.

string

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

Bạn có thể lọc lượt thể hiện cảm xúc theo biểu tượng cảm xúc (emoji.unicode hoặc emoji.custom_emoji.uid) và người dùng (user.name).

Để lọc lượt thể hiện cảm xúc cho nhiều biểu tượng cảm xúc hoặc người dùng, hãy kết hợp các trường tương tự bằng toán tử OR, chẳng hạn như emoji.unicode = "🙂" OR emoji.unicode = "👍" và user.name = "users/AAAAAA" OR user.name = "users/BBBBBB".

Để lọc lượt thể hiện cảm xúc theo biểu tượng cảm xúc và người dùng, hãy sử dụng toán tử AND, chẳng hạn như emoji.unicode = "🙂" AND user.name = "users/AAAAAA".

Nếu truy vấn của bạn sử dụng cả AND và OR, hãy nhóm các tham số đó bằng dấu ngoặc đơn.

Ví dụ: các truy vấn sau đây là hợp lệ:

user.name = "users/{user}"
emoji.unicode = "🙂"
emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR emoji.unicode = "👍"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" AND user.name = "users/{user}"
(emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}")
AND user.name = "users/{user}"

Các truy vấn sau không hợp lệ:

emoji.unicode = "🙂" AND emoji.unicode = "👍"
emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR
user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
AND user.name = "users/{user}"

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

Reaction

Danh sách các lượt phản ứng trong trang được yêu cầu (hoặc trang đầu tiên).

string

Mã thông báo tiếp tục để truy xuất trang kết quả tiếp theo. Trường này sẽ trống đối với trang kết quả cuối cùng.

string

Bắt buộc. Tên tài nguyên của phòng Google Chat nơi diễn ra sự kiện.

Định dạng: spaces/{space}.

int32

Không bắt buộc. Số lượng sự kiện không gian tối đa được trả về. Dịch vụ có thể trả về ít hơn giá trị này.

Giá trị âm sẽ trả về lỗi INVALID_ARGUMENT.

string

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

Khi phân trang, tất cả các thông số khác được cung cấp để liệt kê các sự kiện không gian 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 đến các tham số khác có thể dẫn đến kết quả không mong muốn.

string

Bắt buộc. Bộ lọc truy vấn.

Bạn phải chỉ định ít nhất một loại sự kiện (event_type) bằng cách sử dụng toán tử có :. Để lọc theo nhiều loại sự kiện, hãy sử dụng toán tử OR. Bỏ qua các loại sự kiện hàng loạt trong bộ lọc. Yêu cầu này tự động trả về mọi sự kiện theo lô có liên quan. Ví dụ: nếu bạn lọc theo lượt phản ứng mới (google.workspace.chat.reaction.v1.created), thì máy chủ cũng trả về các sự kiện phản ứng mới theo lô (google.workspace.chat.reaction.v1.batchCreated). Để biết danh sách các loại sự kiện được hỗ trợ, hãy xem tài liệu tham khảo về SpaceEvents.

Nếu muốn, bạn cũng có thể lọc theo thời gian bắt đầu (start_time) và thời gian kết thúc (end_time):

• start_time: Dấu thời gian độc quyền để bắt đầu liệt kê các sự kiện trong không gian. Bạn có thể liệt kê các sự kiện xảy ra tối đa 28 ngày trước. Nếu không được chỉ định, hãy liệt kê các sự kiện không gian trong 28 ngày qua.
• end_time: Dấu thời gian bao gồm cho đến khi các sự kiện trong không gian được liệt kê. Nếu không được chỉ định, hãy liệt kê các sự kiện cho đến thời điểm yêu cầu.

Để chỉ định thời gian bắt đầu hoặc kết thúc, hãy sử dụng toán tử bằng = và định dạng trong RFC-3339. Để lọc theo cả start_time và end_time, hãy sử dụng toán tử AND.

Ví dụ: các truy vấn sau đây là hợp lệ:

start_time="2023-08-23T19:20:33+00:00" AND
end_time="2023-08-23T19:21:54+00:00"

start_time="2023-08-23T19:20:33+00:00" AND
(event_types:"google.workspace.chat.space.v1.updated" OR
event_types:"google.workspace.chat.message.v1.created")

Các truy vấn sau không hợp lệ:

start_time="2023-08-23T19:20:33+00:00" OR
end_time="2023-08-23T19:21:54+00:00"

event_types:"google.workspace.chat.space.v1.updated" AND
event_types:"google.workspace.chat.message.v1.created"

Máy chủ có lỗi INVALID_ARGUMENT từ chối các truy vấn không hợp lệ.

SpaceEvent

Kết quả được trả về theo thứ tự thời gian (sự kiện cũ nhất được xếp trước). Lưu ý: Trường permissionSettings không được trả về trong đối tượng Không gian cho các yêu cầu về danh sách.

string

Mã thông báo tiếp tục dùng để tìm nạp thêm sự kiện. Nếu trường này bị bỏ qua thì sẽ không có trang tiếp theo.

int32

Không bắt buộc. Số lượng dấu cách tối đa cần trả về. Dịch vụ có thể trả về ít hơn giá trị này.

Nếu bạn không chỉ định thì hệ thống sẽ trả về tối đa 100 dấu cách.

Giá trị tối đa là 1000. Nếu bạn sử dụng giá trị lớn hơn 1000, giá trị đó sẽ tự động thay đổi thành 1000.

Giá trị âm sẽ trả về lỗi INVALID_ARGUMENT.

string

Không bắt buộc. Mã thông báo trang, nhận được từ một lệnh gọi không gian danh sách trước đó. Cung cấp thông số 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.

string

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

Bạn có thể lọc không gian theo loại không gian (space_type).

Để lọc theo loại không gian, bạn phải chỉ định giá trị enum hợp lệ, chẳng hạn như SPACE hoặc GROUP_CHAT (space_type không được là SPACE_TYPE_UNSPECIFIED). Để truy vấn nhiều loại không gian, hãy sử dụng toán tử OR.

Ví dụ: các truy vấn sau đây là hợp lệ:

space_type = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

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

Space

Danh sách không gian trong trang được yêu cầu (hoặc trang đầu tiên). Lưu ý: Trường permissionSettings không được trả về trong đối tượng Không gian cho các yêu cầu về danh sách.

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 thì không có trang tiếp theo nào.

string

Chỉ có đầu ra. URL đã được so khớp.

string

Giá trị nhận dạng. Tên tài nguyên của gói thành viên do máy chủ chỉ định.

Định dạng spaces/{space}/members/{member}

MembershipState

Chỉ có đầu ra. Trạng thái của gói thành viên.

MembershipRole

Không bắt buộc. Vai trò của người dùng trong một phòng Chat, vai trò này xác định những hành động mà người dùng được phép thực hiện trong phòng.

Bạn chỉ có thể dùng trường này làm dữ liệu đầu vào trong UpdateMembership.

Timestamp

Không bắt buộc. Bất biến. Thời gian tạo thành viên, chẳng hạn như thời điểm thành viên tham gia hoặc được mời tham gia không gian. Trường này chỉ được cung cấp cho kết quả đầu ra, trừ phi trường này được dùng để nhập tư cách thành viên trước đây vào không gian ở chế độ nhập.

Timestamp

Không bắt buộc. Không thể thay đổi. Thời điểm xoá tư cách thành viên, chẳng hạn như khi một thành viên rời khỏi hoặc bị xoá khỏi không gian. Trường này chỉ xuất, ngoại trừ khi được dùng để nhập gói thành viên trước đây trong các không gian ở chế độ nhập.

User

Không bắt buộc. Người dùng hoặc ứng dụng Google Chat tương ứng với gói thành viên. Nếu ứng dụng Chat xác thực dưới dạng người dùng, thì kết quả sẽ điền sẵn name và type của người dùng.

Group

Không bắt buộc. Nhóm Google tương ứng với gói thành viên.

Bạn cần xác thực người dùng để đọc hoặc thay đổi thông tin thành viên của Google Groups.

MembershipCreatedEventData

Danh sách gói hội viên mới.

MembershipDeletedEventData

Danh sách những gói hội viên đã xoá.

MembershipUpdatedEventData

Danh sách các gói thành viên đã cập nhật.

Membership

Gói thành viên mới.

Membership

Gói thành viên đã bị xoá. Chỉ điền các trường name và state.

Membership

Gói thành viên mới cập nhật.

string

Giá trị nhận dạng. Tên tài nguyên của thông báo.

Định dạng spaces/{space}/messages/{message}

Trong đó, {space} là mã nhận dạng của không gian nơi đăng tin nhắn và {message} là mã nhận dạng do hệ thống chỉ định cho tin nhắn. Ví dụ: spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB.

Nếu đặt mã nhận dạng tuỳ chỉnh khi tạo thông báo, bạn có thể sử dụng mã nhận dạng này để chỉ định thông báo trong yêu cầu bằng cách thay thế {message} bằng giá trị trong trường clientAssignedMessageId. Ví dụ: spaces/AAAAAAAAAAA/messages/client-custom-name. Để biết thông tin chi tiết, hãy xem phần Gán tên cho thư.

User

Chỉ có đầu ra. Người dùng đã tạo thư. Nếu ứng dụng Chat xác thực với tư cách là một người dùng, thì dữ liệu đầu ra sẽ được điền cho người dùng name và type.

Timestamp

Không bắt buộc. Bất biến. Đối với các không gian được tạo trong Chat, thời gian tạo tin nhắn. Trường này chỉ xuất, ngoại trừ khi được sử dụng trong không gian ở chế độ nhập.

Đối với không gian ở chế độ nhập, hãy đặt trường này thành dấu thời gian trong quá khứ tại thời điểm tạo thông báo trong nguồn để giữ nguyên thời gian tạo ban đầu.

Timestamp

Chỉ có đầu ra. Thời gian người dùng chỉnh sửa thông báo gần đây nhất. Nếu chưa từng chỉnh sửa thư, trường này sẽ trống.

Timestamp

Chỉ có đầu ra. Thời điểm xoá tin nhắn trong Google Chat. Nếu thư không bao giờ bị xoá, trường này sẽ trống.

string

Không bắt buộc. Nội dung thư ở dạng văn bản thuần tuý. Đường liên kết đầu tiên đến một hình ảnh, video hoặc trang web sẽ tạo ra một khối xem trước. Bạn cũng có thể @thao tác nhắc đến một người dùng Google Chat hoặc mọi người trong không gian.

Để tìm hiểu về cách tạo tin nhắn văn bản, hãy xem phần Gửi tin nhắn.

string

Chỉ có đầu ra. Chứa thông báo text cùng với mã đánh dấu được thêm vào để thể hiện định dạng. Trường này có thể không ghi lại tất cả định dạng hiển thị trong giao diện người dùng, nhưng bao gồm những định dạng sau:

• Cú pháp đánh dấu cho văn bản in đậm, in nghiêng, gạch ngang, phông chữ một khoảng cách, khối phông chữ một khoảng cách và danh sách có dấu đầu dòng.

• Nội dung đề cập đến người dùng sử dụng định dạng <users/{user}>.

• Siêu liên kết tuỳ chỉnh sử dụng định dạng <{url}|{rendered_text}>, trong đó chuỗi đầu tiên là URL và chuỗi thứ hai là văn bản được hiển thị, ví dụ: <http://example.com|custom text>.

• Biểu tượng cảm xúc tuỳ chỉnh sử dụng định dạng :{emoji_name}:, ví dụ: :smile:. Điều này không áp dụng cho biểu tượng cảm xúc Unicode, chẳng hạn như U+1F600 cho biểu tượng mặt cười.

Để biết thêm thông tin, hãy xem phần Xem định dạng văn bản được gửi trong một thư

Card

Không dùng nữa: Thay vào đó, hãy sử dụng cards_v2.

Các thẻ có nội dung phong phú, có định dạng và có tính tương tác mà bạn có thể dùng để hiển thị các thành phần trên giao diện người dùng như: văn bản được định dạng, nút và hình ảnh có thể nhấp vào. Thẻ thường xuất hiện bên dưới nội dung văn bản thuần tuý của thư. cards và cards_v2 có thể có kích thước tối đa là 32 KB.

CardWithId

Không bắt buộc. Một mảng thẻ.

Chỉ các ứng dụng trong Chat mới có thể tạo thẻ. Nếu ứng dụng Chat của bạn xác thực dưới dạng người dùng, thì tin nhắn không được chứa thẻ.

Để tìm hiểu cách tạo tin nhắn chứa thẻ, hãy xem bài viết Gửi tin nhắn.

Thiết kế và xem trước thẻ bằng Trình tạo thẻ.

Annotation

Chỉ có đầu ra. Chú thích liên kết với text trong thông báo này.

Thread

Chuỗi tin nhắn mà thư thuộc về. Để biết ví dụ về cách sử dụng, hãy xem phần Bắt đầu hoặc trả lời chuỗi tin nhắn.

Space

Chỉ có đầu ra. Nếu ứng dụng Chat xác thực với tư cách người dùng, thì kết quả chỉ điền sẵn không gian name.

string

Không bắt buộc. Nội dung mô tả bằng văn bản thuần tuý về các thẻ của thông báo, được dùng khi không thể hiển thị các thẻ thực tế (ví dụ: thông báo trên thiết bị di động).

ActionResponse

Chỉ nhập. Các thông số mà ứng dụng Chat có thể sử dụng để định cấu hình cách đăng phản hồi.

string

Chỉ có đầu ra. Nội dung tin nhắn ở dạng văn bản thuần tuý, trong đó xoá tất cả nội dung đề cập đến ứng dụng Chat.

SlashCommand

Chỉ có đầu ra. Thông tin về lệnh dấu gạch chéo, nếu có.

Attachment

Không bắt buộc. Tệp đính kèm do người dùng tải lên.

MatchedUrl

Chỉ có đầu ra. URL trong spaces.messages.text khớp với mẫu bản xem trước đường liên kết. Để biết thêm thông tin, hãy xem phần Xem trước đường liên kết.

bool

Chỉ có đầu ra. Khi true, tin nhắn sẽ là phản hồi trong chuỗi trả lời. Khi false, tin nhắn sẽ xuất hiện trong cuộc trò chuyện cấp cao nhất của không gian dưới dạng tin nhắn đầu tiên của một chuỗi tin nhắn hoặc tin nhắn không có tin nhắn trả lời theo chuỗi.

Nếu không gian không hỗ trợ tính năng trả lời trong chuỗi tin nhắn, thì trường này luôn là false.

string

Không bắt buộc. Mã nhận dạng tuỳ chỉnh cho thông báo. Bạn có thể sử dụng trường để xác định một thư hoặc để nhận, xoá hoặc cập nhật thư. Để đặt mã nhận dạng tuỳ chỉnh, hãy chỉ định trường messageId khi bạn tạo thông báo. Để biết thông tin chi tiết, hãy xem phần Gán tên cho thư.

EmojiReactionSummary

Chỉ có đầu ra. Danh sách tóm tắt các biểu tượng cảm xúc phản ứng trên tin nhắn.

User

Không bắt buộc. Không thể thay đổi. Dữ liệu đầu vào để tạo thông báo, nếu không thì chỉ có dữ liệu đầu ra. Người dùng có thể xem thông báo. Khi được đặt, tin nhắn sẽ ở chế độ riêng tư và chỉ hiển thị với người dùng được chỉ định cũng như ứng dụng Chat. Để đưa trường này vào yêu cầu, bạn phải gọi API Chat bằng cách xác thực ứng dụng và bỏ qua những trường hợp sau:

• Tệp đính kèm
• Tiện ích phụ kiện

Để biết thông tin chi tiết, hãy xem phần Gửi thư ở chế độ riêng tư.

DeletionMetadata

Chỉ có đầu ra. Thông tin về một thư đã xoá. Tin nhắn sẽ bị xoá khi bạn đặt delete_time.

QuotedMessageMetadata

Chỉ có đầu ra. Thông tin về một tin nhắn do một người dùng Google Chat trích dẫn trong một không gian. Người dùng Google Chat có thể trích dẫn một tin nhắn để trả lời.

AttachedGif

Chỉ có đầu ra. Hình ảnh GIF được đính kèm vào thư.

AccessoryWidget

Không bắt buộc. Một hoặc nhiều tiện ích tương tác xuất hiện ở cuối thư. Bạn có thể thêm tiện ích phụ kiện vào những tin nhắn chứa văn bản, thẻ hoặc cả văn bản và thẻ. Không hỗ trợ cho các tin nhắn chứa hộp thoại. Để biết thông tin chi tiết, hãy xem phần Thêm tiện ích tương tác ở cuối thư.

Để tạo tin nhắn bằng các tiện ích phụ kiện, bạn cần xác thực ứng dụng.

MessageCreatedEventData

Danh sách tin nhắn mới.

MessageDeletedEventData

Danh sách các thư đã xoá.

MessageUpdatedEventData

Danh sách thông báo đã cập nhật.

Message

Tin nhắn mới.

Message

Tin nhắn đã xoá. Chỉ điền sẵn các trường name, createTime, deleteTime và deletionMetadata.

Message

Tin nhắn đã cập nhật.

string

Chỉ có đầu ra. Tên tài nguyên của tin nhắn được trích dẫn.

Định dạng spaces/{space}/messages/{message}

Timestamp

Chỉ có đầu ra. Dấu thời gian khi thư được trích dẫn được tạo hoặc khi thư được trích dẫn được cập nhật gần đây nhất.

string

Giá trị nhận dạng. Tên tài nguyên của phản ứng.

Định dạng spaces/{space}/messages/{message}/reactions/{reaction}

User

Chỉ có đầu ra. Người dùng đã tạo biểu tượng cảm xúc.

Emoji

Bắt buộc. Biểu tượng cảm xúc được dùng trong lượt thể hiện cảm xúc.

ReactionCreatedEventData

Danh sách các biểu tượng bày tỏ cảm xúc mới.

ReactionDeletedEventData

Danh sách các lượt bày tỏ cảm xúc đã xoá.

Reaction

Phản ứng mới.

Reaction

Phản ứng đã bị xoá.

string

URI của đường liên kết này.

RichLinkType

Loại đường liên kết đa dạng thức.

DriveLinkData

Dữ liệu cho đường liên kết đến Drive.

ChatSpaceLinkData

Dữ liệu về đường liên kết đến phòng Chat.

bool

Khi true, phương thức này sẽ chạy bằng các đặc quyền quản trị viên Google Workspace của người dùng.

Người dùng gọi phải là quản trị viên Google Workspace có đặc quyền quản lý cuộc trò chuyện và không gian trên Chat.

Yêu cầu phạm vi OAuth 2.0 chat.admin.spaces.readonly hoặc chat.admin.spaces.

Phương thức này hiện chỉ hỗ trợ quyền quản trị, do đó, chỉ true mới được chấp nhận cho trường này.

int32

Số lượng dấu cách tối đa cần trả về. Dịch vụ có thể trả về ít hơn giá trị này.

Nếu bạn không chỉ định thì hệ thống sẽ trả về tối đa 100 dấu cách.

Giá trị tối đa là 1000. Nếu bạn sử dụng giá trị lớn hơn 1000, giá trị đó sẽ tự động thay đổi thành 1000.

string

Một mã thông báo nhận được từ lệnh gọi không gian tìm kiếm 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 thông 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 chuyển các giá trị khác nhau sang các thông số khác có thể dẫn đến kết quả không mong muốn.

string

Bắt buộc. Cụm từ tìm kiếm.

Bạn có thể tìm kiếm bằng cách sử dụng các tham số sau:

• create_time
• customer
• display_name
• external_user_allowed
• last_active_time
• space_history_state
• space_type

create_time và last_active_time chấp nhận dấu thời gian ở định dạng RFC-3339 và các toán tử so sánh được hỗ trợ là: =, <, >, <=, >=.

customer là thông tin bắt buộc và được dùng để cho biết khách hàng nào sẽ tìm nạp không gian. customers/my_customer là giá trị duy nhất được hỗ trợ.

display_name chỉ chấp nhận toán tử HAS (:). Trước tiên, văn bản cần so khớp được mã hoá thành mã thông báo. Mỗi mã thông báo được so khớp với tiền tố, không phân biệt chữ hoa chữ thường và độc lập dưới dạng một chuỗi con ở bất kỳ đâu trong display_name của không gian. Ví dụ: Fun Eve khớp với Fun event hoặc The evening was fun, nhưng không khớp với notFun event hoặc even.

external_user_allowed chấp nhận true hoặc false.

space_history_state chỉ chấp nhận các giá trị từ trường historyState của tài nguyên space.

space_type là bắt buộc và giá trị hợp lệ duy nhất là SPACE.

Trên các trường khác nhau, chỉ toán tử AND được hỗ trợ. Ví dụ hợp lệ là space_type = "SPACE" AND display_name:"Hello" và space_type = "SPACE" OR display_name:"Hello" không hợp lệ.

Trong cùng một trường, space_type không hỗ trợ toán tử AND hoặc OR. display_name, "space_history_state" và "external_user_Allowed" chỉ hỗ trợ các toán tử OR. last_active_time và create_time hỗ trợ cả toán tử AND và OR. Bạn chỉ có thể sử dụng AND để biểu thị một khoảng thời gian, chẳng hạn như last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00".

Các truy vấn mẫu sau đây là hợp lệ:

customer = "customers/my_customer" AND space_type = "SPACE"

customer = "customers/my_customer" AND space_type = "SPACE" AND
display_name:"Hello World"

customer = "customers/my_customer" AND space_type = "SPACE" AND
(last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time >
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(display_name:"Hello World" OR display_name:"Fun event") AND
(last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time <
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(create_time > "2019-01-01T00:00:00+00:00" AND create_time <
"2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND
(space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")

string

Không bắt buộc. Cách sắp xếp danh sách không gian.

Sau đây là các thuộc tính được hỗ trợ để sắp xếp:

• membership_count.joined_direct_human_user_count – Cho biết số người dùng đã trực tiếp tham gia một không gian.
• last_active_time – Cho biết thời điểm thêm mục đủ điều kiện gần đây nhất vào bất kỳ chủ đề nào của không gian này.
• create_time — Cho biết thời gian tạo không gian.

Các giá trị hợp lệ của toán tử sắp xếp là:

• ASC để tăng dần. Giá trị mặc định.

• DESC để giảm dần.

Cú pháp được hỗ trợ là:

• membership_count.joined_direct_human_user_count DESC
• membership_count.joined_direct_human_user_count ASC
• last_active_time DESC
• last_active_time ASC
• create_time DESC
• create_time ASC

Space

Trang của các không gian được yêu cầu.

string

Một mã thông báo có thể dùng để truy xuất trang tiếp theo. Nếu trường này trống, thì sẽ không có trang tiếp theo.

int32

Tổng số không gian khớp với cụm từ tìm kiếm trên tất cả các trang. Nếu kết quả là hơn 10.000 khoảng trắng, thì giá trị này là giá trị ước tính.

Space

Bắt buộc. Trường Space.spaceType là bắt buộc.

Để tạo không gian, hãy đặt Space.spaceType thành SPACE rồi đặt Space.displayName. Nếu bạn nhận được thông báo lỗi ALREADY_EXISTS khi thiết lập không gian, hãy thử một displayName khác. Một không gian hiện có trong tổ chức trên Google Workspace có thể đã sử dụng tên hiển thị này.

Để tạo cuộc trò chuyện nhóm, hãy đặt Space.spaceType thành GROUP_CHAT. Không đặt Space.displayName.

Để tạo cuộc trò chuyện 1:1 giữa những người với nhau, hãy đặt Space.spaceType thành DIRECT_MESSAGE và đặt Space.singleUserBotDm thành false. Không đặt Space.displayName hoặc Space.spaceDetails.

Để tạo cuộc trò chuyện 1:1 giữa người dùng và ứng dụng Chat đang gọi, hãy đặt Space.spaceType thành DIRECT_MESSAGE và Space.singleUserBotDm thành true. Không đặt Space.displayName hoặc Space.spaceDetails.

Nếu không gian DIRECT_MESSAGE đã tồn tại, thì không gian đó sẽ được trả về thay vì tạo không gian mới.

string

Không bắt buộc. Giá trị nhận dạng duy nhất cho yêu cầu này. Bạn nên dùng UUID ngẫu nhiên. Việc chỉ định mã nhận dạng yêu cầu hiện có sẽ trả về không gian được tạo bằng mã nhận dạng đó thay vì tạo không gian mới. Việc chỉ định mã yêu cầu hiện có từ cùng một ứng dụng Chat với một người dùng đã xác thực khác sẽ trả về lỗi.

Membership

Không bắt buộc. Người dùng hoặc nhóm Google Chat mà bạn muốn mời tham gia không gian. Bỏ qua người dùng gọi vì họ được thêm tự động.

Chế độ này hiện cho phép sử dụng tối đa 20 thành viên (ngoài người gọi).

Đối với gói thành viên dành cho con người, trường Membership.member phải chứa user đã điền sẵn name (định dạng: users/{user}) và type được đặt thành User.Type.HUMAN. Bạn chỉ có thể thêm người dùng khi thiết lập không gian (tính năng thêm ứng dụng trong Chat chỉ được hỗ trợ khi thiết lập tin nhắn trực tiếp bằng ứng dụng gọi điện). Bạn cũng có thể thêm thành viên bằng cách sử dụng email của người dùng làm email đại diện cho {user}. Ví dụ: user.name có thể là users/[email protected]. Để mời người dùng Gmail hoặc người dùng từ các miền Google Workspace bên ngoài, bạn phải sử dụng email của người dùng cho {user}.

Đối với tư cách thành viên trong nhóm trên Google Groups, trường Membership.group_member phải chứa group có name được điền sẵn (định dạng groups/{group}). Bạn chỉ có thể thêm các nhóm trên Google Groups khi đặt Space.spaceType thành SPACE.

Không bắt buộc khi đặt Space.spaceType thành SPACE.

Bắt buộc khi đặt Space.spaceType thành GROUP_CHAT, cùng với ít nhất hai gói thành viên.

Bắt buộc khi đặt Space.spaceType thành DIRECT_MESSAGE với người dùng thực, cùng với đúng một gói thành viên.

Phải để trống khi tạo cuộc trò chuyện 1:1 giữa người dùng và ứng dụng Chat gọi (khi đặt Space.spaceType thành DIRECT_MESSAGE và Space.singleUserBotDm thành true).

int64

Mã của lệnh dấu gạch chéo đã được gọi ra.

User

Ứng dụng Chat có lệnh được gọi.

Type

Loại lệnh dấu gạch chéo.

string

Tên của lệnh dấu gạch chéo được gọi.

int64

Mã lệnh của lệnh dấu gạch chéo đã gọi.

bool

Cho biết lệnh dấu gạch chéo có dành cho hộp thoại hay không.

string

Giá trị nhận dạng. Tên tài nguyên của không gian.

Định dạng spaces/{space}

Trong đó {space} biểu thị mã nhận dạng do hệ thống chỉ định cho không gian. Bạn có thể lấy mã không gian bằng cách gọi phương thức spaces.list() hoặc từ URL của không gian. Ví dụ: nếu URL của không gian là https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA, thì mã không gian sẽ là AAAAAAAAA.

Type

Chỉ có đầu ra. Không dùng nữa: Thay vào đó, hãy sử dụng space_type. Loại không gian.

SpaceType

Không bắt buộc. Loại không gian. Bắt buộc khi tạo không gian hoặc cập nhật loại không gian. Chỉ có đầu ra cho các mục đích sử dụng khác.

bool

Không bắt buộc. Liệu không gian đó có phải là tin nhắn trực tiếp giữa một ứng dụng Chat và một người dùng hay không.

bool

Chỉ có đầu ra. Không dùng nữa: Chuyển sang dùng spaceThreadingState. Liệu tin nhắn có được sắp xếp theo chuỗi trong không gian này hay không.

string

Không bắt buộc. Tên hiển thị của không gian. Bắt buộc khi tạo không gian với spaceType là SPACE. Nếu bạn nhận được thông báo lỗi ALREADY_EXISTS khi tạo không gian hoặc cập nhật displayName, hãy thử một displayName khác. Một không gian hiện có trong tổ chức Google Workspace có thể đã sử dụng tên hiển thị này.

Đối với tin nhắn trực tiếp, trường này có thể trống.

Hỗ trợ tối đa 128 ký tự.

bool

Không bắt buộc. Không thể thay đổi. Không gian này có cho phép bất kỳ người dùng Google Chat nào làm thành viên hay không. Thông tin đầu vào khi tạo không gian trong một tổ chức Google Workspace. Bỏ qua trường này khi tạo không gian trong các điều kiện sau:

• Người dùng đã xác thực sử dụng tài khoản người dùng cá nhân (tài khoản người dùng không được quản lý). Theo mặc định, một không gian do tài khoản người dùng cá nhân tạo sẽ cho phép mọi người dùng Google Chat tham gia.

Đối với các không gian hiện có, trường này chỉ có đầu ra.

SpaceThreadingState

Chỉ có đầu ra. Trạng thái tạo chuỗi tin nhắn trong không gian Chat.

SpaceDetails

Không bắt buộc. Thông tin chi tiết về không gian, bao gồm nội dung mô tả và quy tắc.

HistoryState

Không bắt buộc. Trạng thái nhật ký tin nhắn của tin nhắn và chuỗi tin nhắn trong không gian này.

bool

Không bắt buộc. Liệu không gian này có được tạo trong Import Mode trong quá trình di chuyển dữ liệu sang Google Workspace hay không. Mặc dù không gian đang được nhập, người dùng sẽ không nhìn thấy chúng cho đến khi quá trình nhập hoàn tất.

Bạn cần xác thực người dùng để tạo không gian trong Import Mode.

Timestamp

Không bắt buộc. Không thể thay đổi. Thời gian tạo không gian đối với các không gian được tạo trong Chat. Trường này chỉ xuất, ngoại trừ khi được sử dụng trong không gian ở chế độ nhập.

Đối với không gian ở chế độ nhập, hãy đặt trường này thành dấu thời gian trước đây tại thời điểm không gian được tạo trong nguồn để giữ nguyên thời gian tạo ban đầu.

Chỉ được điền sẵn vào kết quả khi spaceType là GROUP_CHAT hoặc SPACE.

Timestamp

Chỉ có đầu ra. Dấu thời gian của tin nhắn cuối cùng trong không gian.

bool

Chỉ có đầu ra. Đối với không gian tin nhắn trực tiếp (DM) có ứng dụng Chat, liệu không gian đó có phải do quản trị viên Google Workspace tạo hay không. Quản trị viên có thể thay mặt người dùng trong tổ chức cài đặt và thiết lập tin nhắn trực tiếp bằng ứng dụng Chat.

Để hỗ trợ việc cài đặt ứng dụng quản trị viên, ứng dụng Chat của bạn phải có tính năng nhắn tin trực tiếp.

MembershipCount

Chỉ có đầu ra. Số lượng gói thành viên đã tham gia được nhóm theo loại thành viên. Được điền khi space_type là SPACE, DIRECT_MESSAGE hoặc GROUP_CHAT.

AccessSettings

Không bắt buộc. Chỉ định chế độ cài đặt quyền truy cập của không gian. Chỉ được điền khi space_type là SPACE.

string

Chỉ có đầu ra. URI để người dùng truy cập vào không gian.

string

Không bắt buộc. Không thể thay đổi. Mã khách hàng của miền của không gian. Chỉ bắt buộc khi tạo không gian có xác thực ứng dụng và SpaceType là SPACE, nếu không thì không được đặt.

Ở định dạng customers/{customer}, trong đó customer là id trong [Tài nguyên khách hàng của SDK dành cho quản trị viên]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Ứng dụng riêng tư cũng có thể sử dụng bí danh customers/my_customer để tạo không gian trong cùng một tổ chức Google Workspace với ứng dụng.

Đối với tin nhắn trực tiếp, trường này không được điền sẵn.

PredefinedPermissionSettings

Không bắt buộc. Chỉ nhập. Chế độ cài đặt quyền cho không gian được xác định trước, chỉ nhập khi tạo không gian. Nếu bạn không đặt trường này, hệ thống sẽ tạo một không gian cộng tác. Sau khi bạn tạo không gian, các chế độ cài đặt sẽ được điền sẵn trong trường PermissionSettings.

PermissionSettings

Không bắt buộc. Chế độ cài đặt quyền đối với không gian cho các không gian hiện có. Dữ liệu đầu vào để cập nhật các chế độ cài đặt chính xác về quyền đối với không gian, nơi thay thế các chế độ cài đặt quyền hiện có. Kết quả sẽ liệt kê các chế độ cài đặt quyền hiện tại.

AccessState

Chỉ có đầu ra. Cho biết trạng thái truy cập của không gian.

string

Không bắt buộc. Tên tài nguyên của đối tượng mục tiêu có thể khám phá không gian, tham gia không gian và xem trước tin nhắn trong không gian. Nếu bạn không đặt chế độ này, thì chỉ những người dùng hoặc Nhóm Google được mời riêng lẻ hoặc được thêm vào không gian mới có thể truy cập vào không gian đó. Để biết thông tin chi tiết, hãy xem bài viết Để đối tượng mục tiêu tìm thấy không gian của bạn.

Định dạng audiences/{audience}

Để sử dụng đối tượng mục tiêu mặc định cho tổ chức Google Workspace, hãy đặt thành audiences/default.

Việc đọc đối tượng mục tiêu hỗ trợ:

• Xác thực người dùng

• Xác thực ứng dụng bằng quyền phê duyệt của quản trị viên với phạm vi chat.app.spaces trong

Trường này không được điền khi sử dụng phạm vi chat.bot với quy trình xác thực ứng dụng.

Bạn cần xác thực người dùng để đặt đối tượng mục tiêu.

int32

Chỉ có đầu ra. Số người dùng đã trực tiếp tham gia không gian, không tính những người dùng tham gia bằng cách có tư cách thành viên trong một nhóm đã tham gia.

int32

Chỉ có đầu ra. Số lượng tất cả các nhóm đã trực tiếp tham gia không gian.

bool

Không bắt buộc. Việc người quản lý không gian có quyền này hay không.

bool

Không bắt buộc. Liệu các thành viên không phải là người quản lý có quyền này hay không.

PermissionSetting

Không bắt buộc. Chế độ cài đặt để quản lý thành viên và nhóm trong một không gian.

PermissionSetting

Không bắt buộc. Chế độ cài đặt để cập nhật tên, hình đại diện, nội dung mô tả và nguyên tắc của không gian.

PermissionSetting

Không bắt buộc. Chế độ cài đặt để bật và tắt nhật ký của không gian.

PermissionSetting

Không bắt buộc. Chế độ cài đặt để sử dụng @all trong không gian.

PermissionSetting

Không bắt buộc. Chế độ cài đặt để quản lý ứng dụng trong một không gian.

PermissionSetting

Không bắt buộc. Chế độ cài đặt để quản lý webhook trong không gian.

PermissionSetting

Chỉ có đầu ra. Chế độ cài đặt để đăng tin nhắn trong không gian.

PermissionSetting

Không bắt buộc. Chế độ cài đặt để trả lời tin nhắn trong không gian.

string

Không bắt buộc. Nội dung mô tả về không gian. Ví dụ: mô tả chủ đề thảo luận, mục đích chức năng hoặc người tham gia của không gian.

Hỗ trợ tối đa 150 ký tự.

string

Không bắt buộc. Quy tắc, kỳ vọng và quy tắc ứng xử của không gian.

Hỗ trợ tối đa 5.000 ký tự.

SpaceUpdatedEventData

Danh sách các không gian đã cập nhật.

string

Tên tài nguyên của sự kiện trong không gian.

Định dạng spaces/{space}/spaceEvents/{spaceEvent}

Timestamp

Thời gian khi sự kiện xảy ra.

string

Loại sự kiện trong không gian. Mỗi loại sự kiện đều có một phiên bản theo lô, đại diện cho nhiều thực thể của loại sự kiện xảy ra trong một khoảng thời gian ngắn. Đối với các yêu cầu spaceEvents.list(), hãy bỏ qua các loại sự kiện theo lô trong bộ lọc truy vấn. Theo mặc định, máy chủ trả về cả loại sự kiện và phiên bản hàng loạt của sự kiện đó.

Các loại sự kiện được hỗ trợ cho tin nhắn:

• Tin nhắn mới: google.workspace.chat.message.v1.created
• Thông báo đã cập nhật: google.workspace.chat.message.v1.updated
• Tin nhắn đã xoá: google.workspace.chat.message.v1.deleted
• Nhiều tin nhắn mới: google.workspace.chat.message.v1.batchCreated
• Nhiều thông báo cập nhật: google.workspace.chat.message.v1.batchUpdated
• Nhiều thư đã xoá: google.workspace.chat.message.v1.batchDeleted

Các loại sự kiện được hỗ trợ cho gói thành viên:

• Gói hội viên mới: google.workspace.chat.membership.v1.created
• Đã cập nhật gói thành viên: google.workspace.chat.membership.v1.updated
• Đã xoá gói thành viên: google.workspace.chat.membership.v1.deleted
• Nhiều gói thành viên mới: google.workspace.chat.membership.v1.batchCreated
• Nhiều gói thành viên đã cập nhật: google.workspace.chat.membership.v1.batchUpdated
• Nhiều gói thành viên đã bị xoá: google.workspace.chat.membership.v1.batchDeleted

Các loại sự kiện được hỗ trợ cho biểu tượng cảm xúc:

• Phản ứng mới: google.workspace.chat.reaction.v1.created
• Biểu tượng cảm xúc đã xoá: google.workspace.chat.reaction.v1.deleted
• Nhiều lượt thể hiện cảm xúc mới: google.workspace.chat.reaction.v1.batchCreated
• Nhiều biểu tượng cảm xúc đã bị xoá: google.workspace.chat.reaction.v1.batchDeleted

Các loại sự kiện được hỗ trợ về không gian:

• Không gian đã cập nhật: google.workspace.chat.space.v1.updated
• Nhiều nội dung cập nhật về không gian: google.workspace.chat.space.v1.batchUpdated

MessageCreatedEventData

Tải trọng sự kiện cho một tin nhắn mới.

Loại sự kiện: google.workspace.chat.message.v1.created

MessageUpdatedEventData

Trọng tải sự kiện cho thông báo đã cập nhật.

Loại sự kiện: google.workspace.chat.message.v1.updated

MessageDeletedEventData

Trọng tải sự kiện cho một thư đã xoá.

Loại sự kiện: google.workspace.chat.message.v1.deleted

MessageBatchCreatedEventData

Trọng tải sự kiện cho nhiều thông báo mới.

Loại sự kiện: google.workspace.chat.message.v1.batchCreated

MessageBatchUpdatedEventData

Tải trọng sự kiện cho nhiều thông báo được cập nhật.

Loại sự kiện: google.workspace.chat.message.v1.batchUpdated

MessageBatchDeletedEventData

Trọng tải sự kiện cho nhiều thư đã xoá.

Loại sự kiện: google.workspace.chat.message.v1.batchDeleted

SpaceUpdatedEventData

Tải trọng sự kiện cho một lần cập nhật không gian.

Loại sự kiện: google.workspace.chat.space.v1.updated

SpaceBatchUpdatedEventData

Trọng tải sự kiện cho nhiều nội dung cập nhật đối với một không gian.

Loại sự kiện: google.workspace.chat.space.v1.batchUpdated

MembershipCreatedEventData

Trọng tải sự kiện cho gói thành viên mới.

Loại sự kiện: google.workspace.chat.membership.v1.created

MembershipUpdatedEventData

Tải trọng sự kiện cho một gói thành viên đã cập nhật.

Loại sự kiện: google.workspace.chat.membership.v1.updated

MembershipDeletedEventData

Tải trọng sự kiện cho một gói thành viên đã xoá.

Loại sự kiện: google.workspace.chat.membership.v1.deleted

MembershipBatchCreatedEventData

Trọng tải sự kiện cho nhiều gói thành viên mới.

Loại sự kiện: google.workspace.chat.membership.v1.batchCreated

MembershipBatchUpdatedEventData

Tải trọng sự kiện cho nhiều gói thành viên đã cập nhật.

Loại sự kiện: google.workspace.chat.membership.v1.batchUpdated

MembershipBatchDeletedEventData

Trọng tải sự kiện cho nhiều gói thành viên đã bị xoá.

Loại sự kiện: google.workspace.chat.membership.v1.batchDeleted

ReactionCreatedEventData

Tải trọng sự kiện cho một phản ứng mới.

Loại sự kiện: google.workspace.chat.reaction.v1.created

ReactionDeletedEventData

Trọng tải sự kiện cho một lượt thể hiện cảm xúc đã bị xoá.

Loại sự kiện: google.workspace.chat.reaction.v1.deleted

ReactionBatchCreatedEventData

Tải trọng sự kiện cho nhiều lượt thể hiện cảm xúc mới.

Loại sự kiện: google.workspace.chat.reaction.v1.batchCreated

ReactionBatchDeletedEventData

Trọng tải sự kiện cho nhiều lượt thể hiện cảm xúc đã xoá.

Loại sự kiện: google.workspace.chat.reaction.v1.batchDeleted

string

Giá trị nhận dạng. Tên tài nguyên của chế độ cài đặt thông báo của không gian. Định dạng: users/{user}/spaces/{space}/spaceNotificationSetting.

NotificationSetting

Chế độ cài đặt thông báo.

MuteSetting

Chế độ cài đặt tắt thông báo của không gian.

string

Tên tài nguyên của trạng thái đọc không gian.

Định dạng users/{user}/spaces/{space}/spaceReadState

Timestamp

Không bắt buộc. Thời điểm cập nhật trạng thái đọc không gian của người dùng. Thông thường, giá trị này tương ứng với dấu thời gian của thư đã đọc gần đây nhất hoặc dấu thời gian do người dùng chỉ định để đánh dấu vị trí đọc gần đây nhất trong một không gian.

Space

Không gian đã cập nhật.

string

Giá trị nhận dạng. Tên tài nguyên của luồng.

Ví dụ: spaces/{space}/threads/{thread}

string

Không bắt buộc. Dữ liệu đầu vào để tạo hoặc cập nhật luồng. Nếu không, chỉ có đầu ra. Mã nhận dạng của chuỗi. Hỗ trợ tối đa 4.000 ký tự.

Đây là mã nhận dạng duy nhất của ứng dụng Chat đặt ra mã này. Ví dụ: nếu nhiều ứng dụng Chat tạo một tin nhắn bằng cùng một khoá chuỗi, thì các tin nhắn đó sẽ được đăng trong các chuỗi khác nhau. Để trả lời trong một chuỗi tin nhắn do một người hoặc một ứng dụng Chat khác tạo, hãy chỉ định trường name của chuỗi tin nhắn.

string

Tên tài nguyên của trạng thái đọc luồng.

Định dạng users/{user}/spaces/{space}/threads/{thread}/threadReadState

Timestamp

Thời điểm cập nhật trạng thái đọc luồng của người dùng. Thông thường, giá trị này tương ứng với dấu thời gian của tin nhắn đã đọc gần đây nhất trong một chuỗi tin nhắn.

Membership

Bắt buộc. Gói thành viên cần cập nhật. Chỉ những trường do update_mask chỉ định mới được cập nhật.

FieldMask

Bắt buộc. Đường dẫn trường cần cập nhật. Phân tách nhiều giá trị bằng dấu phẩy hoặc sử dụng * để cập nhật tất cả đường dẫn trường.

Các đường dẫn trường hiện được hỗ trợ:

• role

bool

Không bắt buộc. Khi true, phương thức này sẽ chạy bằng các đặc quyền quản trị viên Google Workspace của người dùng.

Người dùng gọi phải là quản trị viên Google Workspace có đặc quyền quản lý cuộc trò chuyện và cuộc trò chuyện trong không gian.

Yêu cầu phạm vi OAuth 2.0 chat.admin.memberships.

Message

Bắt buộc. Tin nhắn có các trường đã cập nhật.

FieldMask

Bắt buộc. Đường dẫn trường cần cập nhật. Phân tách nhiều giá trị bằng dấu phẩy hoặc sử dụng * để cập nhật tất cả đường dẫn trường.

Các đường dẫn trường hiện được hỗ trợ:

• text

• attachment

• cards (Yêu cầu xác thực ứng dụng.)

• cards_v2 (Cần phải xác thực ứng dụng.)

• accessory_widgets (Yêu cầu xác thực ứng dụng.)

bool

Không bắt buộc. Nếu không tìm thấy true và thông báo đó, thì một thông báo mới sẽ được tạo và updateMask sẽ bị bỏ qua. Mã thông báo được chỉ định phải là do ứng dụng khách chỉ định, nếu không yêu cầu sẽ không thành công.

SpaceNotificationSetting

Bắt buộc. Tên tài nguyên cho chế độ cài đặt thông báo của không gian phải được điền ở dạng users/{user}/spaces/{space}/spaceNotificationSetting. Chỉ những trường do update_mask chỉ định mới được cập nhật.

FieldMask

Bắt buộc. Đường dẫn trường được hỗ trợ: – notification_setting – mute_setting

SpaceReadState

Bắt buộc. Trạng thái đọc không gian và các trường cần cập nhật.

Chỉ hỗ trợ cập nhật trạng thái đọc cho người dùng gọi.

Để tham chiếu đến người dùng gọi, hãy đặt một trong những giá trị sau:

• Bí danh me. Ví dụ: users/me/spaces/{space}/spaceReadState.

• Địa chỉ email Workspace của họ. Ví dụ: users/[email protected]/spaces/{space}/spaceReadState.

• Mã nhận dạng người dùng của họ. Ví dụ: users/123456789/spaces/{space}/spaceReadState.

Định dạng: users/{user}/spaces/{space}/spaceReadState

FieldMask

Bắt buộc. Đường dẫn trường cần cập nhật. Các đường dẫn trường hiện được hỗ trợ:

• last_read_time

Khi last_read_time diễn ra trước thời gian tạo thông báo mới nhất, không gian sẽ xuất hiện dưới dạng chưa đọc trong giao diện người dùng.

Để đánh dấu không gian là đã đọc, hãy đặt last_read_time thành bất kỳ giá trị nào muộn hơn (lớn hơn) so với thời gian tạo thông báo gần đây nhất. last_read_time được buộc phải khớp với thời gian tạo tin nhắn gần đây nhất. Xin lưu ý rằng trạng thái đã đọc của không gian chỉ ảnh hưởng đến trạng thái đã đọc của những tin nhắn xuất hiện trong cuộc trò chuyện cấp cao nhất của không gian. Dấu thời gian này không ảnh hưởng đến các thư trả lời trong chuỗi thư mà thay vào đó là dựa vào trạng thái đọc của chuỗi thư.

Space

Bắt buộc. Không gian có các trường cần cập nhật. Space.name phải được điền theo dạng spaces/{space}. Chỉ những trường do update_mask chỉ định mới được cập nhật.

FieldMask

Bắt buộc. Các đường dẫn trường đã cập nhật, được phân tách bằng dấu phẩy nếu có nhiều đường dẫn.

Bạn có thể cập nhật các trường sau đây cho một không gian:

space_details: Cập nhật nội dung mô tả của không gian. Hỗ trợ tối đa 150 ký tự.

display_name: Chỉ hỗ trợ cập nhật tên hiển thị cho những không gian có trường spaceType là SPACE. Nếu bạn nhận được thông báo lỗi ALREADY_EXISTS, hãy thử một giá trị khác. Một không gian hiện có trong tổ chức Google Workspace có thể đã sử dụng tên hiển thị này.

space_type: Chỉ hỗ trợ thay đổi loại không gian GROUP_CHAT thành SPACE. Thêm display_name cùng với space_type vào mặt nạ cập nhật và đảm bảo rằng không gian được chỉ định có tên hiển thị không trống và loại không gian SPACE. Bạn không bắt buộc phải thêm mặt nạ space_type và loại SPACE vào không gian được chỉ định khi cập nhật tên hiển thị nếu không gian hiện có đã có loại SPACE. Việc cố gắng cập nhật loại không gian theo cách khác sẽ dẫn đến lỗi đối số không hợp lệ. space_type không được hỗ trợ với useAdminAccess.

space_history_state: Cập nhật chế độ cài đặt nhật ký của không gian bằng cách bật hoặc tắt nhật ký cho không gian. Chỉ được hỗ trợ nếu chế độ cài đặt nhật ký được bật cho tổ chức Google Workspace. Để cập nhật trạng thái nhật ký không gian, bạn phải bỏ qua tất cả các mặt nạ trường khác trong yêu cầu. space_history_state không được hỗ trợ với useAdminAccess.

access_settings.audience: Cập nhật chế độ cài đặt quyền truy cập cho những người có thể khám phá không gian, tham gia không gian và xem trước tin nhắn trong không gian có tên, trong đó trường spaceType là SPACE. Nếu không gian hiện tại có đối tượng mục tiêu, bạn có thể xoá đối tượng đó và hạn chế quyền truy cập vào không gian bằng cách bỏ qua giá trị cho mặt nạ trường này. Để cập nhật chế độ cài đặt quyền truy cập cho một không gian, người dùng xác thực phải là người quản lý không gian và bỏ qua tất cả các mặt nạ trường khác trong yêu cầu của bạn. Bạn không thể cập nhật trường này nếu không gian đang ở chế độ nhập. Để tìm hiểu thêm, hãy xem bài viết Để người dùng cụ thể tìm thấy không gian. access_settings.audience không được hỗ trợ với useAdminAccess.

permission_settings: Hỗ trợ thay đổi chế độ cài đặt quyền của một không gian. Khi cập nhật các chế độ cài đặt quyền, bạn chỉ có thể chỉ định mặt nạ trường permissionSettings; bạn không thể cập nhật các mặt nạ trường khác cùng một lúc. permissionSettings không được hỗ trợ với useAdminAccess. Các mặt nạ trường được hỗ trợ bao gồm:

• permission_settings.manageMembersAndGroups
• permission_settings.modifySpaceDetails
• permission_settings.toggleHistory
• permission_settings.useAtMentionAll
• permission_settings.manageApps
• permission_settings.manageWebhooks
• permission_settings.replyMessages

bool

Không bắt buộc. Khi true, phương thức này sẽ chạy bằng đặc quyền của quản trị viên Google Workspace của người dùng.

Người dùng gọi phải là quản trị viên Google Workspace có đặc quyền quản lý cuộc trò chuyện và cuộc trò chuyện trong không gian.

Yêu cầu chat.admin.spaces phạm vi OAuth 2.0.

Một số giá trị FieldMask không được hỗ trợ khi sử dụng quyền quản trị. Để biết thông tin chi tiết, hãy xem nội dung mô tả về update_mask.

string

Tên tài nguyên của Google Chat user.

Định dạng: users/{user}. Bạn có thể dùng users/app làm bí danh cho người dùng bot của ứng dụng gọi.

Đối với human users, {user} giống với giá trị nhận dạng người dùng:

• id cho Người trong API People. Ví dụ: users/123456789 trong Chat API đại diện cho cùng một người với mã hồ sơ người dùng 123456789 trong People API.

• id cho một người dùng trong API Thư mục SDK dành cho quản trị viên.

• địa chỉ email của người dùng có thể được dùng làm email đại diện cho {user} trong các yêu cầu API. Ví dụ: nếu mã hồ sơ Người trong People API cho [email protected] là 123456789, thì bạn có thể sử dụng users/[email protected] làm bí danh để tham chiếu đến users/123456789. API sẽ chỉ trả về tên tài nguyên chuẩn (ví dụ: users/123456789).

string

Chỉ có đầu ra. Tên hiển thị của người dùng.

string

Giá trị nhận dạng duy nhất của miền Google Workspace của người dùng.

Type

Kiểu người dùng.

bool

Chỉ có đầu ra. Khi true, người dùng sẽ bị xoá hoặc hồ sơ của họ sẽ không hiển thị.

User

Người dùng được đề cập.

Type

Loại lượt đề cập đến người dùng.

Button

Danh sách các nút. Nút cũng là oneof data và bạn chỉ nên đặt một trong các trường này.

TextParagraph

Hiển thị một đoạn văn bản trong tiện ích này.

Image

Hiển thị hình ảnh trong tiện ích này.

KeyValue

Hiển thị một mục giá trị khoá trong tiện ích này.

TextButton

Một nút có văn bản và hành động onclick.

ImageButton

Một nút có hình ảnh và thao tác onclick.

string

Tên phương thức được dùng để xác định phần nào của biểu mẫu đã kích hoạt việc gửi biểu mẫu. Thông tin này được phản hồi lại cho ứng dụng Chat trong sự kiện nhấp vào thẻ. Bạn có thể sử dụng cùng một tên phương thức cho một số phần tử kích hoạt một hành vi phổ biến.

ActionParameter

Danh sách thông số hành động.

string

Tên của thông số cho tập lệnh hành động.

string

Giá trị của thông số.

string

URL của hình ảnh.

OnClick

Thao tác onclick.

double

Tỷ lệ khung hình của hình ảnh này (chiều rộng và chiều cao). Trường này cho phép bạn đặt trước chiều cao phù hợp cho hình ảnh trong khi chờ hình ảnh tải. Chế độ này không nhằm ghi đè tỷ lệ khung hình tích hợp sẵn của hình ảnh. Nếu bạn không đặt, máy chủ sẽ điền giá trị này bằng cách tìm nạp trước hình ảnh.

OnClick

Thao tác onclick.