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à tập hợp 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 tạo 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 ổn định cho phép lưu giữ các giá trị biểu mẫu trong quá trình thực hiện 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 Thao tác 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ả ứ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ị trong thanh công cụ của tiện ích bổ sung.

layoutProperties

LayoutProperties

Các thuộc tính bố cục phổ biến cho thẻ bổ sung.

addOnWidgetSet

AddOnWidgetSet

Các tiện ích được sử dụng trong tiện ích bổ sung. Nếu bạn không chỉ định trường này, thì tập hợp 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 một điểm cuối sẽ được thực thi trong bất kỳ ngữ cảnh nào, trên bất kỳ máy chủ nào. Mọi thẻ do hàm này tạo ra sẽ luôn có sẵn cho người dùng, nhưng có thể bị nội dung theo bối cảnh làm lu mờ khi tiện ích bổ sung này khai báo các trình kích hoạt được nhắm mục tiêu 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à URL đường liên kết để mở hoặc điểm cuối để thực thi dưới dạng một 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 đườ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 giao thức, thì 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 của 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ể chứa 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 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à hiển thị 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, 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. Điểm cuối để thực thi khi quy trình tạo tài nguyên được kích hoạt để tạo đường liên kết.

logoUrl

string

Không bắt buộc. Biểu tượng hiển thị cho điểm truy cập tạo tài nguyên. Nếu bạn bỏ qua, trình đơn 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 thành phần hiển thị trang chủ của tiện ích bổ sung.

Trường
runFunction

string

Bắt buộc. Điểm cuối để 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 được đặt thành false, chế độ xem trang chủ sẽ bị vô hiệu hoá trong ngữ cảnh này.

Mặc định là true nếu không được đặt.

Nếu chế độ xem trang chủ tuỳ chỉnh của một tiện ích 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 HTTP của tiện ích bổ sung.

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 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 đ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.

LayoutProperties

Các thuộc tính bố cục thẻ được chia sẻ 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. Thuộc tính này đặt màu của 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. Thuộc tính này đặt màu của 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 hay màu phụ, thì giá trị mặc định do khung cung cấp sẽ được sử dụng.

useNewMaterialDesign

bool

Bật Material Design cho thẻ.

LinkPreviewExtensionPoint

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ụ 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 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à hiển thị 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, 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[]

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 hiển thị trong khối 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 thanh công cụ của tiện ích đó, logoUrl.

Định dạng phổ biến để khai báo một mục hoặc nút 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 để 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 hiển thị cho người dùng 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ị trong thanh công cụ của tiện ích bổ sung.

Nếu không được đặt, 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 đ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 bằng cách kích hoạt điểm mở rộng này, ví dụ: "Thêm người liên hệ mới".

Trường hợp hợp nhất action_type. Bắt buộc. Loại thao tác được hỗ trợ trên một mục 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 giá trị sau:
runFunction

string

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

UriPattern

Cấu hình cho mỗi mẫu URL kích hoạt bản 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. Tiện ích bổ sung này xem trước các đườ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 đường liên kết cho toàn bộ miền, hãy chỉ định một 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 nối 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 nhập cases.

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