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 Google Workspace trong trình chỉnh sửa. Tệp kê khai tiện ích bổ sung của Google Workspace phải bao gồm tất cả các thành phần được đánh dấu là Bắt buộc nếu chúng mở rộng Trình chỉnh sửa.

Trình chỉnh sửa

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

Biểu diễn dưới dạng JSON
  {
    "homepageTrigger": {
      object (HomepageTrigger)
    },
    "onFileScopeGrantedTrigger": {
      object (OnFileScopeGrantedTrigger)
    },
    "linkPreviewTriggers": [
      {
        object (LinkPreviewTriggers)
      }
    ],
    "createActionTriggers": [
      {
        object (CreateActionTriggers)
      }
  }
Trường
homepageTrigger

object (HomepageTrigger)

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

onFileScopeGrantedTrigger

object (OnFileScopeGrantedTrigger)

Bắt buộc nếu tiện ích bổ sung có hành vi dành riêng cho tài liệu hiện tại, được kích hoạt khi người dùng uỷ quyền cho 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. Danh sách các điều kiện kích hoạt để xem trước đường liên kết trong tệp Google Tài liệu, Trang tính hoặc Trang trình bày. Để biết thông tin chi tiết, hãy xem bài viết Xem trước đường liên kết bằng khối thông minh.

createActionTriggers[]

object (createActionTriggers)

Bắt buộc để tạo tài nguyên bên thứ ba. Danh sách các điều kiện kích hoạt để tạo tài nguyên trong một dịch vụ của bên thứ ba thông qua trình đơn @. Để biết thông tin chi tiết, hãy xem phần Tạo tài nguyên bên thứ ba bằng khối thông minh.

OnFileScopeGrantedTrigger

Một cấu hình cho một điều kiện kích hoạt theo bối cảnh sẽ kích hoạt khi hộp thoại phạm vi tệp yêu cầu sử dụng CardService.newEditorFileScopeActionResponseBuilder().requestFileScopeForActiveDocument().build(); và người dùng cấp quyền uỷ quyền phạm vi drive.file.

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

string

Tên của hàm sẽ chạy nếu phạm vi drive.file được cấp. Hàm này phải trả về một mảng các đối tượng Card cho giao diện người dùng.

LinkPreviewTriggers

Cấu hình cho một điều kiện kích hoạt sẽ hoạt động khi người dùng nhập hoặc dán một đường liên kết từ dịch vụ bên thứ ba vào tệp Tài liệu, Trang tính hoặc Trang trình bày.

Để thiết lập điều kiện 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 bằng khối thông minh.

Biểu diễn dưới dạng JSON
{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string,
  "patterns": [
    {
      object(patterns)
    }
  ]
}
Trường
labelText

string

Bắt buộc. Văn bản cho một khối thông minh mẫu 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 là văn bản tĩnh.
localizedLabelText

map (key: string, value: string)

Không bắt buộc. Một bản đồ labelText để bản địa hoá sang các ngôn ngữ khác. Định dạng ngôn ngữ theo ISO 639 và quốc gia/khu vực theo ISO 3166, phân tách bằng dấu gạch ngang -.
patterns[]

object (UriPattern)

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

string

Bắt buộc. Tên của hàm sẽ chạy khi người dùng cho phép phạm vi https://www.googleapis.com/auth/workspace.linkpreview. Hàm này phải chấp nhận một đối tượng sự kiện, bao gồm một thuộc tính matchedUrl.url chứa URL để xem trước và trả về một đối tượng Card.
logoUrl

string

Không bắt buộc. Biểu tượng xuất hiện trong khối thông minh và thẻ xem trước. Nếu bị bỏ qua, tiện ích bổ sung sẽ sử dụng biểu tượng thanh công cụ của tiện ích, logoUrl.

UriPattern

Cấu hình cho từng mẫu URL kích hoạt tính năng xem trước đường liên kết.

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

string

Bắt buộc đối với mỗi mẫu URL. Miền mẫu URL. Tiện ích bổ sung này xem trước các đường liên kết có chứa miền này. Để so khớp tất cả các miền con, hãy sử dụng dấu hoa thị dưới dạng ký tự đại diện (*).
pathPrefix

string

Không bắt buộc. Đường dẫn nối thêm vào miền. Để so khớp tất cả URL trong miền, hãy để trống pathPrefix.

CreateActionTriggers

Cấu hình cho một điều kiện kích hoạt sẽ kích hoạt khi người dùng chọn một mục trong trình đơn tích hợp bên thứ ba trong trình đơn @ của Google Tài liệu.

Để thiết lập điều kiện kích hoạt này cho một tiện ích bổ sung của Google Workspace, hãy xem phần Tạo tài nguyên bên thứ ba bằng khối thông minh.

Biểu diễn dưới dạng JSON
{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string,
}
Trường
id

string

Bắt buộc. Mã nhận dạng duy nhất cho điểm mở rộng này. Sử dụng tối đa 64 ký tự ở định dạng [a-zA-Z0-9-]+..
labelText

string

Bắt buộc. Văn bản xuất hiện trong trình đơn @, chẳng hạn như Create support case.
localizedLabelText

map (key: string, value: string)

Không bắt buộc. Bản đồ labelText cần được bản địa hoá. Định dạng ngôn ngữ theo ISO 639 và quốc gia/khu vực theo ISO 3166, được phân tách bằng dấu gạch ngang -.
runFunction

string

Bắt buộc. Tên của hàm sẽ chạy khi người dùng chọn một điểm mở rộng. Hàm này phải trả về một thẻ biểu mẫu.
logoUrl

string

Không bắt buộc. Biểu tượng xuất hiện trong trình đơn @. Nếu bạn bỏ qua, tiện ích bổ sung sẽ sử dụng biểu tượng thanh công cụ của tiện ích, logoUrl.