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

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 Google Workspace trong trình chỉnh sửa. Tệp kê khai của Tiện ích bổ sung 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 các thành phần này mở rộng Trình chỉnh sửa.

Trình chỉnh sửa

Cấu hình tệp kê khai của tiện ích bổ sung Google Workspace cho tiện ích Editor. Xem phần Mở rộng Trình chỉnh sửa 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
  {
    "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 sẽ tạo trang chủ của tiện ích bổ sung trong ứng dụng lưu trữ. Tiện ích 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 có hành vi cụ thể đối với tài liệu Trình chỉnh sửa hiện tại, được kích hoạt khi người dùng cho phép 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 một 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 đối với quá trình tạo tài nguyên của bên thứ ba. Danh sách điều kiện kích hoạt để tạo tài nguyên trong dịch vụ của bên thứ ba từ trình đơn @. Để biết thông tin chi tiết, hãy xem bài viết Tạo tài nguyên của bên thứ ba bằng khối thông minh.

OnFileScopeGrantedTrigger

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 hộp thoại yêu cầu phạm vi tệp 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 cần chạy nếu phạm vi drive.file được cấp. 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 gồm các đối tượng Card để hiển thị trong giao diện người dùng của tiện ích bổ sung.

LinkPreviewTriggers

Cấu hình của điều kiện kích hoạt sẽ kích hoạt khi người dùng nhập hoặc dán đường liên kết từ một dịch vụ của bên thứ ba hoặc không phải của Google 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 bài viết 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 của 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 ở dạng tĩnh và sẽ xuất hiện trước khi người dùng thực thi tiện ích bổ sung.
localizedLabelText

map (key: string, value: string)

Không bắt buộc. 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, được phân tách bằng dấu gạch nối -. Ví dụ: en-US

Nếu ngôn ngữ của người dùng có trong các khoá của bản đồ, thì người dùng sẽ thấy phiên bản đã bản địa hoá của labelText.

patterns[]

object (UriPattern)

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.
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. Nếu được chỉ định, bạn phải triển khai hàm này để chấp nhận một đối tượng sự kiện chứa EDITOR_NAME.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.
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ụ logoUrl.

UriPattern

Cấu hình cho mỗi 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 để xem trước.Miền của mẫu URL. Đường liên kết xem trước của tiện ích bổ sung có chứa miền này trong URL. Để 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 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

Không bắt buộc. Đường dẫn thêm miền của hostPattern.

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

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

CreateActionTriggers

Cấu hình của 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 của 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 bài viết 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 để phân biệt điểm tiện ích này. Mã nhận dạng có thể dài tối đa 64 ký tự và phải ở đị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 để 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, được phân tách bằng dấu gạch nối -. Ví dụ: en-US

Nếu ngôn ngữ của người dùng có trong các khoá của bản đồ, thì người dùng sẽ thấy phiên bản đã bản địa hoá của labelText.

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 trên trình đơn @. Hàm sẽ trả về một thẻ biểu mẫu có dữ liệu đầu vào để tạo tài nguyên bên thứ ba.
logoUrl

string

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