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

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

Lịch

Cấu hình Google Workspace Tệp kê khai bổ sung cho tiện ích Lịch Google. Hãy xem phần Mở rộng lịch bằng Google Workspace Tiện ích bổ sung để 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)
  }
}
Các trường
createSettingsUrlFunction

string

Chỉ được sử dụng nếu tiện ích bổ sung cung cấp các 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 URL dẫn đến một trang cài đặt cho tiện ích bổ sung.

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

object (ConferenceSolution)

Chỉ được sử dụng nếu tiện ích bổ sung cung cấp các giải pháp hội nghị truyền hình; nếu có, 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ị do tiện ích bổ sung cung cấp. Mỗi giải pháp sẽ có một tuỳ chọn hội nghị tương ứng được hiển thị trong giao diện người dùng Edit Event (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 đối với dữ liệu sự kiện 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 tới tiện ích bổ sung. Các chế độ cài đặt hợp lệ là:

  • 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 tiện ích bổ sung 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 tiện ích bổ sung có thể ghi dữ liệu sự kiện do người dùng tạo.
  • READ_WRITE cho biết tiện ích bổ sung 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 được đặt thành READ hoặc READ_WRITE, tiện ích bổ sung phải có phạm vi https://www.googleapis.com/auth/calendar.addons.current.event.read.

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

eventOpenTrigger

object (EventOpenTrigger)

Quy cách trình kích hoạt cho trình kích hoạt mở sự kiện trong Lịch.

eventUpdateTrigger

object (EventUpdateTrigger)

Bắt buộc khi cung cấp giao diện cập nhật sự kiện theo ngữ cảnh trong Lịch Google. Quy cách trình kích hoạt cho các trình kích hoạt cập nhật sự kiện trong Lịch.

eventAttachmentTrigger

object (EventAttachmentTrigger)

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

homepageTrigger

object (HomepageTrigger)

Quy cách hàm kích hoạt để tạo trang chủ tiện ích bổ sung trong máy chủ Lịch. Thao tác này sẽ ghi đè addOns.common.homepageTrigger.

Giải pháp hội nghị

Cấu hình của một giải pháp hội nghị do tiện ích bổ sung cung cấp. Mỗi giải pháp có một tuỳ chọn hội nghị truyền hình tương ứng được hiển thị trong giao diện người dùng Edit Event (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
}
Các trường
id

string

Required. Giá trị nhận dạng cho giải pháp hội nghị truyền hình. Phải là duy nhất trong bộ giải pháp hội nghị bổ sung được cung cấp. Sau khi chọn, bạn không nên thay đổi mã nhận dạng.
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 96 x 96 dp.

Đây không được là URL tùy ý—hình ảnh phải được lưu trữ trên cơ sở hạ tầng của Google. Hãy xem phần Cung cấp biểu trưng giải pháp hội nghị để biết thêm 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 này được dùng để đại diện cho tiện ích bổ sung trong các ứng dụng máy chủ mà tiện ích mở rộng. Nếu hình ảnh biểu tượng không được cung cấp cho một giải pháp cụ thể, thì calendar.logoUrl sẽ được sử dụng.
name

string

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

string

Required. 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ị này. Bạn phải triển khai hàm này cho từng giải pháp hội nghị mà tiện ích bổ sung của bạn hỗ trợ.

Trình mở sự kiện

Cấu hình cho trình 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 bài viết Mở rộng giao diện 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
}
Các trường
runFunction

string

Tên của hàm 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 loạt các đối tượng Card để hiển thị trong giao diện người dùng bổ sung.

Trình cập nhật sự kiện

Cấu hình cho trình 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 sự kiện trên Lịch Google. Hãy xem bài viết 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
}
Các 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 bổ sung.

Trình kích hoạt sự kiện đính kèm

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

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

string

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

string

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