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

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

Đối tượng sự kiện là cấu trúc JSON được tạo và truyền tự động dưới dạng tham 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. Các đối tượng sự kiện mang thông tin phía máy khách về ứng dụng lưu trữ và bối cảnh hiện tại đến 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 các đối tượng sự kiện ở những vị trí sau:

  • Điều kiện kích hoạt trang chủ. Mỗi hàm homepageTrigger mà bạn xác định sẽ tự động được chuyển một 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 điều kiện 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 khách, 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 trình kích hoạt trang chủ kích hoạt không chứa tất cả các trường có trong hai trường hợp khác; các trường liên quan đến tiện ích và thông tin theo ngữ cảnh bị bỏ qua.

  • Trình kích hoạt theo bối cảnh. Mỗi ứng dụng lưu trữ cung cấp một nhóm trình kích hoạt theo ngữ cảnh khác nhau kích hoạt khi người dùng vào một ngữ cảnh cụ thể. Ví dụ:

    • Gmail cung cấp điều kiện kích hoạt theo ngữ cảnh khi người dùng mở một thông báo và một lựa chọn khác khi người dùng soạn thư.
    • Lịch Google cung cấp một điều kiện kích hoạt theo ngữ cảnh cho thời điểm người dùng mở một sự kiện.
    • Google Drive cung cấp điều kiện kích hoạt theo ngữ cảnh khi người dùng chọn tệp trên Drive.

    Khi điều kiện 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 tiện ích bổ sung, truyền vào đó đối tượng sự kiện 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 theo ngữ cảnh kích hoạt chứa tất cả các trường có trong đối tượng sự kiện trình kích hoạt trang chủ, cùng với các trường chứa thông tin theo ngữ cảnh.

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

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

  • Xem trước điều kiện kích hoạt đường liên kết. Trong Google Tài liệu, Trang tính và Trang trình bày, 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ụ của bên thứ ba dựa trên các 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, linkPreviewTriggers sẽ được kích hoạt và một đối tượng sự kiện có chứa đường liên kết được chuyển đến hàm callback. 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 hành động 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 đố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 trong Tiện ích của Google Workspace. Sự kiện cấu trúc đối tượng bao gồm commonEventObject trường cấp cao nhất dành cho thông tin độc lập với máy chủ lưu trữ. 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ủ sau đây, do ứng dụng lưu trữ đang hoạt động xác định: gmailEventObject, calendarEventObject hoặc driveEventObject.

Để tương thích ngược, đối tượng sự kiện của Tiện ích bổ sung Google Workspace cũng bao gồm tất cả các trường ban đầu được sử dụng trong đối tượng sự kiện hành động của tiện ích bổ sung Gmail. Các trường này được liệt kê trong bảng bên dưới trong phần "Trường tiện ích bổ sung gốc dành cho Gmail"; thông tin trong các trường này được tái tạo 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ả đối tượng sự kiện, bất kể ứng dụng lưu trữ.
eventObject.calendar
Calendar event object Chỉ hiển thị 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 máy chủ gọi là Google Drive. Một đối tượng chứa thông tin Drive.
eventObject.gmail Gmail event object
Chỉ xuất hiện nếu máy chủ gọi là Gmail. Một đối tượng chứa thông tin về Gmail.
eventObject.docs Docs event object
Chỉ xuất hiện nếu máy chủ gọi là Google Tài liệu. Một đối tượng chứa thông tin về Tài liệu.
eventObject.sheets Sheets event object
Chỉ xuất hiện nếu máy chủ gọi là Google Trang tính. Một đối tượng chứa thông tin về Trang tính.
eventObject.slides Slides event object
Chỉ xuất hiện nếu máy chủ gọi là Google Trang trình bày. Một đối tượng chứa thông tin về Trang trình bày.
Các 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 tính năng 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 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 eventObject.gmail.accessToken .

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

Đối với 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 nơi diễn ra sự kiện bắt nguồn từ 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 eventObject.commonEventObject.platform .

eventObject.formInput object
Không dùng nữa. Bản đồ các giá trị hiện tại trên 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. Chiến lược phát hành đĩa đơn khoá là các mã nhận dạng chuỗi được liên kết với tiện ích và các giá trị là . Đối tượng sự kiện cung cấp formInput để thuận tiện cho trường hợp bạn cần đọc dữ liệu từ nhiều tiện ích có giá trị đơn lẻ dự kiến, chẳng hạn như dữ liệu đầu vào văn bản và nút chuyển. Đối với các tiện ích có nhiều giá trị như hộp đánh dấu, bạn có thể đọc từng giá trị từ 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 eventObject.commonEventObject.formInputs trường thay thế; các tiện ích có các giá trị đơn lẻ được biểu thị dưới dạng mảng một phần tử.

