Package google.apps.script.type

Chỉ mục

AddOnWidgetSet

Tập hợp con tiện ích mà tiện ích bổ sung sử dụng.

Trường
usedWidgets[]

WidgetType

Danh sách các tiện ích được dùng trong một tiện ích bổ sung.

WidgetType

Loại tiện ích. WIDGET_TYPE_UNSPECIFIED là bộ tiện ích cơ bản.

Enum
WIDGET_TYPE_UNSPECIFIED Đã đặt tiện ích mặc định.
DATE_PICKER Bộ chọn ngày.
STYLED_BUTTONS Các nút có kiểu cách bao gồm nút được tô màu nền và nút đã tắt.
PERSISTENT_FORMS Biểu mẫu cố định giúp các giá trị biểu mẫu được duy trì trong suốt hành động.
UPDATE_SUBJECT_AND_RECIPIENTS Cập nhật tiêu đề và người nhận của thư nháp.
GRID_WIDGET Tiện ích lưới.
ADDON_COMPOSE_UI_ACTION Một thao tác của tiện ích bổ sung Gmail áp dụng cho giao diện người dùng soạn thư của tiện ích bổ sung.

CommonAddOnManifest

Cấu hình tiện ích bổ sung được dùng chung trên tất cả các ứng dụng lưu trữ tiện ích bổ sung.

Trường
name

string

Bắt buộc. Tên hiển thị của tiện ích bổ sung.

logoUrl

string

Bắt buộc. URL của hình ảnh biểu trưng hiển thị trên thanh công cụ của tiện ích bổ sung.

layoutProperties

LayoutProperties

Thuộc tính bố cục phổ biến của thẻ tiện ích bổ sung.

addOnWidgetSet

AddOnWidgetSet

Các tiện ích được sử dụng trong tiện ích bổ sung. Nếu trường này không được chỉ định, giá trị mặc định sẽ được sử dụng.

useLocaleFromApp

bool

Liệu có truyền thông tin ngôn ngữ từ ứng dụng lưu trữ hay không.

homepageTrigger

HomepageExtensionPoint

Xác định điểm cuối sẽ được thực thi trong mọi ngữ cảnh, trên máy chủ bất kỳ. Người dùng luôn có thể sử dụng bất kỳ thẻ nào do hàm này tạo, nhưng có thể bị nội dung theo ngữ cảnh che khuất khi tiện ích bổ sung này khai báo trình kích hoạt được nhắm mục tiêu nhiều hơn.

universalActions[]

UniversalActionExtensionPoint

Xác định danh sách các điểm tiện ích trong trình đơn thao tác chung đóng vai trò là trình đơn cài đặt cho tiện ích bổ sung. Điểm mở rộng có thể là một URL liên kết để mở hoặc một điểm cuối để thực thi dưới dạng lượt gửi biểu mẫu.

openLinkUrlPrefixes

ListValue

Thao tác OpenLink chỉ có thể sử dụng URL có lược đồ HTTPS, MAILTO hoặc TEL. Đối với các đường liên kết HTTPS, URL cũng phải khớp với một trong các tiền tố được chỉ định trong danh sách cho phép. Nếu tiền tố bỏ qua lược đồ, thì HTTPS sẽ được giả định. Đường liên kết HTTP được tự động viết lại thành đường liên kết HTTPS.

CreateActionExtensionPoint

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 gọi quy trình tạo tài nguyên trong một ứng dụng của Google Workspace. Để biết thêm thông tin, hãy xem phần Tạo tài nguyên bên thứ ba từ trình đơn @.

Trường
id

string

Bắt buộc. Mã nhận dạng duy nhất để phân biệt điểm mở rộng 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 cùng với một biểu tượng cho điểm truy cập tài nguyên, chẳng hạn như Create 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<string, 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 xuất hiện 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. Điểm cuối cần thực thi khi quy trình tạo tài nguyên được kích hoạt để tạo mối liên kết.

logoUrl

string

Không bắt buộc. Biểu tượng hiển thị điểm truy cập tạo tài nguyên. Nếu bạn bỏ qua, trình đơn này sẽ sử dụng biểu tượng thanh công cụ của tiện ích bổ sung, logoUrl.

HomepageExtensionPoint

