Đối tượng sự kiện

Trang này trình bày cấu trúc của các đối tượng sự kiện Tiện ích bổ sung của Google Workspace.

Đối tượng sự kiện là các cấu trúc JSON được tự động tạo và truyền dưới dạng thông số để kích hoạt hoặc gọi lại các hàm khi người dùng tương tác với một tiện ích bổ sung. Đối tượng sự kiện truyền thông tin phía máy khách về ứng dụng lưu trữ và ngữ cảnh hiện tại cho hàm gọi lại phía máy chủ của tiện ích bổ sung.

Tiện ích bổ sung của Google Workspace sử dụng đối tượng sự kiện ở những vị trí sau:

  • Trình kích hoạt trang chủ. Mọi hàm homepageTrigger mà bạn xác định sẽ tự động chuyển một đối tượng sự kiện khi hàm kích hoạt trang chủ kích hoạt. Bạn có thể sử dụng đối tượng này trong hàm kích hoạt trang chủ để xác định ứng dụng lưu trữ đang hoạt động, nền tảng của ứng dụng, ngôn ngữ của người dùng và các thông tin khác.

    Các đối tượng sự kiện được tạo khi trang chủ kích hoạt sự kiện không chứa tất cả các trường trong hai trường hợp còn lại; các trường liên quan đến tiện ích và thông tin theo ngữ cảnh sẽ bị bỏ qua.

  • Trình kích hoạt theo ngữ cảnh. Mỗi ứng dụng lưu trữ cung cấp một tập hợp các trình kích hoạt theo ngữ cảnh khác nhau sẽ kích hoạt khi người dùng nhập một ngữ cảnh cụ thể. Ví dụ:

    • Gmail cung cấp trình kích hoạt theo ngữ cảnh khi người dùng mở thư và trình kích hoạt khác khi người dùng kết hợp thư.
    • Lịch Google cung cấp trình kích hoạt theo ngữ cảnh khi người dùng mở một sự kiện.
    • Google Drive cung cấp trình kích hoạt theo ngữ cảnh khi người dùng chọn tệp trên Drive.

    Khi một trình kích hoạt theo ngữ cảnh kích hoạt, ứng dụng lưu trữ sẽ gọi runFunction tương ứng được liệt kê trong tệp kê khai của tiện ích bổ sung và truyền đối tượng đó dưới dạng thông số. Các đối tượng sự kiện được tạo khi trình kích hoạt ngữ cảnh kích hoạt chứa tất cả các trường có trong đối tượng sự kiện của trang chủ, cùng với các trường chứa thông tin theo ngữ cảnh.

  • Thao tác tiện ích. Các đối tượng sự kiện cũng dùng để cung cấp tính năng tương tác với tiện ích, sử dụng cùng một mô hình hành động mà các tiện ích bổ sung trong Gmail sử dụng. Tiện ích bổ sung của Google Workspace sử dụng tất cả chức năng của trình xử lý tiện ích, các đối tượng Action và phản hồi hành động. Tuy nhiên, trong Tiện ích bổ sung của Google Workspace, đối tượng sự kiện hành động bao gồm nhiều thông tin hơn mà một hàm gọi lại có thể thao tác.

    Các đối tượng sự kiện được tạo ra từ các hành động của tiện ích chứa tất cả các trường có trong các đối tượng sự kiện kích hoạt theo ngữ cảnh, cùng với các trường chứa thông tin tiện ích.

  • Xem trước trình kích hoạt đường liên kết (Bản dùng thử cho nhà phát triển). Trong Google Tài liệu, bạn có thể định cấu hình bản xem trước đường liên kết cho các dịch vụ bên thứ ba dựa trên mẫu URL cụ thể. Khi người dùng tương tác với một đường liên kết đáp ứng mẫu, previewLinkTrigger sẽ kích hoạt và một đối tượng sự kiện chứa đường liên kết đó sẽ được chuyển đến hàm gọi lại của trình kích hoạt. Tiện ích bổ sung của bạn có thể sử dụng đối tượng sự kiện này để tạo một khối và thẻ thông minh hiển thị thông tin về đường liên kết trong ứng dụng lưu trữ. Bạn cũng có thể tạo các thao tác với tiện ích để cho phép người dùng tương tác với thẻ xem trước và nội dung của thẻ.

Cấu trúc của đối tượng sự kiện

Bảng sau đây mô tả cấu trúc cấp cao nhất của các đối tượng sự kiện Tiện ích bổ sung của Google Workspace. Cấu trúc của đối tượng sự kiện bao gồm trường cấp cao nhất commonEventObject dành cho thông tin độc lập với máy chủ. Mỗi đối tượng sự kiện cũng có thể có một trong các trường cấp cao nhất dành riêng cho máy chủ, được xác định bởi ứng dụng lưu trữ đang hoạt động: gmailEventObject, calendarEventObject hoặc driveEventObject.