eventObject.formInputs object
Không dùng nữa. Bản đồ các giá trị hiện tại của các tiện ích trong thẻ, được trình bày dưới dạng danh sách chuỗi. Chìa khoá này là chuỗi được liên kết với tiện ích. Đối với các tiện ích có một giá trị, hàm được biểu thị trong mảng một phần tử. Đối với tiện ích có nhiều giá trị chẳng hạn như 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 eventObject.commonEventObject.formInputs .

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

Đối với 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
Ngừng sử dụng và bị tắt theo mặc định. Mã gồm hai chữ cái cho biết quốc gia hoặc khu vực của người dùng. Cũng có thể một số Mã quốc gia UN M49.

Đối với 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
Không dùng nữa và bị tắt theo mặc định. Mã ISO 639 gồm hai chữ cái cho biết ngôn ngữ của người dùng. Hãy xem phần Truy cập vào ngôn ngữ và múi giờ của người dùng để biết thêm thông tin chi tiết.

Đối với 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
Không dùng nữa và bị tắt theo mặc định. Mã nhận dạng múi giờ của múi giờ của người dùng. Ví dụ như: America/New_York, Europe/Vienna và Asia/Seoul. Xem Truy cập vào ngôn ngữ và múi giờ của người dùng để biết thêm thông tin chi tiết.

Đối với 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
Ngừng sử dụng và bị tắt theo mặc định. Chiến lược phát hành đĩa đơn chênh lệch thời gian so với Giờ phối hợp quốc tế (UTC) của múi giờ, được đo bằng mili giây. Xem Truy cập vào ngôn ngữ và múi giờ 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 eventObject.commonEventObject.timeZone.offset .

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

Đối tượng sự kiện chung 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 các chi tiết như ngôn ngữ, ứng dụng lưu trữ và nền tảng của người dùng.

Ngoài trang chủ và trình kích hoạt theo ngữ cảnh, tiện ích bổ sung còn tạo và truyền đối tượng sự kiện thành hàm gọi lại hành động khi người dùng tương tác với 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 tiện ích của người dùng khách hàng. Ví dụ: tiện ích bổ sung của bạn có thể tìm 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á ánh xạ là mã nhận dạng chuỗi được gán cho từng tiện ích.

Cấu trúc của đối tượng giá trị bản đồ phụ thuộc vào loại tiện ích:

  • Tiện ích có giá trị đơn (ví dụ: hộp văn bản): danh sách các chuỗi (chỉ một phần tử).

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

  • Tiện ích nhiều giá trị (ví dụ: nhóm hộp đánh dấu): danh sách .

    Ví dụ: đối với tiện ích nhiều giá trị có participants làm mã nhận dạng, truy cập vào giá trị mảng 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ã là myDTPicker, truy cập vào DateTimeInput đối tượng đang 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ã là myDatePicker, truy cập vào DateInput 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 e.commonEventObject.formInputs.myTimePicker.timeInput.
commonEventObject.hostApp string
Cho biết ứng dụng lưu trữ mà tiện ích bổ sung đang hoạt động trong đó khi đối tượng sự kiện được tạo. Các giá trị có thể bao gồm:
  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
commonEventObject.parameters object
Mọi thông số bổ sung mà bạn nguồn cấp dữ liệu cho Action bằng cách sử dụng Action.setParameters().
commonEventObject.userLocale string
Tắt theo mặc định. Ngôn ngữ của người dùng và giá trị nhận dạng quốc gia/khu vực ở định dạng mã ngôn ngữ ISO 639-mã quốc gia/khu vực 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. Hãy xem phần Truy cập vào ngôn ngữ và múi giờ của người dùng để biết thêm thông tin chi tiết.

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

Dữ liệu đầu vào của biểu mẫu bộ chọn ngày giờ

