Tài nguyên tệp kê khai của Tiện ích bổ sung

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. Tệp kê khai Tiện ích bổ sung của Google Workspace phải có tất cả thành phần được đánh dấu là Bắt buộc.

AddOns

Cấp cao nhất của cấu hình tệp kê khai Tiện ích bổ sung của Google Workspace.

Biểu diễn dưới dạng JSON
{
  "common": {
    object (Common)
  },
  "calendar": {
    object (Calendar)
  },
  "drive": {
    object (Drive)
  },
  "gmail": {
    object (Gmail)
  },
  "docs": {
    object (Docs)
  },
  "sheets": {
    object (Sheets)
  },
  "slides": {
    object (Slides)
  }
}
Trường
common

object (Common)

Bắt buộc. Xác định các giá trị phổ biến cho một Tiện ích bổ sung của Google Workspace phổ biến cho mọi ứng dụng lưu trữ. Một số giá trị được xác định ở đây được dùng làm giá trị mặc định khi bạn bỏ qua các giá trị cụ thể cho một máy chủ cụ thể.

calendar

object (Calendar)

Bắt buộc nếu Tiện ích bổ sung của Google Workspace mở rộng Lịch. Cấu hình cho giao diện và hành vi của Tiện ích bổ sung Google Workspace trong ứng dụng lưu trữ Google Lịch. Nếu bạn bỏ qua trường này, thì tiện ích bổ sung sẽ bị tắt trong Lịch Google.

drive

object (Drive)

Bắt buộc nếu Tiện ích bổ sung của Google Workspace mở rộng Google Drive. Cấu hình cho giao diện và hành vi của Tiện ích bổ sung Google Workspace trong ứng dụng lưu trữ Google Drive. Nếu bạn bỏ qua trường này, thì tiện ích bổ sung sẽ bị tắt trong Google Drive.

gmail

object (Gmail)

Bắt buộc nếu Tiện ích bổ sung Google Workspace mở rộng Gmail. Cấu hình cho giao diện và hành vi của Tiện ích bổ sung Google Workspace trong ứng dụng lưu trữ Gmail. Nếu bạn bỏ qua trường này, thì tiện ích bổ sung sẽ bị tắt trong Gmail.

docs

object (Docs)

Bắt buộc nếu Tiện ích bổ sung của Google Workspace mở rộng Tài liệu. Cấu hình cho giao diện và hành vi của Tiện ích bổ sung Google Workspace trong ứng dụng lưu trữ Tài liệu. Nếu bạn bỏ qua trường này, thì tiện ích bổ sung sẽ bị tắt trong Docs.

sheets

object (Sheets)

Bắt buộc nếu Tiện ích bổ sung của Google Workspace mở rộng Trang tính. Cấu hình cho giao diện và hành vi của Tiện ích bổ sung Google Workspace trong ứng dụng lưu trữ Trang tính. Nếu bạn bỏ qua trường này thì tiện ích bổ sung sẽ bị tắt trong Trang tính.

slides

object (Slides)

Bắt buộc nếu Tiện ích bổ sung của Google Workspace mở rộng Trang trình bày. Cấu hình cho giao diện và hành vi của Tiện ích bổ sung Google Workspace trong ứng dụng lưu trữ Trang trình bày. Nếu bạn bỏ qua trường này, thì tiện ích bổ sung sẽ bị tắt trong Trang trình bày.

Phổ biến

Cấu hình tệp kê khai cho các tham số phổ biến đối với mọi ứng dụng lưu trữ. Một số giá trị được xác định ở đây được dùng làm giá trị mặc định khi bạn bỏ qua các giá trị cụ thể cho một máy chủ lưu trữ cụ thể.

Biểu diễn dưới dạng JSON
{
  "homepageTrigger": {
    object (HomepageTrigger)
  },
  "layoutProperties": {
    object (LayoutProperties)
  },
  "logoUrl": string,
  "name": string,
  "openLinkUrlPrefixes": [
    string
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "useLocaleFromApp": boolean
}
Trường
homepageTrigger

object (HomepageTrigger)

Thông số kỹ thuật của hàm điều kiện kích hoạt mặc định để tạo trang chủ của tiện ích bổ sung. Quy cách này được sử dụng nếu bạn không xác định điều kiện kích hoạt trang chủ dành riêng cho máy chủ lưu trữ. Nếu bạn cũng bỏ qua phần này, một thẻ trang chủ chung sẽ được tạo và sử dụng khi cần.
layoutProperties

object (LayoutProperties)

Cấu hình cho các màu được sử dụng trong thanh công cụ và các nút của tiện ích bổ sung.
logoUrl

string

Bắt buộc. URL của hình ảnh xuất hiện trên thanh công cụ. URL phải được công khai.

name

string

Bắt buộc. Tên của tiện ích bổ sung xuất hiện trong thanh công cụ.

openLinkUrlPrefixes[]

string

Bắt buộc nếu tiện ích bổ sung hiển thị bất kỳ đường liên kết ra ngoài nào, cho dù trong các tiện ích sử dụng OpenLink hay tiện ích văn bản sử dụng thẻ ký tự liên kết HTML. Danh sách các tiền tố URL loại HTTPS. Để bảo vệ dữ liệu người dùng, mọi đường liên kết do tiện ích bổ sung hiển thị đều phải khớp với một trong các tiền tố trong danh sách này.

Hãy xem phần Danh sách URL được cho phép để biết thêm thông tin chi tiết.

universalActions[]

object (UniversalAction)

Danh sách các thao tác chung luôn có trong giao diện người dùng của tiện ích bổ sung.
useLocaleFromApp

boolean

Nếu true, đối tượng sự kiện của tiện ích bổ sung được truyền đến hàm gọi lại thao tác hoặc hàm kích hoạt bao gồm thông tin về ngôn ngữ và múi giờ của người dùng. Giá trị mặc định là false.

Hãy xem phần Truy cập vào ngôn ngữ và múi giờ của người dùng để biết thêm thông tin chi tiết.

LayoutProperties

Một cấu hình kiểm soát thanh công cụ Google Workspacetiện ích bổ sung, cũng như màu sắc và hình thức của nút.

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

string

Màu của thanh công cụ. Giá trị mặc định là màu xám (#424242).
secondaryColor

string

Màu mặc định của các nút. Mặc định là màu chính (nếu được đặt); nếu không, mặc định là màu xanh dương (#2196F3).

UniversalAction

Cấu hình cho một hành động chung. Khi được chọn, một thao tác chung sẽ mở đường liên kết URL đã chỉ định hoặc chạy hàm Apps Script đã chỉ định.

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

  // Union field rule can be only one of the following:
  "openLink": string,
  "runFunction": string,
  // End of list of possible types for union field rule.

}
Trường
label

string

Bắt buộc đối với mỗi thao tác chung. Văn bản hiển thị trong trình đơn giao diện người dùng cho thao tác này.
runFunction

string

Bắt buộc đối với mỗi thao tác chung nếu không có openLink. Nếu được cung cấp, tên của hàm Apps Script sẽ thực thi khi người dùng chọn thao tác này.

Xem hướng dẫn về Hành động chung để biết thông tin chi tiết.