Package google.apps.script.type

Chỉ mục

• AddOnWidgetSet (thông báo)
• AddOnWidgetSet.WidgetType (enum)
• CommonAddOnManifest (thông báo)
• CreateActionExtensionPoint (thông báo)
• GranularOauthPermissionSupport (enum)
• HomepageExtensionPoint (thông báo)
• HttpAuthorizationHeader (enum)
• HttpOptions (thông báo)
• LayoutProperties (thông báo)
• LinkPreviewExtensionPoint (thông báo)
• MenuItemExtensionPoint (thông báo)
• UniversalActionExtensionPoint (thông báo)
• UriPattern (thông báo)

AddOnWidgetSet

Tập hợp con tiện ích mà một 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	Bộ tiện ích mặc định.
DATE_PICKER	Bộ chọn ngày.
STYLED_BUTTONS	Các nút có kiểu bao gồm nút được tô màu nền và nút bị vô hiệu hoá.
PERSISTENT_FORMS	Biểu mẫu liên tục cho phép duy trì các giá trị biểu mẫu trong các hành động.
FIXED_FOOTER	Chân trang cố định trong thẻ.
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 chia sẻ 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 xuất hiện trên thanh công cụ của tiện ích bổ sung.
layoutProperties	LayoutProperties Các thuộc tính bố cục chung cho thẻ tiện ích bổ sung.
addOnWidgetSet	AddOnWidgetSet Các tiện ích được dùng trong tiện ích bổ sung. Nếu bạn không chỉ định trường này, hệ thống sẽ sử dụng bộ mặc định.
useLocaleFromApp	bool Có truyền thông tin về ngôn ngữ từ ứng dụng lưu trữ hay không.
homepageTrigger	HomepageExtensionPoint Xác định một điểm cuối sẽ được thực thi trong mọi bối cảnh, trong mọi máy chủ lưu trữ. Người dùng sẽ luôn thấy mọi thẻ do hàm này tạo, nhưng thẻ có thể bị nội dung theo bối cảnh che khuất khi tiện ích bổ sung này khai báo các điều kiện kích hoạt được nhắm đến cụ thể hơn.
universalActions[]	UniversalActionExtensionPoint Xác định danh sách các điểm mở rộng 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 biểu mẫu gửi.
openLinkUrlPrefixes	ListValue Thao tác OpenLink chỉ có thể sử dụng URL có lược đồ HTTPS, MAILTO hoặc TEL. Đối với đườ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 đồ, HTTPS sẽ được giả định. Các đường liên kết HTTP sẽ tự động được 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 Google Workspace. Để biết thêm thông tin, hãy xem bài viết Tạo tài nguyên bên thứ ba bằng 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ể chứa tối đa 64 ký tự và phải có định dạng [a-zA-Z0-9-]+.
labelText	string Bắt buộc. Văn bản hiển thị cùng với biểu tượng cho điểm truy cập tạo tài nguyên, chẳng hạn như Create support case. Văn bản này là văn bản tĩnh và 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. Một bản đồ labelText để bản địa hoá sang các ngôn ngữ khác. Định dạng ngôn ngữ theo tiêu chuẩn ISO 639 và quốc gia/khu vực theo tiêu chuẩn ISO 3166, phân tách bằng dấu gạch ngang -. 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. Điểm cuối để thực thi khi quy trình tạo tài nguyên được kích hoạt để tạo một mối liên kết.
logoUrl	string Không bắt buộc. Biểu tượng xuất hiện cho điểm truy cập tạo tài nguyên. Nếu bạn bỏ qua bước này, trình đơn sẽ sử dụng biểu tượng thanh công cụ của tiện ích bổ sung, logoUrl.

GranularOauthPermissionSupport

Cho biết liệu tiện ích bổ sung có bật tính năng Granular OAuth Consent (Sự đồng ý chi tiết theo OAuth) hay không.

Enum
GRANULAR_OAUTH_PERMISSION_SUPPORT_UNSPECIFIED	Giá trị mặc định, không nên sử dụng.
OPT_IN	Tiện ích bổ sung đã chọn sử dụng tính năng Đồng ý theo giao thức OAuth chi tiết.
OPT_OUT	Tiện ích bổ sung này đã chọn không sử dụng tính năng Đồng ý chi tiết theo giao thức OAuth.

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 sẽ 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 thành false, chế độ xem trang chủ sẽ không hoạt động trong bối cảnh này. Mặc định là true nếu bạn 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ì người dùng sẽ thấy một thẻ tổng quan chung.

HttpAuthorizationHeader

Tiêu đề uỷ quyền được gửi trong các yêu cầu của 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ã nhận dạng (ID) mã thông báo 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	Đừng gửi tiêu đề Xác thực.

HttpOptions

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

Trường
authorizationHeader	HttpAuthorizationHeader Cấu hình cho mã thông báo được gửi trong tiêu đề Uỷ quyền HTTP.
granularOauthPermissionSupport	GranularOauthPermissionSupport Cho biết liệu tiện ích bổ sung có bật tính năng Granular OAuth Consent (Sự đồng ý chi tiết theo OAuth) hay không.

LayoutProperties

Các thuộc tính bố cục thẻ được dùng chung trên tất cả cá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, giá trị mặc định do khung cung cấp sẽ được dùng.
secondaryColor	string Màu phụ của tiện ích bổ sung. API này đặt màu cho các nút. Nếu bạn đặt màu chính nhưng không đặt màu phụ, thì màu phụ 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 dùng.
useNewMaterialDesign (deprecated)	bool Mục này không còn được dùng nữa! Cho phép thiết kế theo ngôn ngữ Material Design cho thẻ.

LinkPreviewExtensionPoint

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ụ của bên thứ ba hoặc dịch vụ không phải của Google vào một 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 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 và 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. 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 -. 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[]	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. Điểm cuối để 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 chip thông minh và thẻ xem trước. Nếu bạn bỏ qua, tiện ích bổ sung sẽ sử dụng biểu tượng trên thanh công cụ, logoUrl.

MenuItemExtensionPoint

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

Trường
runFunction	string Bắt buộc. Điểm cuối sẽ 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 khi 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 xuất hiện trên thanh công cụ của tiện ích bổ sung. Nếu bạn không đặt, thì giá trị mặc định sẽ 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 trình đơn thao tác chung.

Trường
label	string Bắt buộc. Văn bản hiển thị với người dùng mô tả hành động được thực hiện khi kích hoạt điểm mở rộng này, ví dụ: "Thêm người liên hệ mới".
Trường nhóm 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:
openLink	string URL mà UniversalAction sẽ mở.
runFunction	string Điểm cuối sẽ được UniversalAction chạy.

UriPattern

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

Trường
hostPattern	string Bạn cần có mẫu URL để xem trước. Miền của mẫu URL. Tiện ích bổ sung này xem trước những đường liên kết có chứa miền này trong URL. Để xem trướ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 bằng dấu hoa thị (*) làm miền con. Ví dụ: *.example.com khớp với subdomain.example.com và another.subdomain.example.com.
pathPrefix	string Không bắt buộc. Đường dẫn nối 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 các URL cho những trường hợp được lưu trữ tại support.example.com/cases/, hãy nhập cases. Để so khớp tất cả URL trong miền mẫu máy chủ, hãy để trống pathPrefix.