Đố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ấu trúc JSON được tạo tự động và được truyền 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 tiện ích bổ sung. Đối tượng sự kiện mang 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 các đối tượng sự kiện ở những nơi sau:

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

  • Điều kiện kích hoạt theo bối cảnh. Mỗi ứng dụng lưu trữ cung cấp một tập hợp điều kiện 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 một điều kiện kích hoạt theo ngữ cảnh khi người dùng mở thư và một điều kiện kích hoạt khác theo ngữ cảnh khi người dùng Soạn thư.
    • Lịch Google cung cấp điều kiện kích hoạt theo ngữ cảnh khi 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 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 tiện ích bổ sung, truyền vào đó một đối tượng sự kiện dưới dạng tham số. Các đối tượng sự kiện được tạo khi điều kiện 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 của điều kiện 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 với tiện ích. Các đối tượng sự kiện cũng được dùng để cung cấp khả 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 Gmail sử dụng. Tiện ích bổ sung của Google Workspace sử dụng tất cả các hàm của 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 các Tiện ích bổ sung của Google Workspace, đối tượng sự kiện hành động chứa nhiều thông tin hơn nữa mà hàm gọi lại có thể thực hiện.

    Các đối tượng sự kiện được tạo do 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 kích hoạt theo ngữ 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ẽ kích hoạt và một đối tượng sự kiện chứa đường liên kết đó sẽ được truyề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 giúp hiện 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 tiện ích để cho phép người dùng tương tác với thẻ xem trước và nội dung trên 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 Tiện ích bổ sung của Google Workspace. Cấu trúc đối tượng sự kiện bao gồm một trường cấp cao nhất commonEventObject 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 từng máy chủ lưu trữ sau đây, được ứng dụng lưu trữ đang hoạt động xác định: gmailEventObject, calendarEventObject hoặc driveEventObject.

Để có khả năng 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 được dùng trong đối tượng sự kiện hành động của tiện ích bổ sung trong Gmail. Các trường này được liệt kê trong bảng bên dưới, trong phần "Các trường tiện ích bổ sung gốc của 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 phổ biến của tất cả cá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. Đối tượng chứa thông tin 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 máy chủ gọi là Gmail. Một đố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 về 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.
Các trường gốc, tiện ích bổ sung của Gmail
eventObject.messageMetadata.accessToken string
Không dùng nữa. Mã truy cập. Bạn có thể sử dụng tuỳ chọn này để cho phép quyền truy cập vào dữ liệu người dùng bằng các phạm vi tiện ích bổ sung tạm thời trong 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ã nhận dạng thư của chuỗi thư được 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 đồ về các giá trị hiện tại của tất cả tiện ích biểu mẫu trong thẻ, 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 các tiện ích và giá trị là các 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ó giá trị số ít dự kiến, chẳng hạn như dữ liệu nhập và chuyển đổi văn bản. Đối với các tiện ích có nhiều giá trị (chẳng hạn như hộp đánh dấu), bạn có thể đọc từng giá trị từ formInputs.

Đố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.formInputs. Các tiện ích có giá trị duy nhất được biểu thị dưới dạng mảng với 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 các tiện ích trong thẻ, được trình bày dưới dạng danh sách chuỗi. Khoá là các mã nhận dạng chuỗi liên kết với tiện ích. Đối với các tiện ích có một giá trị, giá trị được biểu thị trong một mảng phần tử đơn. Đối với các 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ị đều xuất hiện 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 đồ của mọi tham số bổ sung mà bạn cung cấp cho Action bằng Action.setParameters(). Khoá bản đồ và giá trị 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
Không dùng nữa và bị vô hiệu hoá 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. Quốc gia nà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
Không dùng nữa và bị vô hiệu hoá theo mặc định. Mã gồm 2 chữ cái theo tiêu chuẩn ISO 639 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 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
Không dùng nữa và bị vô hiệu hoá theo mặc định. 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. Hãy xem bài viết Truy cập 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 trường eventObject.commonEventObject.timeZone.id.