Để tương thích ngược, các đối tượng sự kiện Tiện ích bổ sung của Google Workspace cũng bao gồm tất cả các trường ban đầu dùng trong các đối tượng sự kiện hành động trên tiện ích bổ sung của Gmail. Các trường này được liệt kê trong bảng dưới đây trong phần "Các trường bổ sung gốc của Gmail"; thông tin trong các trường này được mô phỏng trong cấu trúc đối tượng mới.

Đối tượng sự kiện
eventObject.commonEventObject Common fields object
Một đối tượng chứa thông tin chung cho tất cả các đối tượng sự kiện, bất kể ứng dụng lưu trữ là gì.
eventObject.calendar Calendar event object
Chỉ tham gia nếu người tổ chức cuộc gọi là Lịch Google. Một đối tượng chứa thông tin về lịch và sự kiện.
eventObject.drive Drive event object
Chỉ hiển thị nếu người tổ chức cuộc gọi là Google Drive. Một đối tượng chứa thông tin trên Drive.
eventObject.gmail Gmail event object
Chỉ hiển thị nếu người tổ chức cuộc gọi là Gmail. Đối tượng chứa thông tin Gmail.
eventObject.docs Docs event object
Chỉ hiển thị nếu người tổ chức cuộc gọi là Google Tài liệu. Một đối tượng chứa thông tin trên Tài liệu.
eventObject.sheets Sheets event object
Chỉ hiển thị nếu người tổ chức cuộc gọi là Google Trang tính. Một đối tượng chứa thông tin trên Trang tính.
eventObject.slides Slides event object
Chỉ hiển thị nếu người tổ chức cuộc gọi là Google Trang trình bày. Một đối tượng chứa thông tin trên Trang trình bày.
Trường tiện ích bổ sung gốc của Gmail
eventObject.messageMetadata.accessToken string
Không dùng nữa. Mã truy cập. Bạn có thể sử dụng quy trình này để bật quyền truy cập vào dữ liệu người dùng bằng cách sử dụng các phạm vi tiện ích bổ sung tạm thời của Gmail.

Đối với các tiện ích bổ sung của Google Workspace, hãy tìm thông tin này trong trường eventObject.gmail.accessToken.

eventObject.messageMetadata.messageId string
Không dùng nữa. Mã thư của chuỗi mở trong giao diện người dùng Gmail.

Đối với các tiện ích bổ sung của Google Workspace, hãy tìm thông tin này trong trường eventObject.gmail.messageId.

eventObject.clientPlatform string
Không dùng nữa. Cho biết nguồn gốc của sự kiện (web, iOS hoặc Android).

Đối với các tiện ích bổ sung của Google Workspace, hãy tìm thông tin này trong trường eventObject.commonEventObject.platform.

eventObject.formInput object
Không dùng nữa. Bản đồ các giá trị hiện tại của tất cả tiện ích biểu mẫu trong thẻ, được giới hạn ở một giá trị cho mỗi tiện ích. Khoá là mã nhận dạng chuỗi liên kết với tiện ích và giá trị là chuỗi. Đối tượng sự kiện cung cấp formInput để thuận tiện khi bạn cần đọc dữ liệu từ nhiều tiện ích có các giá trị số ít dự kiến, chẳng hạn như các đầu vào văn bản và nút chuyển. Đối với các tiện ích nhiều giá trị như hộp đánh dấu, bạn có thể đọc từng giá trị trong formInputs.

Đối với các tiện ích bổ sung của Google Workspace, hãy tìm thông tin này trong trường eventObject.commonEventObject.formInputs. Các tiện ích có một giá trị được thể hiện dưới dạng các mảng bằng một phần tử duy nhất.

eventObject.formInputs object
Không dùng nữa. Bản đồ các giá trị hiện tại của tiện ích trong thẻ, được hiển thị dưới dạng danh sách các chuỗi. Các khoá là mã nhận dạng chuỗi liên kết với tiện ích này. Đối với các tiện ích một giá trị, giá trị này được trình bày trong một mảng một phần tử. Đối với các tiện ích nhiều giá trị (chẳng hạn như các nhóm hộp đánh dấu), tất cả giá trị sẽ được trình bày trong một danh sách.

Đối với các tiện ích bổ sung của Google Workspace, hãy tìm thông tin này trong trường eventObject.commonEventObject.formInputs.

eventObject.parameters object
Không dùng nữa. Bản đồ về mọi thông số bổ sung mà bạn cung cấp cho Action bằng cách sử dụng Action.setParameters(). Khoá và giá trị của bản đồ là các chuỗi.

Đối với các tiện ích bổ sung của Google Workspace, hãy tìm thông tin này trong trường eventObject.commonEventObject.parameters.