Định dạng phổ biến để khai báo chế độ xem trang chủ của tiện ích bổ sung.

Trường
runFunction

string

Bắt buộc. Điểm cuối cần thực thi khi điểm mở rộng này được kích hoạt.

enabled

BoolValue

Không bắt buộc. Nếu bạn đặt chính sách này thành false, hãy tắt chế độ xem trang chủ trong trường hợp này.

Giá trị mặc định là true nếu không đặt.

Nếu chế độ xem trang chủ tuỳ chỉnh của một tiện ích bổ sung bị tắt, thì thẻ tổng quan chung sẽ được cung cấp cho người dùng.

HttpAuthorizationHeader

Tiêu đề uỷ quyền được gửi trong các yêu cầu tiện ích bổ sung HTTP.

Enum
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED Giá trị mặc định, tương đương với SYSTEM_ID_TOKEN.
SYSTEM_ID_TOKEN Gửi mã thông báo mã nhận dạng cho tài khoản dịch vụ hệ thống của Tiện ích bổ sung Google Workspace dành riêng cho dự án (mặc định).
USER_ID_TOKEN Gửi mã thông báo nhận dạng cho người dùng cuối.
NONE Không gửi tiêu đề Xác thực.

HttpOptions

Các tuỳ chọn gửi yêu cầu đến các điểm cuối của tiện ích bổ sung HTTP.

Trường
authorizationHeader

HttpAuthorizationHeader

Cấu hình của mã thông báo được gửi trong tiêu đề Uỷ quyền HTTP.

LayoutProperties

Thuộc tính bố cục thẻ dùng chung trên tất cả ứng dụng lưu trữ tiện ích bổ sung.

Trường
primaryColor

string

Màu chính của tiện ích bổ sung. Thao tác này sẽ đặt màu cho thanh công cụ. Nếu bạn không đặt màu chính, thì giá trị mặc định do khung cung cấp sẽ được sử dụng.

secondaryColor

string

Màu phụ của tiện ích bổ sung. Chế độ này đặt màu cho các nút. Nếu màu chính được đặt nhưng chưa đặt màu phụ, thì màu cấp hai sẽ giống với màu chính. Nếu bạn không đặt màu chính và màu phụ, thì giá trị mặc định do khung cung cấp sẽ được sử dụng.

useNewMaterialDesign

bool

Bật thiết kế Material Design cho thẻ.

LinkPreviewExtensionPoint

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 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 Google Tài liệu, Trang tính hoặc Trang trình bày.

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<string, 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 xuất hiện 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[]

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. Điểm cuối cần thực thi khi bản xem trước đường liên kết được kích hoạt.

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.

Định dạng phổ biến để khai báo một mục hoặc nút trong trình đơn xuất hiện trong ứng dụng lưu trữ.

Trường
runFunction

string

Bắt buộc. Điểm cuối cần thực thi khi điểm mở rộng này được kích hoạt.

label

string

Bắt buộc. Văn bản mà người dùng nhìn thấy, mô tả hành động được thực hiện bằng cách kích hoạt điểm mở rộng này. Ví dụ: "Chèn hoá đơn".

logoUrl

string

URL của hình ảnh biểu trưng hiển thị trên thanh công cụ của tiện ích bổ sung.

Nếu bạn không đặt chính sách này, thì hệ thống sẽ đặt URL mặc định là URL biểu trưng chính của tiện ích bổ sung.

UniversalActionExtensionPoint

Định dạng để khai báo một điểm mở rộng mục trong trình đơn thao tác chung.

Trường
label

string

Bắt buộc. Văn bản mà người dùng nhìn thấy, mô tả hành động được thực hiện bằng cách kích hoạt điểm mở rộng này (ví dụ: "Thêm một người liên hệ mới").

Trường hợp action_type. Bắt buộc. Loại thao tác được hỗ trợ trên một mục trong trình đơn thao tác chung. Đó có thể là một đường liên kết để mở hoặc một điểm cuối để thực thi. action_type chỉ có thể là một trong những trạng thái sau:
runFunction

string

Điểm cuối sẽ do UniversalAction chạy.

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.

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, thì để so khớp URL cho các trường hợp được lưu trữ tại support.example.com/cases/, hãy nhập cases.

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