eventObject.userTimezone.offset string
Không dùng nữa và bị vô hiệu hoá theo mặc định. Mức chênh lệch thời gian so với Múi giờ phối hợp quốc tế (UTC) trong múi giờ của người dùng, được tính bằng mili giây. Hãy xem bài viết Truy cập 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 trường eventObject.commonEventObject.timeZone.offset.

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

Đố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ủ lưu trữ đế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 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 điều kiện kích hoạt theo bối cảnh và trang chủ, tiện ích bổ sung còn tạo và truyền đối tượng sự kiện đến 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 của người dùng. Ví dụ: tiện ích bổ sung của bạn có thể xác định vị trí của 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 nơi sự kiện bắt nguồ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 chỉ định cho mỗi 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ó một 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ó mã nhận dạng là employeeName, hãy truy cập vào giá trị nhập văn bản bằng: e.commonEventObject.formInputs.employeeName.stringInputs.value[0]

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

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

  • A date-time picker: 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: DateInput object.

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

  • A time-only picker: TimeInput object.

    Ví dụ: Đối với bộ chọn có mã nhận dạng 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 khi đối tượng sự kiện được tạo. Các giá trị có thể có bao gồm:
  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
commonEventObject.parameters object
Mọi tham số bổ sung mà bạn cung cấp cho Action bằng Action.setParameters().
commonEventObject.userLocale string
Tắt theo mặc định. Ngôn ngữ và giá trị nhận dạng quốc gia/khu vực của người dùng ở định dạng mã ngôn ngữ ISO 639 – mã quốc gia/khu vực theo 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 bài viết 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à độ 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 bài viết 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
Giá trị nhận dạng múi giờ thuộc 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. Hãy xem bài viết Truy cập 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
độ lệch thời gian so với Múi giờ phối hợp quốc tế (UTC) trong múi giờ của người dùng, được tính bằng mili giây. Hãy xem bài viết Truy cập ngôn ngữ và múi giờ của người dùng để biết thêm thông tin chi tiết.

Thông tin đầu vào trong biểu mẫu của bộ chọn ngày giờ

Hàm callback hành động có thể nhận các giá trị tiện ích hiện tại trong trường commonEventObject.formInputs. Điều này bao gồm các giá trị ngày hoặc giờ mà người dùng đã chọn trong các tiện ích của bộ chọn ngày hoặc giờ. Tuy nhiên, cấu trúc của thông tin còn 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 hay bộ chọn chỉ thời gian. Những 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 nhập bao gồm một ngày; nếu false chỉ có một khoảng thời gian.
dateTimeInput.hasTime boolean
true nếu ngày nhập dữ liệu bao gồm cả thời gian; nếu false thì chỉ có một 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 giờ UTC vào 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 giờ UTC vào 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ề sự kiện trên lịch và lịch của người dùng. Nhãn 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 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 sẽ xuất hiện trong đối tượng sự kiện khi và chỉ khi dữ liệu đó xuất hiện 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 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; nếu không thì false.
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; nếu không thì false.
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ị truyền hình; nếu không thì false.
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ị truyền hình; nếu không thì false.
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; nếu không thì 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 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
Một đố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ự truyền thông tin về từng người tham dự đến các sự kiện trên Lịch Google. Thông tin này xuất hiện trong đối tượng sự kiện khi 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 họ sẽ đưa đến. Giá trị mặc định là 0.
attendee.comment string
Nhận xét trong 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 tình trạng tham dự của người tham dự này được đánh dấu là không bắt buộc; nếu không thì là false.
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ị; nếu không thì false.
attendee.responseStatus string
Trạng thái phản hồi của người tham dự. Những giá trị sau đây có thể xuất hiện:
  • 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 dự 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 mà sự kiện này xuất hiện; nếu không thì false.