eventObject.userCountry string
Theo mặc định, tính năng này không được dùng nữa và bị tắt. Mã gồm hai chữ cái cho biết quốc gia hoặc khu vực của người dùng. Đây cũng có thể là mã quốc gia dạng số UN M49.

Đối với các tiện ích bổ sung của Google Workspace, hãy tìm thông tin này trong trường eventObject.commonEventObject.userLocale.

eventObject.userLocale string
Theo mặc định, tính năng này không được dùng nữa và bị tắt. Mã gồm 2 chữ cái theo ISO 639 cho biết ngôn ngữ của người dùng. Vui lòng xem phần Truy cập vào múi giờ và ngôn ngữ của người dùng để biết thêm thông tin.

Đối với các tiện ích bổ sung của Google Workspace, hãy tìm thông tin này trong trường eventObject.commonEventObject.userLocale.

eventObject.userTimezone.id string
Theo mặc định, tính năng này không được dùng nữa và bị tắt. Giá trị nhận dạng múi giờ theo múi giờ của người dùng. Ví dụ: America/New_York, Europe/Vienna và Asia/Seoul. Vui lòng xem phần Truy cập vào múi giờ và ngôn ngữ của người dùng để biết thêm thông tin chi tiết.

Đối với các tiện ích bổ sung của Google Workspace, hãy tìm thông tin này trong trường eventObject.commonEventObject.timeZone.id.

eventObject.userTimezone.offset string
Theo mặc định, tính năng này không được dùng nữa và bị tắt. Chênh lệch thời gian từ Giờ phối hợp quốc tế (UTC) múi giờ của người dùng, được tính bằng mili giây. Vui lòng xem phần Truy cập vào múi giờ và ngôn ngữ của người dùng để biết thêm thông tin chi tiết.

Đối với các tiện ích bổ sung của Google Workspace, hãy tìm thông tin này trong trường eventObject.commonEventObject.timeZone.offset.

Đối tượng sự kiện phổ biến

Đối tượng sự kiện phổ biến là một phần của đối tượng sự kiện tổng thể mang thông tin chung độc lập với máy chủ đến tiện ích bổ sung từ ứng dụng của người dùng. Thông tin này bao gồm thông tin chi tiết như ngôn ngữ của người dùng, ứng dụng lưu trữ và nền tảng.

Ngoài trình kích hoạt trên trang chủ và ngữ cảnh, tiện ích bổ sung tạo và truyền đối tượng sự kiện đến các hàm gọi lại hành động khi người dùng tương tác với các tiện ích. Hàm callback của tiện ích bổ sung có thể truy vấn đối tượng sự kiện phổ biến để xác định nội dung của các tiện ích đang mở trong ứng dụng khách của người dùng. Ví dụ: Tiện ích bổ sung của bạn có thể định vị văn bản mà người dùng đã nhập vào tiện ích TextInput trong đối tượng eventObject.commentEventObject.formInputs.

Các trường đối tượng sự kiện phổ biến
commonEventObject.platform string
Cho biết nguồn gốc của sự kiện (`WEB`, `IOS` hoặc `ANDROID`).
commonEventObject.formInputs object
Một bản đồ chứa các giá trị hiện tại của các tiện ích trong thẻ hiển thị. Khoá bản đồ là các mã nhận dạng chuỗi được gán với mỗi tiện ích và mỗi giá trị là một đối tượng trình bao bọc khác có một khoá "". Cấu trúc của đối tượng giá trị bản đồ phụ thuộc vào loại tiện ích:
  • Các tiện ích đơn giá trị (ví dụ: hộp văn bản): danh sách các chuỗi (chỉ một phần tử).

    Ví dụ: đối với một tiện ích nhập văn bản có employeeName là mã nhận dạng, hãy truy cập vào giá trị nhập văn bản đó bằng: e.commonEventObject.formInputs.employeeName[""].stringInputs.value[0].

  • Danh sách chuỗi tiện ích có nhiều giá trị (ví dụ: nhóm hộp đánh dấu):

    Ví dụ: đối với một tiện ích nhiều giá trị có participants là mã nhận dạng, hãy truy cập vào mảng giá trị có: e.commonEventObject.formInputs.participants[""].stringInputs.value.

  • A date-time picker: một DateTimeInput object.

    Ví dụ: Đối với bộ chọn có mã nhận dạng là myDTPicker, hãy truy cập vào đối tượng DateTimeInput bằng cách sử dụng e.commonEventObject.formInputs.myDTPicker[""].dateTimeInput.

  • A date-only picker: một DateInput object.

    Ví dụ: Đối với bộ chọn có mã nhận dạng là myDatePicker, hãy truy cập vào đối tượng DateInput bằng cách sử dụng e.commonEventObject.formInputs.myDatePicker[""].dateInput.

  • A time-only picker: một TimeInput object.

    Ví dụ: Đối với bộ chọn có mã nhận dạng là myTimePicker, hãy truy cập vào đối tượng TimeInput bằng cách sử dụng e.commonEventObject.formInputs.myTimePicker[""].timeInput.
