Tài nguyên tệp kê khai lịch

Cấu hình tài nguyên dùng để xác định nội dung và hành vi của Tiện ích bổ sung của Google Workspace trong Lịch Google. Tệp kê khai tiện ích bổ sung của Google Workspace phải có tất cả các thành phần được đánh dấu là Bắt buộc nếu mở rộng Lịch.

Lịch

Cấu hình tệp kê khai tiện ích bổ sung của Google Workspace cho các tiện ích Lịch Google. Hãy xem bài viết Mở rộng Lịch bằng tiện ích bổ sung của Google Workspace để biết thêm thông tin.

Biểu diễn dưới dạng JSON
{
  "createSettingsUrlFunction": string,
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "currentEventAccess": string,
  "eventOpenTrigger": {
    object (EventOpenTrigger)
  },
  "eventUpdateTrigger": {
    object (EventUpdateTrigger)
  },
  "eventAttachmentTrigger": {
    object (EventAttachmentTrigger)
  },
  "homepageTrigger": {
    object (HomepageTrigger)
  }
}
Trường
createSettingsUrlFunction

string

Chỉ được dùng nếu tiện ích bổ sung cung cấp giải pháp hội nghị truyền hình. Không bắt buộc. Tên của hàm Apps Script tạo ra một URL dẫn đến trang cài đặt của tiện ích bổ sung.

Xem phần Thêm các chế độ cài đặt tiện ích bổ sung cho hội nghị truyền hình để biết thêm thông tin.
conferenceSolution[]

object (ConferenceSolution)

Chỉ được dùng nếu tiện ích bổ sung cung cấp giải pháp hội nghị truyền hình. Nếu có, thì bạn phải xác định ít nhất một giải pháp. Danh sách các giải pháp hội nghị truyền hình mà tiện ích bổ sung cung cấp. Mỗi giải pháp đều có một tuỳ chọn hội nghị truyền hình tương ứng trong giao diện người dùng Chỉnh sửa sự kiện của Lịch Google.
currentEventAccess

string

Xác định cấp truy cập của tiện ích bổ sung vào dữ liệu sự kiện trong dữ liệu do người dùng tạo. Nếu không được cung cấp, sẽ không có siêu dữ liệu sự kiện nào được chuyển đến tiện ích bổ sung. Các chế độ cài đặt hợp lệ như sau:

  • METADATA cho biết tiện ích bổ sung chỉ có quyền truy cập vào siêu dữ liệu cơ bản về sự kiện.
  • READ cho biết rằng tiện ích bổ sung này có thể đọc dữ liệu sự kiện do người dùng tạo (ngoài siêu dữ liệu cơ bản về sự kiện).
  • WRITE cho biết rằng tiện ích bổ sung này có thể ghi dữ liệu sự kiện do người dùng tạo.
  • READ_WRITE cho biết rằng tiện ích bổ sung này có thể đọc và ghi dữ liệu sự kiện do người dùng tạo, cũng như đọc siêu dữ liệu cơ bản.

Nếu bạn đặt thành READ hoặc READ_WRITE, thì tiện ích bổ sung phải có phạm vi https://www.googleapis.com/auth/calendar.addons.current.event.read.

Nếu bạn đặt thành WRITE hoặc READ_WRITE, thì tiện ích bổ sung phải có phạm vi https://www.googleapis.com/auth/calendar.addons.current.event.write.

eventOpenTrigger

object (EventOpenTrigger)

Thông số kỹ thuật về điều kiện kích hoạt cho các điều kiện kích hoạt sự kiện khi mở trong Lịch.

eventUpdateTrigger

object (EventUpdateTrigger)

Đây là yêu cầu bắt buộc để cung cấp giao diện cập nhật sự kiện theo bối cảnh trong Lịch Google. Thông số kỹ thuật của điều kiện kích hoạt cho các điều kiện kích hoạt cập nhật sự kiện trong Lịch.

eventAttachmentTrigger

object (EventAttachmentTrigger)

Thông số kỹ thuật kích hoạt cho các trình kích hoạt tệp đính kèm sự kiện trong Lịch.

homepageTrigger

object (HomepageTrigger)

Thông số kỹ thuật của hàm kích hoạt để tạo trang chủ tiện ích bổ sung trong máy chủ lưu trữ Lịch. Thao tác này sẽ ghi đè addOns.common.homepageTrigger.

ConferenceSolution