Hàm gọi lại thao tác có thể nhận giá trị tiện ích hiện tại trong trường commonEventObject.formInputs. Giá trị này bao gồm cả những giá trị ngày hoặc giờ mà người dùng đã chọn trong bộ chọn ngày hoặc giờ các tiện ích khác nhau. Tuy nhiên, cấu trúc của thông tin sẽ khác nhau tuỳ thuộc vào việc tiện ích được định cấu hình dưới dạng bộ chọn ngày-giờ, bộ chọn chỉ ngày hoặc bộ chọn chỉ giờ. 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ờ nhập có ngày tháng; nếu false chỉ được tính thời gian.
dateTimeInput.hasTime boolean
true nếu ngày giờ đầu vào bao gồm cả thời gian; nếu false chỉ bao gồm ngày.
dateTimeInput.msSinceEpoch string
Thời gian do 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 UTC ngày 1 tháng 1 năm 1970).
Đối tượng DateInput
dateInput.msSinceEpoch string
Thời gian do 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 UTC ngày 1 tháng 1 năm 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ể mang thông tin về lịch và sự kiện trên lịch của người dùng. Chỉ hiển thị 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 calendarEventObject của một đố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 xuất hiện trong đối tượng sự kiện khi và chỉ khi dữ liệu có trong Lịch sự kiện và tiện ích bổ sung sẽ đặt addOns.calendar.currentEventAccess tệp kê khai đến 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 người tham dự lịch sự kiện.
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ả các chức năng của tiện ích bổ sung để xem hoặc cập nhật thông tin sự kiện.
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 liệu tiện ích bổ sung có thể thêm tệp đính kèm mới vào sự kiện không; false nếu không.
calendar.conferenceData Conference data object
Dữ liệu do người dùng tạo. Đối tượng đại diện cho mọi dữ liệu về hội nghị truyền hình 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ã của một sự kiện định kỳ.

Người tham dự

Đối tượng người tham dự mang thông tin về từng người tham dự vào Lịch Google sự kiện. Thông tin này xuất hiện trong đối tượng sự kiện khi và chỉ khi dữ liệu hiện diện trong sự kiện trên Lịch và tiện ích bổ sung sẽ thiết lập addOns.calendar.currentEventAccess tệp kê khai đến READ hoặc READ_WRITE.

Đối tượng người tham dự
attendee.additionalGuests number
Số lượng khách khác mà người tham dự đã cho biết sẽ đưa theo. Giá trị mặc định là 0.
attendee.comment string
Bình luận phản hồi của người tham dự (nếu có).
attendee.displayName string
Tên hiển thị của người tham dự.
attendee.email string
Địa chỉ email của người tham dự.
attendee.optional boolean
true nếu tham dự sự kiện này người tham dự được đánh dấu là không bắt buộc; false.
attendee.organizer boolean
true nếu người tham dự là người tổ chức cho sự kiện này.
attendee.resource boolean
true nếu người tham dự đại diện cho 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ác giá trị có thể có bao gồm:
  • accepted: Người tham dự đã chấp nhận sự kiện lời mời.
  • 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 thời chấp nhận lời mời tham gia sự kiện.
attendee.self boolean
true nếu người tham dự này đại diện cho lịch mà sự kiện này xuất hiện; false nếu không.

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

Đối tượng dữ liệu hội nghị truyền hình mang thông tin về các hội nghị được đính kèm vào sự kiện trên Lịch Google. Đây có thể là các giải pháp hội nghị của Google, chẳng hạn như Google Meet hoặc hội nghị của bên thứ ba. Thông tin này có trong đối tượng sự kiện nếu và chỉ khi dữ liệu có trong sự kiệ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ã của hội nghị. Mã này có nghĩa là để cho phép các ứng dụng theo dõi hội nghị; bạn không nên hiển thị mã nhận dạng này cho người dùng.
conferenceData.conferenceSolution object
Một đối tượng đại diện cho giải pháp hội nghị, chẳng hạn như Hangouts hoặc Google Meet.
conferenceData.conferenceSolution.iconUri string
URI cho biểu tượng mà người dùng nhìn thấy đại diện giải pháp hội nghị này.
conferenceData.conferenceSolution.key object
Khoá xác định duy nhất 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ị. Giá trị có thể sử dụng bao gồm:
  • eventHangout dành cho Hangouts dành 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ị cho người dùng của giải pháp hội nghị này (chưa được bản địa hoá).
conferenceData.entryPoints[] list of entry point objects
Danh sách các điểm truy cập vào 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ề cuộc họp để 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 đồ dữ liệu tham số đã xác định để tiện ích bổ sung sử dụng.
conferenceData.parameters.addOnParameters object
Bản đồ các giá trị và khoá chuỗi thông số. Các khoá và giá trị này do 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ể cho mục đích sử dụng của tiện ích bổ sung.

Điểm mục nhập

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