commonEventObject.hostApp string
Cho biết ứng dụng lưu trữ nơi tiện ích bổ sung đang hoạt động khi đối tượng sự kiện được tạo. Có thể là những giá trị sau:
  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
commonEventObject.parameters object
Mọi thông số bổ sung mà bạn cung cấp cho Action bằng Action.setParameters().
commonEventObject.userLocale string
Tắt theo mặc định. Giá trị nhận dạng ngôn ngữ và quốc gia/khu vực của người dùng ở định dạng mã quốc gia/khu vực ISO 639-ISO 3166. Ví dụ: en-US.

Để bật trường này, bạn phải đặt addOns.common.useLocaleFromApp thành true trong tệp kê khai của tiện ích bổ sung. Danh sách phạm vi của tiện ích bổ sung cũng phải bao gồm https://www.googleapis.com/auth/script.locale. Xem phần Truy cập vào múi giờ và ngôn ngữ của người dùng để biết thêm chi tiết.

commonEventObject.timeZone string
Tắt theo mặc định. Mã múi giờ và độ lệch. Để bật trường này, bạn phải đặt addOns.common.useLocaleFromApp thành true trong tệp kê khai của tiện ích bổ sung. Danh sách phạm vi của tiện ích bổ sung cũng phải bao gồm https://www.googleapis.com/auth/script.locale. Xem phần Truy cập vào múi giờ và ngôn ngữ của người dùng để biết thêm chi tiết.
commonEventObject.timeZone.id string
giá trị nhận dạng múi giờ của múi giờ của người dùng. Ví dụ: America/New_York, Europe/Vienna và Asia/Seoul. Để bật trường này, bạn phải đặt addOns.common.useLocaleFromApp thành true trong tệp kê khai của tiện ích bổ sung. Danh sách phạm vi của tiện ích bổ sung cũng phải bao gồm https://www.googleapis.com/auth/script.locale. Vui lòng xem phần Truy cập vào múi giờ và ngôn ngữ của người dùng để biết thêm thông tin chi tiết.
commonEventObject.timeZone.offset string
Độ chênh lệch thời gian từ Giờ phối hợp quốc tế (UTC) múi giờ của người dùng, được tính bằng mili giây. Vui lòng xem phần Truy cập vào múi giờ và ngôn ngữ của người dùng để biết thêm thông tin chi tiết.

Thông tin nhập vào biểu mẫu trong bộ chọn ngày

Các hàm gọi lại hành động có thể nhận các giá trị tiện ích hiện tại trong trường commonEventObject.formInputs. Dữ liệu này bao gồm giá trị ngày hoặc giờ mà người dùng đã chọn trong các tiện ích bộ chọn ngày hoặc giờ. Tuy nhiên, cấu trúc của thông tin khác nhau tuỳ thuộc vào việc tiện ích được định cấu hình làm bộ chọn ngày, bộ chọn chỉ ngày hay bộ chọn chỉ thời gian. Sự khác biệt về cấu trúc được mô tả trong bảng sau:

Đối tượng DateTimeInput
dateTimeInput.hasDate boolean
true nếu ngày giờ đầu vào có bao gồm ngày; nếu false chỉ được tính giờ.
dateTimeInput.hasTime boolean
true nếu ngày giờ mà dữ liệu đầu vào bao gồm giờ; nếu chỉ có false ngày.
dateTimeInput.msSinceEpoch string
Thời gian mà người dùng chọn, tính bằng mili giây kể từ thời gian bắt đầu của hệ thống (00:00:00 giờ UTC ngày 1/1/1970).
Đối tượng DateInput
dateInput.msSinceEpoch string
Thời gian mà người dùng chọn, tính bằng mili giây kể từ thời gian bắt đầu của hệ thống (00:00:00 giờ UTC ngày 1/1/1970).
Đối tượng TimeInput
timeInput.hours number
Số giờ do người dùng chọn.
timeInput.minutes number
Số phút do người dùng chọn.

Đối tượng sự kiện trên lịch

Đối tượng sự kiện trên Lịch là một phần của đối tượng sự kiện tổng thể chứa thông tin về lịch và các sự kiện trên lịch của người dùng. Phương thức này chỉ xuất hiện trong đối tượng sự kiện nếu ứng dụng lưu trữ là Lịch Google.

