Hướng dẫn này giải thích cách tạo một biến đầu vào.
Để chạy, các bước yêu cầu một số thông tin nhất định. Ví dụ: để gửi email, bạn cần có địa chỉ email. Để cung cấp thông tin cần thiết này, hãy xác định các biến đầu vào. Sau khi được xác định, các biến đầu vào thường do người dùng đặt trên thẻ cấu hình của một bước trong khi người dùng thiết lập bước đó.
Xác định biến đầu vào ở 2 vị trí: tệp kê khai của tiện ích bổ sung và trong mã bằng thẻ cấu hình nơi người dùng có thể nhập các giá trị cho biến đầu vào.
Xác định biến đầu vào trong tệp kê khai
Trong tệp kê khai, hãy chỉ định các biến đầu vào bằng mảng inputs[]. Mỗi mục trong mảng inputs[] đều có các thuộc tính sau:
id: Giá trị nhận dạng duy nhất cho một biến đầu vào. Để cho phép luồng liên kết một phần tử đầu vào của thẻ cấu hình với biến đầu vào này, bạn phải khớp tên của phần tử thẻ tương ứng.description: Nội dung mô tả về biến đầu vào sẽ hiển thị cho người dùng cuối.cardinality: Số lượng giá trị được phép. Các giá trị có thể sử dụng là:SINGLE: Bạn chỉ được phép gửi một giá trị.
dataType: Loại giá trị được chấp nhận.dataTypecó thuộc tínhbasicTypexác định loại dữ liệu. Các giá trị hợp lệ bao gồm:STRING: Một chuỗi dạng chữ và số.INTEGER: Một số.TIMESTAMP: Dấu thời gian ở định dạng ISO 8601. Ví dụ: trong ISO 8601, ngày 15 tháng 3 năm 2025 được biểu thị là 2025-03-15.BOOLEAN: True hoặc false.EMAIL_ADDRESS: Địa chỉ email ở định dạngdana@example.com.
Ví dụ sau đây xác định 3 biến đầu vào cho một bước tính toán. Hai biến đầu vào đầu tiên là số nguyên và biến thứ ba là một phép toán số học.
JSON
{
"timeZone": "America/Los_Angeles",
"exceptionLogging": "STACKDRIVER",
"runtimeVersion": "V8",
"addOns": {
"common": {
"name": "Calculator",
"logoUrl": "https://www.gstatic.com/images/branding/productlogos/calculator_search/v1/web-24dp/logo_calculator_search_color_1x_web_24dp.png",
"useLocaleFromApp": true
},
"flows": {
"workflowElements": [
{
"id": "actionElement",
"state": "ACTIVE",
"name": "Calculate",
"description": "Asks the user for two values and a math operation, then performs the math operation on the values and outputs the result.",
"workflowAction": {
"inputs": [
{
"id": "value1",
"description": "value1",
"cardinality": "SINGLE",
"dataType": {
"basicType": "INTEGER"
}
},
{
"id": "value2",
"description": "value2",
"cardinality": "SINGLE",
"dataType": {
"basicType": "INTEGER"
}
},
{
"id": "operation",
"description": "operation",
"cardinality": "SINGLE",
"dataType": {
"basicType": "STRING"
}
}
],
"outputs": [
{
"id": "result",
"description": "Calculated result",
"cardinality": "SINGLE",
"dataType": {
"basicType": "INTEGER"
}
}
],
"onConfigFunction": "onConfigCalculate",
"onExecuteFunction": "onExecuteCalculate"
}
}
]
}
}
}
Xác định biến đầu vào trong mã
Mã của bước này bao gồm một hàm có tên là onConfigFunction(), trả về một thẻ cấu hình xác định một tiện ích thẻ đầu vào cho mỗi biến đầu vào được xác định trong mảng inputs[] của tệp kê khai.
Các tiện ích đầu vào được xác định trong thẻ cấu hình có các yêu cầu sau:
namecủa mỗi tiện ích đầu vào phải khớp vớiidcủa biến đầu vào tương ứng trong tệp kê khai.- Số lượng phần tử của tiện ích đầu vào phải khớp với
cardinalitycủa biến đầu vào trong tệp kê khai. - Loại dữ liệu của tiện ích đầu vào phải khớp với
dataTypecủa biến đầu vào trong tệp kê khai. Nếu biến đầu vào códataTypelà số nguyên, thì biến đó không thể chứa một chuỗi.
Để được trợ giúp về cách tạo giao diện thẻ, hãy xem một trong các lựa chọn sau:
- Trình tạo thẻ: Một công cụ tương tác mà bạn có thể dùng để tạo và xác định thẻ.
- Thẻ: trong tài liệu tham khảo về API tiện ích bổ sung Google Workspace.
- Dịch vụ thẻ: Một dịch vụ Apps Script cho phép tập lệnh định cấu hình và tạo thẻ.
- Tổng quan về giao diện dựa trên thẻ: trong tài liệu dành cho nhà phát triển tiện ích bổ sung Google Workspace.
Ví dụ sau đây trả về một thẻ cấu hình cho mỗi tiện ích đầu vào được xác định trong Xác định biến đầu vào trong tệp kê khai.
Apps Script
/**
* Generates and displays a configuration card for the sample calculation step.
*
* This function creates a card with input fields for two values and a drop-down
* for selecting an arithmetic operation. The card also includes a "Save"
* button to save the step configuration for the workflow.
*
* The input fields are configured to let the user select outputs from previous
* workflow steps as input values using the `hostAppDataSource` property.
*/
function onConfigFunction() {
var card = {
"sections": [
{
"header": "Step example: Calculate",
"widgets": [
{
"textInput": {
"name": "value1", // "name" must match an "id" in the manifest file's inputs[] array.
"label": "First value",
"hostAppDataSource" : {
"workflowDataSource" : {
"includeVariables" : true
}
}
}
},
{
"selectionInput": {
"name": "operation", // "name" must match an "id" in the manifest file's inputs[] array.
"label": "Operation",
"type": "DROPDOWN",
"items": [
{
"text": "+",
"value": "+",
},
{
"text": "-",
"value": "-",
},
{
"text": "x",
"value": "x",
},
{
"text": "/",
"value": "/",
}
]
}
},
{
"textInput": {
"name": "value2", // "name" must match an "id" in the manifest file's inputs[] array.
"label": "Second value",
"hostAppDataSource" : {
"workflowDataSource" : {
"includeVariables" : true
}
}
}
}
]
}
]
};
return {
"action": {
"navigations": [{
"push_card": card
}]
}
};
}
Xác thực biến đầu vào
Tốt nhất là bạn nên xác thực để đảm bảo người dùng nhập một giá trị phù hợp. Xem phần Xác thực một biến đầu vào.