Đối tượng điểm truy cập
entryPoint.accessCode string
Mã truy cập dùng để truy cập vào hội nghị. Độ dài tối đa là 128 ký tự. Các nhà cung cấp hội nghị thường chỉ sử dụng một tập hợp con của {accessCode, meetingCode, passcode, password, pin} để cấp quyền truy cập vào hội nghị. So 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, các tính năng này chỉ áp dụng cho các điểm truy cập phone:
  • toll: Điểm truy cập là một cuộc gọi điện thoại có tính phí.
  • toll_free: Điểm truy cập là một cuộc gọi điện thoại không tính phí.
entryPoint.entryPointType string
Loại điểm truy cập. Các giá trị có thể sử dụng là:
  • more: Hướng dẫn tham gia hội nghị bổ sung, chẳng hạn như số điện thoại thay thế. Một hội nghị chỉ có thể có một điểm truy cập more; nếu có, ít nhất một loại điểm truy cập khác cũng bắt buộc phải có.
  • phone: Tham gia hội nghị qua số điện thoại. Một hội nghị có thể có từ 0 đến nhiều điểm truy cập phone. Lịch Google chỉ hiển thị hai điểm truy cập điện thoại đầu tiên, 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. Một hội nghị có thể có tối đa một điểm truy cập sip.
  • video: Tham gia hội nghị qua HTTP. Đáp 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 (chưa bản địa hoá).
entryPoint.meetingCode string
Mã cuộc họp dùng để truy cập vào hội nghị. Độ dài tối đa là 128 ký tự. Các nhà cung cấp hội nghị thường chỉ sử dụng một tập hợp con của {accessCode, meetingCode, passcode, password, pin} để cấp quyền truy cập vào hội nghị. So khớp và chỉ hiển thị các trường mà nhà cung cấp hội nghị truyền hình sử dụng.
entryPoint.passcode string
Mật mã dùng để truy cập hội nghị truyền hình này. Độ dài tối đa là 128 ký tự. Nhà cung cấp dịch vụ hội nghị thường chỉ sử dụng một tập hợp con của {accessCode, meetingCode, passcode, password, pin} đến cung cấp quyền truy cập vào hội nghị. So khớp và chỉ hiển thị các trường mà nhà cung cấp hội nghị truyền hình sử dụng.
entryPoint.password string
Mật khẩu dùng để truy cập vào cuộc họp. Độ dài tối đa là 128 ký tự. Các nhà cung cấp hội nghị thường chỉ sử dụng một tập hợp con của {accessCode, meetingCode, passcode, password, pin} để cấp quyền truy cập vào hội nghị. So 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 để truy cập hội nghị truyền hình này. Độ dài tối đa là 128 ký tự. Các nhà cung cấp hội nghị thường chỉ sử dụng một tập hợp con của {accessCode, meetingCode, passcode, password, pin} để cấp quyền truy cập vào hội nghị. So khớp và chỉ hiển thị các trường mà nhà cung cấp hội nghị truyền hình sử dụng.
entryPoint.regionCode string
Mã vùng của số điện thoại. Cần thiết cho người dùng nếu URI không bao gồm mã quốc gia. Giá trị dựa trên công khai Danh sách mã vùng CLDR.
entryPoint.uri string
URI của điểm truy cập. Độ dài tối đa là 1.300 ký tự. Định dạng phụ thuộc vào loại điểm truy cập:
  • more: Bắt buộc phải 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: sip: hoặc sips: giản đồ là bắt buộc. Ví dụ: "sip:12345678@myprovider.com".
  • video: Bắt buộc phải có giản đồ http: hoặc https:.

Đối tượng sự kiện 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 Google Drive đó. Chỉ hiện diện trong đối tượng sự kiện nếu ứng dụng lưu trữ là Google Drive.

Đối tượng sự kiện 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

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

Đối tượng mục trên Drive
item.addonHasFileScopePermission boolean
Nếu là true, tức là tiện ích bổ sung đã yêu cầu và nhận https://www.googleapis.com/auth/drive.file uỷ quyền phạm vi cho mục này; nếu không, trường này sẽ false.
item.id string
Mã nhận dạng của mặt hàng đã 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 trên Gmail

Đối tượng sự kiện của Gmail là một 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 diện 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à Gmail.

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

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