Bảng sau đây liệt kê các trường có trong trường calendarEventObject của đối tượng sự kiện. Các trường được đánh dấu là Dữ liệu do người dùng tạo sẽ xuất hiện trong đối tượng sự kiện nếu và chỉ khi dữ liệu có trong sự kiện trên Lịch và tiện ích bổ sung đặt trường addOns.calendar.currentEventAccesstệp kê khai thành READ hoặc READ_WRITE.

Đối tượng sự kiện trên lịch
calendar.attendees[] list of attendee objects
Dữ liệu do người dùng tạo. Danh sách những người tham dự sự kiện trên lịch.
calendar.calendarId string
Mã lịch.
calendar.capabilities object
Dữ liệu do người dùng tạo. Một đối tượng mô tả khả năng xem hoặc cập nhật thông tin sự kiện của tiện ích bổ sung.
calendar.capabilities.canAddAttendees boolean
Dữ liệu do người dùng tạo. true nếu tiện ích bổ sung có thể thêm người tham dự mới vào danh sách người tham dự sự kiện; false nếu không.
calendar.capabilities.canSeeAttendees boolean
Dữ liệu do người dùng tạo. true nếu tiện ích bổ sung có thể đọc danh sách người tham dự sự kiện; false nếu không.
calendar.capabilities.canSeeConferenceData boolean
Dữ liệu do người dùng tạo. true nếu tiện ích bổ sung có thể đọc dữ liệu hội nghị sự kiện; false nếu không.
calendar.capabilities.canSetConferenceData boolean
Dữ liệu do người dùng tạo. true nếu tiện ích bổ sung có thể cập nhật dữ liệu hội nghị sự kiện; false nếu không.
calendar.capabilities.canAddAttachments boolean
Dữ liệu do người dùng tạo. true nếu tiện ích bổ sung có thể thêm tệp đính kèm mới vào sự kiện; false.
calendar.conferenceData Conference data object
Dữ liệu do người dùng tạo. Một đối tượng đại diện cho mọi dữ liệu hội nghị liên quan đến sự kiện này, chẳng hạn như thông tin chi tiết về hội nghị truyền hình trên Google Meet.
calendar.id string
Mã sự kiện.
calendar.organizer object
Đối tượng đại diện cho người tổ chức sự kiện.
calendar.organizer.email string
Địa chỉ email của người tổ chức sự kiện.
calendar.recurringEventId string
Mã nhận dạng của một sự kiện định kỳ.

Người tham dự

Các đối tượng người tham dự mang thông tin về những người tham dự riêng lẻ đến các sự kiện trên Lịch Google. Thông tin này sẽ hiển thị trong đối tượng sự kiện nếu và chỉ khi dữ liệu có trong sự kiện trên Lịch và tiện ích bổ sung đặt trường addOns.calendar.currentEventAccess tệp kê khai thành READ hoặc READ_WRITE.

Đối tượng người tham dự
attendee.additionalGuests number
Số lượng khách bổ sung mà người tham dự cho biết là họ sẽ tham dự. Giá trị mặc định là không.
attendee.comment string
Nhận xét phản hồi của người tham dự (nếu có).
attendee.displayName string
Tên của người tham dự được hiển thị.
attendee.email string
Địa chỉ email của người tham dự.
attendee.optional boolean
true nếu việc tham dự của người tham dự này được đánh dấu là không bắt buộc; false thì không.
attendee.organizer boolean
true nếu người tham dự là người tổ chức sự kiện này.
attendee.resource boolean
true nếu người tham dự đại diện cho một tài nguyên, chẳng hạn như phòng hoặc thiết bị; false nếu không.
attendee.responseStatus string
Trạng thái phản hồi của người tham dự. Có thể là những giá trị sau:
  • accepted: Người tham dự đã chấp nhận lời mời tham gia sự kiện.
  • declined: Người tham dự đã từ chối lời mời tham gia sự kiện.
  • needsAction: Người tham dự chưa phản hồi lời mời tham dự sự kiện.
  • tentative: Người tham dự đã tạm chấp nhận lời mời tham dự sự kiện.
attendee.self boolean
true nếu người tham dự này đại diện cho lịch có sự kiện này; nếu không thì false.

Dữ liệu về hội nghị truyền hình

Các đối tượng dữ liệu hội nghị truyền thông tin về các hội nghị được đính kèm vào các sự kiện trên Lịch Google. Đây có thể là giải pháp của Google cho hội nghị truyền hình, chẳng hạn như Google Meet hoặc hội nghị của bên thứ ba. Thông tin này được hiển thị trong đối tượng sự kiện nếu và chỉ khi dữ liệu có trong sự kiện trên Lịch và tiện ích bổ sung đặt trường tệp kê khai addOns.calendar.currentEventAccess thành READ hoặc READ_WRITE.