Dữ liệu 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ề hội nghị truyền hình được đính kèm vào các sự kiện trên Lịch Google. Đó 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ị truyền hình của bên thứ ba. Thông tin này xuất hiện 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 đặt trường addOns.calendar.currentEventAccess tệp kê khai 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ị truyền hình. Mã nhận dạng 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 cho người dùng thấy mã này.
conferenceData.conferenceSolution object
Một đố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 mà người dùng nhìn thấy đại diện cho 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 cho hội nghị truyền hình. Có thể bao gồm các giá trị sau đây:
  • 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 mà người dùng nhìn thấy 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 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ề hội nghị để hiển thị cho người dùng. Có thể chứa HTML. Độ dài tối đa là 2.048 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 khoá và giá trị chuỗi tham 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ị truyền hình cụ thể nhằm sử dụng 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 thức đã 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 xuất hiện 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 đặt trường addOns.calendar.currentEventAccess tệp kê khai thành 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ị truyền hình. Độ 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 nhóm nhỏ {accessCode, meetingCode, passcode, password, pin} để cung cấp quyền truy cập vào hội nghị truyền hình. 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 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ác giá trị có thể sử dụng là:
  • more: Hướng dẫn bổ sung về cách tham gia hội nghị truyền hình, 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ần có í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. Một hội nghị truyền hình có thể không có hoặc có 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ị truyền hình có thể có tối đa một điểm truy cập sip.
  • video: Tham gia hội nghị truyền hình 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 hoá).
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 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 hội nghị truyền hình. So 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ị 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 nhóm nhỏ {accessCode, meetingCode, passcode, password, pin} để cung cấp quyền truy cập vào hội nghị truyền hình. So 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 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 nhóm nhỏ {accessCode, meetingCode, passcode, password, pin} để cung cấp quyền truy cập vào hội nghị truyền hình. 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 vào hội nghị truyền hình. Độ 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 nhóm nhỏ {accessCode, meetingCode, passcode, password, pin} để cung cấp quyền truy cập vào hội nghị truyền hình. So 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. Cần có người dùng nếu URI không chứa mã quốc gia. Các giá trị 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 sẽ phụ thuộc vào loại điểm truy cập:
  • more: Bạn 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: Bạn phải có giản đồ sip: hoặc sips:. Ví dụ: "sip:12345678@myprovider.com".
  • video: Bạn phải có giản đồ http: hoặc https:.

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

Đối tượng sự kiện Drive là một phần trong đối tượng sự kiện tổng thể mang thông tin về Google Drive của người dùng và nội dung trong đó. Tệp 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 sự kiện Drive
drive.activeCursorItem Drive item object
Mục trên 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) được chọn trong Drive.

Mục trên Drive

Đối tượng mục trong 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 mục trên Drive
item.addonHasFileScopePermission boolean
Nếu là true, thì tiện ích bổ sung đã yêu cầu và nhận được quyền truy cập vào phạm vi https://www.googleapis.com/auth/drive.file cho mục này; nếu không, trường này sẽ là false.
item.id string
Mã của mục đượ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à một phần của đối tượng sự kiện tổng thể, mang thông tin về thư trên Gmail của người dùng. Hành vi 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 dành riêng cho 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 cho tiện ích bổ sung của bạn quyền truy cập tạm thời vào thư Gmail của người dùng mà bạn đang mở 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 có 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 người nhận "CC:" hiện có 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.messageId string
Mã của thư hiện đang mở trên Gmail.
gmail.threadId string
Mã chuỗi thư hiện đang mở trên Gmail.
gmail.toRecipients[] list of strings
Tắt theo mặc định. Danh sách địa chỉ email người nhận "Đến:" hiện có 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.

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

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

Ví dụ về tải trọng 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 trên Trang trình bày

Đối tượng sự kiệ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 của tài liệu đó. Tệp này chỉ xuất hiện trong đố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ỉ hiển thị 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 của 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 người dùng cho phép. 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, thì tiện ích bổ sung đã yêu cầu và được cấp quyền truy cập vào phạm vi https://www.googleapis.com/auth/drive.file đối với bản trình bày mở trong giao diện người dùng của 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 các điều kiện sau được đáp ứng:
  • https://www.googleapis.com/auth/workspace.linkpreview đã được người dùng cấp quyền.
  • URL khớp với mẫu máy chủ lưu trữ đượ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 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.

Ví dụ về tải trọng 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"
  }
}