Cấu hình của giải pháp hội nghị truyền hình do tiện ích bổ sung cung cấp. Mỗi giải pháp đều có một tuỳ chọn hội nghị truyền hình tương ứng trong giao diện người dùng Chỉnh sửa sự kiện của Lịch Google.

Biểu diễn dưới dạng JSON
{
  "id": string,
  "logoUrl": string,
  "name": string,
  "onCreateFunction": string
}
Trường
id

string

Bắt buộc. Giá trị nhận dạng của giải pháp hội nghị truyền hình. Phải là duy nhất trong nhóm giải pháp hội nghị truyền hình được cung cấp của tiện ích bổ sung. Sau khi chọn mã nhận dạng, bạn sẽ không thay đổi mã đó.
logoUrl

string

Đường liên kết đến biểu tượng đại diện cho giải pháp. Hình ảnh phải có kích thước là 96 x 96 dp.

Đây không được là một URL tuỳ ý – hình ảnh phải được lưu trữ trên cơ sở hạ tầng của Google. Xem phần Cung cấp biểu trưng của giải pháp hội nghị truyền hình để biết thông tin chi tiết.

Nếu được cung cấp, hình ảnh này có thể khác với tiện ích bổ sung calendar.logoUrl (hình ảnh dùng để đại diện cho tiện ích bổ sung trong các ứng dụng lưu trữ mà tiện ích bổ sung mở rộng). Nếu hình ảnh biểu trưng không được cung cấp cho một giải pháp cụ thể, thì hệ thống sẽ sử dụng calendar.logoUrl.
name

string

Bắt buộc. Tên của giải pháp hội nghị truyền hình xuất hiện trong giao diện người dùng của Lịch Google khi người dùng tạo hoặc chỉnh sửa một sự kiện.
onCreateFunction

string

Bắt buộc. Tên của hàm Apps Script được gọi khi Lịch Google cố gắng tạo loại hội nghị truyền hình này. Bạn phải triển khai chức năng này đối với từng giải pháp hội nghị mà tiện ích bổ sung của bạn hỗ trợ.

EventOpenTrigger

Cấu hình cho một điều kiện kích hoạt theo ngữ cảnh sẽ kích hoạt khi người dùng mở một sự kiện trên Lịch Google. Hãy xem phần Mở rộng giao diện sự kiện Lịch để biết thêm thông tin.

Biểu diễn dưới dạng JSON
{
  "runFunction": string
}
Trường
runFunction

string

Tên của chức năng Apps Script sẽ chạy khi người dùng mở một sự kiện trên Lịch để xem hoặc chỉnh sửa. Nếu được chỉ định, bạn phải triển khai hàm này để tạo và trả về một mảng các đối tượng Card để hiển thị trong giao diện người dùng tiện ích bổ sung.

EventUpdateTrigger

Cấu hình cho một điều kiện kích hoạt theo ngữ cảnh sẽ kích hoạt khi người dùng chỉnh sửa và lưu một sự kiện trên Lịch Google. Hãy xem phần Cập nhật sự kiện trên Lịch để biết thêm thông tin.

Biểu diễn dưới dạng JSON
{
  "runFunction": string
}
Trường
runFunction

string

Tên của hàm Apps Script sẽ chạy khi người dùng chỉnh sửa và lưu sự kiện trên Lịch. Nếu được chỉ định, bạn phải triển khai hàm này để tạo và trả về một mảng các đối tượng Card để hiển thị trong giao diện người dùng tiện ích bổ sung.

EventAttachmentTrigger

Cấu hình cho điều kiện kích hoạt theo ngữ cảnh sẽ kích hoạt khi người dùng nhấp vào trình cung cấp tệp đính kèm tiện ích bổ sung trong trình đơn thả xuống của Lịch.

Biểu diễn dưới dạng JSON
{
  "runFunction": string,
  "label": string,
}
Trường
runFunction

string

Bắt buộc. Tên của hàm Apps Script chạy khi người dùng chọn trình cung cấp tệp đính kèm của tiện ích bổ sung trong trình đơn thả xuống của Lịch. Bạn phải triển khai hàm này để tạo và trả về một mảng các đối tượng Card để hiển thị trong giao diện người dùng tiện ích bổ sung.
label

string

Bắt buộc. Văn bản sẽ xuất hiện trong trình đơn thả xuống của Lịch xác định nhà cung cấp tệp đính kèm này.