Đối tượng sự kiện của Docs là một phần của đối tượng sự kiện tổng thể, 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 đó. Thuộc tính này chỉ xuất hiện trong đố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ỉ hiển thị nếu phạm vi https://www.googleapis.com/auth/drive.file đã được được người dùng uỷ quyền.
Mã nhận dạng của tài liệu sẽ mở trong giao diện người dùng của Tài liệu.
docs.title string
Chỉ hiển thị nếu phạm vi https://www.googleapis.com/auth/drive.file đã được được người dùng uỷ quyền.
Tiêu đề của tài liệu sẽ mở trong giao diện người dùng của Tài liệu.
docs.addonHasFileScopePermission boolean
Nếu là true, tức là tiện ích bổ sung đã yêu cầu và nhận https://www.googleapis.com/auth/drive.file uỷ quyền phạm vi cho tài liệu được mở trong giao diện người dùng Tài liệu; nếu không thì thế này là false.
docs.matchedUrl.url string
Chỉ xuất hiện nếu các điều kiện sau được đáp ứng:
  • Người dùng đã uỷ quyền https://www.googleapis.com/auth/workspace.linkpreview.
  • URL khớp với mẫu máy chủ được chỉ định trong điều kiện 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. Hãy xem phần Xem trước đường liên kết bằng khối thông minh để biết thêm thông tin chi tiết.

Tải trọng mẫu khi người dùng xem trước đường liên kết https://www.example.com/12345: 

"docs" : {
  "matchedUrl" : {
      "url" : "https://www.example.com/12345"
  }
}

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

Đối tượng sự kiện của Trang tính là một phần của đối tượng sự kiện tổng thể, 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 đó. Mã này chỉ có 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 của Trang tính
sheets.id string
Chỉ hiển thị nếu phạm vi https://www.googleapis.com/auth/drive.file đã được được người dùng uỷ quyền. Mã nhận dạng của bảng tính đang mở trong giao diện người dùng của Trang tính.
sheets.title string
Chỉ hiển thị nếu phạm vi https://www.googleapis.com/auth/drive.file đã được được người dùng uỷ quyền. Tiêu đề của bảng tính đang mở trong giao diện người dùng Trang tính.
sheets.addonHasFileScopePermission boolean
Nếu là true, tức là tiện ích bổ sung đã yêu cầu và nhận https://www.googleapis.com/auth/drive.file uỷ quyền phạm vi cho bảng tính mở trong giao diện người dùng Trang tính; nếu không trường này là false.
sheets.matchedUrl.url string
Chỉ xuất hiện nếu các điều kiện sau được đáp ứng:
  • Người dùng đã uỷ quyền https://www.googleapis.com/auth/workspace.linkpreview.
  • URL khớp với mẫu máy chủ được chỉ định trong điều kiện kích hoạt LinkPreviewTriggers.

URL của đường liên kết tạo bản xem trước trong Google Trang tính. Để 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. Hãy xem bài viết Xem trước đường liên kết bằng khối thông minh để biết thêm thông tin chi tiết.

Tải trọng mẫu khi người dùng xem trước đường liên kết https://www.example.com/12345:

"sheets" : {
  "matchedUrl" : {
      "url" : "https://www.example.com/12345"
  }
}

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

Đối tượng sự kiện trên Trang trình bày là một phần của đối tượng sự kiện tổng thể mang thông tin về tài liệu của người dùng và nội dung trong đó. Mã này chỉ có 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 của Trang trình bày
slides.id string
Chỉ xuất hiện nếu người dùng đã uỷ quyền cho phạm vi https://www.googleapis.com/auth/drive.file. Mã nhận dạng của bản trình bày đang mở trong giao diện người dùng Trang trình bày.
slides.title string
Chỉ hiển thị nếu phạm vi https://www.googleapis.com/auth/drive.file đã được được người dùng uỷ quyền. Tiêu đề của bản trình bày sẽ mở trong Giao diện người dùng của Trang trình bày.
slides.addonHasFileScopePermission boolean
Nếu là true, tiện ích bổ sung đã yêu cầu và nhận được quyền truy cập 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 sẽ là false.
slides.matchedUrl.url string
Chỉ xuất hiện nếu đáp ứng các điều kiện sau:
  • Người dùng đã uỷ quyền https://www.googleapis.com/auth/workspace.linkpreview.
  • URL khớp với mẫu máy chủ được chỉ định trong điều kiện kích hoạt LinkPreviewTriggers.

URL của đường liên kết tạo bản xem trước trong Google Trang trình bày. Để 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. Hãy xem phần Xem trước đường liên kết bằng khối thông minh để biết thêm thông tin chi tiết.

Trọng tải mẫu khi người dùng xem trước đường liên kết https://www.example.com/12345:

"slides" : {
  "matchedUrl" : {
      "url" : "https://www.example.com/12345"
  }
}