Tài nguyên tệp kê khai của trình chỉnh sửa

Cấu hình tài nguyên được dùng để xác định nội dung và hành vi của Tiện ích bổ sung trong trình chỉnh sửa. Tệp kê khai tiện ích bổ sung 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 Trình chỉnh sửa.

Các biên tập viên

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

Biểu diễn dưới dạng JSON
{
  "homepageTrigger": {
    object (HomepageTrigger)
  },
  "onFileScopeGrantedTrigger": {
    object (OnFileScopeGrantedTrigger)
  },
    "linkPreviewTriggers": {
    object (LinkPreviewTriggers)
  }
}
Các trường
homepageTrigger

object (HomepageTrigger)

Hàm kích hoạt này tạo trang chủ tiện ích bổ sung trong ứng dụng lưu trữ. Thao tác này sẽ ghi đè addOns.common.homepageTrigger.

onFileScopeGrantedTrigger

object (OnFileScopeGrantedTrigger)

Bắt buộc nếu tiện ích bổ sung của bạn bao gồm hành vi dành riêng cho tài liệu Trình chỉnh sửa hiện tại, được kích hoạt khi người dùng uỷ quyền phạm vi drive.file .

linkPreviewTriggers

object (LinkPreviewTriggers)

Bắt buộc đối với bản xem trước đường liên kết. Xác định mẫu URL xem trước nội dung cho dịch vụ của bên thứ ba hoặc không phải của Google. Để biết thông tin chi tiết, hãy xem bài viết Xem trước đường liên kết trong Google Tài liệu (Bản dùng thử cho nhà phát triển).

OnFileScopeGrantedTrigger

Cấu hình của trình kích hoạt theo ngữ cảnh sẽ kích hoạt khi tiện ích bổ sung hiện hộp thoại phạm vi tệp yêu cầu bằng cách sử dụng CardService.newEditorFileScopeActionResponseBuilder() .requestFileScopeForActiveDocument().build(); và người dùng cấp quyền drive.file.

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

string

Tên của hàm sẽ chạy nếu bạn đã cấp phạm vi drive.file. 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 của tiện ích bổ sung.

Trình kích hoạt đường liên kết xem trước

Cấu hình của trình kích hoạt sẽ kích hoạt khi người dùng nhập hoặc dán liên kết từ dịch vụ của bên thứ ba hoặc không phải của Google vào tài liệu trên Google Tài liệu.

Để thiết lập trình kích hoạt này cho một Tiện ích bổ sung của Google Workspace, hãy xem phần Xem trước đường liên kết trong Google Tài liệu (Bản dùng thử cho nhà phát triển).

Biểu diễn dưới dạng JSON
{
  "labelText": string,
  "runFunction": string,
  "Icon": string,
  "patterns": [
    {
      object(patterns)
    }
  ]
}
Các trường
labelText

string

Bắt buộc. Văn bản của một khối thông minh mẫu sẽ nhắc người dùng xem trước đường liên kết, chẳng hạn như Example: Support case. Văn bản này tĩnh và hiển thị trước khi người dùng thực thi tiện ích bổ sung.
localizedLabelText

map

labelText không bắt buộc được bản địa hoá sang ngôn ngữ khác. Hãy chỉ định ngôn ngữ và mã nhận dạng quốc gia/khu vực theo định dạng mã ngôn ngữ ISO 639ISO 3166 quốc gia/khu vực. Ví dụ: en-US.
runFunction

string

Tên của hàm sẽ chạy khi người dùng uỷ quyền cho phạm vi https://www.googleapis.com/auth/documents.readonly. Nếu được chỉ định, bạn phải triển khai hàm này để chấp nhận đối tượng sự kiện chứa docs.matchedUrl.url làm đối số và trả về một đối tượng Card duy nhất hiển thị bản xem trước đường liên kết trong giao diện người dùng của tiện ích bổ sung.
icon

string

Biểu tượng hiển thị trong khối thông minh. Nếu bạn bỏ qua, khối này sẽ sử dụng biểu tượng thanh công cụ của tiện ích bổ sung, logoUrl.
patterns

object (Patterns)

Bắt buộc. Một loạt các mẫu URL kích hoạt tiện ích bổ sung để xem trước các đường liên kết.

Mẫu

Cấu hình của từng mẫu URL sẽ kích hoạt bản xem trước đường liên kết.

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

string

Bắt buộc đối với mỗi mẫu URL để xem trước.Miền của mẫu URL đó. Các tiện ích xem trước tiện ích bổ sung sẽ liên kết đến miền này. Để xem trước các đường liên kết cho một miền con cụ thể, chẳng hạn như subdomain.example.com, hãy thêm miền con đó. Để xem trước các đường liên kết cho toàn bộ miền, hãy chỉ định một ký tự đại diện có dấu hoa thị (*) làm miền con.

Ví dụ: *.example.com khớp với subdomain.example.comanother.subdomain.example.com.

pathPrefix

string

Đường dẫn sẽ thêm miền của hostPattern (không bắt buộc).

Ví dụ: nếu mẫu máy chủ lưu trữ URL là support.example.com, để khớp với các URL được lưu trữ tại support.example.com/cases/, hãy nhập cases.

Để khớp với tất cả các URL trong miền mẫu máy chủ, hãy để trống pathPrefix.