Đối tượng dữ liệu hội nghị truyền hình
conferenceData.conferenceId string
Mã nhận dạng của hội nghị. Mã này nhằm cho phép các ứng dụng theo dõi hội nghị truyền hình; bạn không nên hiển thị mã nhận dạng này cho người dùng.
conferenceData.conferenceSolution object
Đối tượng đại diện cho giải pháp hội nghị truyền hình, chẳng hạn như Hangouts hoặc Google Meet.
conferenceData.conferenceSolution.iconUri string
URI cho biểu tượng hiển thị cho người dùng, đại diện cho giải pháp hội nghị này.
conferenceData.conferenceSolution.key object
Khoá duy nhất xác định giải pháp hội nghị cho sự kiện này.
conferenceData.conferenceSolution.key.type string
Loại giải pháp hội nghị truyền hình. Có thể là những giá trị sau:
  • eventHangout cho Hangouts cho người tiêu dùng (http://hangouts.google.com).
  • eventNamedHangout cho Hangouts phiên bản cũ dành cho người dùng Google Workspace (http://hangouts.google.com).
  • hangoutsMeet cho Google Meet (http://meet.google.com).
conferenceData.conferenceSolution.name string
Tên hiển thị của người dùng của giải pháp hội nghị truyền hình này (không được bản địa hoá).
conferenceData.entryPoints[] list of entry point objects
Danh sách các điểm truy cập hội nghị, chẳng hạn như URL hoặc số điện thoại.
conferenceData.notes string
Ghi chú bổ sung (chẳng hạn như hướng dẫn của quản trị viên miền hoặc thông báo pháp lý) về hội nghị truyền hình sẽ hiển thị cho người dùng. Có thể chứa HTML. Độ dài tối đa là 2048 ký tự.
conferenceData.parameters object
Một đối tượng chứa bản đồ ánh xạ dữ liệu tham số đã xác định để sử dụng cho tiện ích bổ sung.
conferenceData.parameters.addOnParameters object
Sơ đồ liên kết với các khoá và giá trị chuỗi tham số. Các khoá và giá trị này được nhà phát triển tiện ích bổ sung xác định để đính kèm thông tin vào một hội nghị cụ thể về cách sử dụng tiện ích bổ sung.

Điểm mục nhập

Các đối tượng điểm truy cập mang thông tin về phương tiện đã thiết lập để truy cập vào một hội nghị nhất định, chẳng hạn như qua điện thoại hoặc video. Thông tin này được hiển thị trong đối tượng sự kiện nếu và chỉ khi dữ liệu có trong sự kiện trên Lịch và tiện ích bổ sung đặt trường tệp kê khai addOns.calendar.currentEventAccess thành READ hoặc READ_WRITE.

Đối tượng điểm truy cập
entryPoint.accessCode string
Mã truy cập dùng để tổ chức hội nghị. Độ dài tối đa là 128 ký tự. Các nhà cung cấp dịch vụ hội nghị thường chỉ sử dụng một nhóm nhỏ {accessCode, meetingCode, passcode, password, pin} để cung cấp quyền truy cập vào các hội nghị truyền hình. Khớp và chỉ hiển thị các trường mà nhà cung cấp hội nghị sử dụng.
entryPoint.entryPointFeatures list
Các tính năng của điểm truy cập. Hiện tại, chúng tôi chỉ áp dụng những tính năng này cho phone điểm truy cập:
  • toll: Điểm truy cập là cuộc gọi điện thoại có tính phí.
  • toll_free: Điểm truy cập là cuộc gọi điện thoại miễn phí.
entryPoint.entryPointType string
Loại điểm truy cập. Có thể là những giá trị sau:
  • more: Hướng dẫn tham gia hội nghị bổ sung, chẳng hạn như số điện thoại thay thế. Hội nghị chỉ được có một điểm truy cập more; nếu có, người dùng cũng cần cung cấp ít nhất một loại điểm truy cập khác.
  • phone: Tham gia hội nghị qua số điện thoại. Hội nghị có thể có từ 0 điểm phone trở lên. Lịch Google chỉ hiển thị hai điểm truy cập đầu tiên trên điện thoại, sau khi định dạng và sắp xếp theo thứ tự bảng chữ cái.
  • sip: Tham gia hội nghị qua SIP. Hội nghị truyền hình có thể có tối đa sip điểm truy cập.
  • video: Tham gia hội nghị qua HTTP. Một hội nghị truyền hình có thể có tối đa một điểm truy cập video.
entryPoint.label string
Nhãn mà người dùng nhìn thấy cho URI điểm truy cập (không được bản địa hóa).
entryPoint.meetingCode string
Mã cuộc họp dùng để truy cập vào hội nghị truyền hình. Độ dài tối đa là 128 ký tự. Các nhà cung cấp dịch vụ hội nghị thường chỉ sử dụng một nhóm nhỏ {accessCode, meetingCode, passcode, password, pin} để cung cấp quyền truy cập vào các hội nghị truyền hình. Khớp và chỉ hiển thị các trường mà nhà cung cấp hội nghị sử dụng.
entryPoint.passcode string
Mật mã dùng để truy cập vào hội nghị truyền hình. Độ dài tối đa là 128 ký tự. Các nhà cung cấp dịch vụ hội nghị thường chỉ sử dụng một nhóm nhỏ {accessCode, meetingCode, passcode, password, pin} để cung cấp quyền truy cập vào các hội nghị truyền hình. Khớp và chỉ hiển thị các trường mà nhà cung cấp hội nghị sử dụng.
entryPoint.password string
Mật khẩu dùng để truy cập vào hội nghị truyền hình. Độ dài tối đa là 128 ký tự. Các nhà cung cấp dịch vụ hội nghị thường chỉ sử dụng một nhóm nhỏ {accessCode, meetingCode, passcode, password, pin} để cung cấp quyền truy cập vào các hội nghị truyền hình. Khớp và chỉ hiển thị các trường mà nhà cung cấp hội nghị sử dụng.
entryPoint.pin string
Mã PIN dùng để tham gia hội nghị truyền hình. Độ dài tối đa là 128 ký tự. Các nhà cung cấp dịch vụ hội nghị thường chỉ sử dụng một nhóm nhỏ {accessCode, meetingCode, passcode, password, pin} để cung cấp quyền truy cập vào các hội nghị truyền hình. Khớp và chỉ hiển thị các trường mà nhà cung cấp hội nghị sử dụng.
entryPoint.regionCode string
Mã vùng của số điện thoại. Người dùng cần đến nếu URI không chứa mã quốc gia. Các giá trị được dựa trên danh sách CLDR công khai của mã vùng.
entryPoint.uri string
URI của điểm truy cập. Độ dài tối đa là 1300 ký tự. Định dạng phụ thuộc vào loại điểm truy cập:
  • more: Cần có giản đồ http: hoặc https:.
  • phone: Cần có giản đồ tel:. URI phải bao gồm toàn bộ trình tự quay số (ví dụ: "tel:+12345678900,,,12345678;1234").
  • sip: Cần có giản đồ sip: hoặc sips:. Ví dụ: "sip:12345678@myprovider.com".
  • video: Cần có giản đồ http: hoặc https:.

Đối tượng Drive

Đối tượng sự kiện trên Drive là một phần của đối tượng sự kiện tổng thể chứa thông tin về Google Drive của người dùng và nội dung của sự kiện đó. Phương thức này chỉ xuất hiện trong đối tượng sự kiện nếu ứng dụng lưu trữ là Google Drive.

Đối tượng Drive
drive.activeCursorItem Drive item object
Mục Drive hiện đang hoạt động.
drive.selectedItems[] list of Drive item objects
Danh sách các mục (tệp hoặc thư mục) đã chọn trong Drive.

Mục trên Drive

Các đối tượng mục trên Drive chứa thông tin về các mục cụ thể trong Drive, chẳng hạn như tệp hoặc thư mục.

Đối tượng trên mục Drive
item.addonHasFileScopePermission boolean
Nếu true, tiện ích bổ sung đó đã yêu cầu và nhận được https://www.googleapis.com/auth/drive.file ủy quyền phạm vi cho mục này; nếu không, trường này là false.
item.id string
Mã nhận dạng của mục đã chọn.
item.iconUrl string
URL của biểu tượng đại diện cho mục đã chọn.
item.mimeType string
Loại MIME của mục đã chọn.
item.title string
Tiêu đề của mục đã chọn.

Đối tượng sự kiện Gmail

Đối tượng sự kiện Gmail là phần của đối tượng sự kiện tổng thể mang thông tin về thư Gmail của người dùng. Phương thức này chỉ xuất hiện trong đối tượng sự kiện nếu ứng dụng lưu trữ là Gmail.

Đối tượng sự kiện Gmail
gmail.accessToken string
Mã truy cập Gmail. Bạn có thể sử dụng mã thông báo này bằng phương thức GmailApp.setCurrentMessageAccessToken(accessToken) để cấp quyền truy cập tạm thời cho tiện ích bổ sung đối với thư Gmail đang mở của người dùng hoặc cho phép tiện ích bổ sung của bạn soạn thư nháp mới.
gmail.bccRecipients[] list of strings
Tắt theo mặc định. Danh sách địa chỉ email của người nhận "BCC:" hiện nằm trong thư nháp mà tiện ích bổ sung đang soạn. Để bật trường này, bạn phải đặt trường addOns.gmail.composeTrigger.draftAccess trong tệp kê khai thành METADATA.
gmail.ccRecipients[] list of strings
Tắt theo mặc định. Danh sách địa chỉ email của người nhận "CC:" hiện có trong bản nháp mà tiện ích bổ sung đang soạn. Để bật trường này, bạn phải đặt trường addOns.gmail.composeTrigger.draftAccess trong tệp kê khai thành METADATA.
gmail.messageId string
Mã nhận dạng của thư Gmail đang mở.
gmail.threadId string
Mã nhận dạng luồng Gmail hiện đang mở.
gmail.toRecipients[] list of strings
Tắt theo mặc định. Danh sách địa chỉ email của người nhận "Đến:" hiện có trong bản nháp tiện ích bổ sung đang soạn. Để bật trường này, bạn phải đặt trường addOns.gmail.composeTrigger.draftAccess trong tệp kê khai thành METADATA.

Đối tượng sự kiện trên Tài liệu

Đối tượng sự kiện Tài liệu là một phần của đối tượng sự kiện tổng thể có chứa thông tin về tài liệu của người dùng và nội dung của tài liệu đó. Nó chỉ xuất hiện trong một đối tượng sự kiện nếu ứng dụng lưu trữ là Google Tài liệu.

Đối tượng sự kiện trên Tài liệu
docs.id string
Chỉ xuất hiện nếu phạm vi https://www.googleapis.com/auth/drive.file mà người dùng đã cho phép.
Mã tài liệu mở trong giao diện người dùng Tài liệu.
docs.title string
Chỉ xuất hiện nếu người dùng đã cho phép phạm vi https://www.googleapis.com/auth/drive.file.
Tên tài liệu mở trong giao diện người dùng Tài liệu.
docs.addonHasFileScopePermission boolean
Nếu true, tiện ích bổ sung đó đã yêu cầu và nhận được ủy quyền phạm vi https://www.googleapis.com/auth/drive.file cho tài liệu đang mở trong giao diện người dùng Tài liệu; nếu không, trường này là false.
docs.matched.url string
Chỉ biểu thị nếu đáp ứng các điều kiện sau:
  • https://www.googleapis.com/auth/documents.readonly đã được người dùng cho phép.
  • URL khớp với mẫu lưu trữ được chỉ định trong trình kích hoạt LinkPreviewTriggers.

URL của đường liên kết tạo bản xem trước trong Google Tài liệu. Để sử dụng trường này, bạn phải định cấu hình LinkPreviewTriggers trong tệp kê khai của tiện ích bổ sung. Xem phần Xem trước đường liên kết trong Google Tài liệu để biết thêm thông tin chi tiết.

Đối tượng sự kiện trên Trang tính

Đối tượng sự kiện Trang tính là một phần của đối tượng sự kiện tổng thể có chứa thông tin về tài liệu của người dùng và nội dung của tài liệu đó. Phương thức này chỉ xuất hiện trong một đối tượng sự kiện nếu ứng dụng lưu trữ là Google Trang tính.

Đối tượng sự kiện trên Trang tính
sheets.id string
Chỉ xuất hiện nếu phạm vi https://www.googleapis.com/auth/drive.file đã được người dùng cho phép. Mã của bảng tính mở trong giao diện người dùng của Trang tính.
sheets.title string
Chỉ xuất hiện nếu phạm vi https://www.googleapis.com/auth/drive.file đã được người dùng cho phép. Tiêu đề của bảng tính sẽ mở trong giao diện người dùng của Trang tính.
sheets.addonHasFileScopePermission boolean
Nếu true, tiện ích bổ sung đó đã yêu cầu và nhận được ủy quyền phạm vi https://www.googleapis.com/auth/drive.file cho bảng tính mở trong giao diện người dùng của Trang tính; nếu không, trường này là false.

Đối tượng sự kiện trên Trang trình bày

Đối tượng sự kiện trên Trang trình bày là phần của đối tượng sự kiện tổng thể chứa thông tin về tài liệu và nội dung của người dùng. Nó chỉ xuất hiện trong một đối tượng sự kiện nếu ứng dụng lưu trữ là Google Trang trình bày.

Đối tượng sự kiện trên Trang trình bày
slides.id string
Chỉ xuất hiện nếu phạm vi https://www.googleapis.com/auth/drive.file đã được người dùng cho phép. Mã của bản trình bày mở trong giao diện người dùng Trang trình bày.
slides.title string
Chỉ xuất hiện nếu phạm vi https://www.googleapis.com/auth/drive.file đã được người dùng cho phép. Tiêu đề của bản trình bày mở trong giao diện người dùng Trang trình bày.
slides.addonHasFileScopePermission boolean
Nếu true, tiện ích bổ sung đó đã yêu cầu và nhận được ủy quyền phạm vi https://www.googleapis.com/auth/drive.file cho bản trình bày đang mở trong giao diện người dùng Trang trình bày; nếu không, trường này là false.