Class TextInput

ข้อความอินพุต

วิดเจ็ตช่องป้อนข้อมูลที่ยอมรับอินพุตข้อความ

รองรับการตรวจสอบการส่งแบบฟอร์ม เมื่อตั้งค่า Action.setAllWidgetsAreRequired(allWidgetsAreRequired) เป็น true หรือระบุวิดเจ็ตนี้ผ่าน Action.addRequiredWidget(requiredWidget) ระบบจะบล็อกการดำเนินการส่ง เว้นแต่จะป้อนค่า

พร้อมให้บริการสำหรับส่วนเสริมของ Google Workspace และแอป Google Chat 

const textInput = CardService.newTextInput()
                      .setFieldName('text_input_form_input_key')
                      .setTitle('Text input title')
                      .setHint('Text input hint');

เมธอด

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
setFieldName(fieldName)TextInputกำหนดคีย์ที่ระบุข้อความที่ป้อนนี้ในออบเจ็กต์เหตุการณ์ที่สร้างขึ้นเมื่อมีการโต้ตอบ UI
setHint(hint)TextInputตั้งค่าคำแนะนำสำหรับการป้อนข้อความ
setHostAppDataSource(hostAppDataSource)TextInputตั้งค่าแหล่งข้อมูลจากแอปพลิเคชัน Google Workspace
setMultiline(multiline)TextInputกำหนดว่าข้อความที่ป้อนจะแสดงในบรรทัดเดียวหรือหลายบรรทัด
setOnChangeAction(action)TextInputกำหนดการดำเนินการที่จะทำทุกครั้งที่การป้อนข้อความเปลี่ยนแปลง
setSuggestions(suggestions)TextInputตั้งค่าคำแนะนำสำหรับการเติมข้อความอัตโนมัติในช่องข้อความ
setSuggestionsAction(suggestionsAction)TextInputตั้งค่าการดำเนินการเรียกกลับเพื่อดึงคำแนะนำตามข้อมูลที่ผู้ใช้ป้อนสำหรับการเติมข้อความอัตโนมัติ
setTitle(title)TextInputตั้งค่าชื่อที่จะแสดงเหนือช่องป้อนข้อมูล
setValidation(validation)TextInputตั้งค่ากฎการตรวจสอบสำหรับวิดเจ็ตนี้
setValue(value)TextInputตั้งค่าที่กรอกไว้ล่วงหน้าที่จะตั้งในช่องป้อนข้อมูล

เอกสารโดยละเอียด

setFieldName(fieldName)

กำหนดคีย์ที่ระบุข้อความที่ป้อนนี้ในออบเจ็กต์เหตุการณ์ที่สร้างขึ้นเมื่อมีการโต้ตอบ UI ผู้ใช้จะมองไม่เห็นข้อมูลนี้ ต้องระบุและต้องไม่ซ้ำกัน

พารามิเตอร์

ชื่อประเภทคำอธิบาย
fieldNameStringคีย์ที่ใช้เพื่อระบุอินพุตนี้

รีเทิร์น

TextInput - ออบเจ็กต์นี้สำหรับการเชื่อมโยง

setHint(hint)

ตั้งค่าคำแนะนำสำหรับการป้อนข้อความ ใช้เพื่อให้คำแนะนำเพิ่มเติมแก่ผู้ใช้เกี่ยวกับสิ่งที่ต้องป้อน เช่น คำใบ้อาจอธิบายการจัดรูปแบบ ("xxx-xxx-xxxx") สำหรับช่องหมายเลขโทรศัพท์

พารามิเตอร์

ชื่อประเภทคำอธิบาย
hintStringคำแนะนำข้อความที่จะแสดงใต้ช่องป้อนข้อมูล ข้อความนี้จะแสดงอยู่เสมอ

รีเทิร์น

TextInput - ออบเจ็กต์นี้สำหรับการเชื่อมโยง

setHostAppDataSource(hostAppDataSource)

ตั้งค่าแหล่งข้อมูลจากแอปพลิเคชัน Google Workspace ปัจจุบันรองรับผู้ใช้และพื้นที่ Chat

พร้อมใช้งานผ่านโปรแกรม Gemini เวอร์ชันอัลฟ่าสำหรับส่วนเสริม Google Workspace ที่ขยาย Google Workspace Flow เท่านั้น 

const workflowDataSource =
    CardService.newWorkflowDataSource().setIncludeVariables(true);

const hostAppDataSource =
    CardService.newHostAppDataSource().setWorkflowDataSource(workflowDataSource);

const textInput = CardService.newTextInput()
                      .setFieldName('text_input_form_input_key')
                      .setTitle('Text input title')
                      .setHint('Text input hint')
                      .setHostAppDataSource(hostAppDataSource);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
hostAppDataSourceHostAppDataSourceแหล่งข้อมูล

รีเทิร์น

TextInput - ออบเจ็กต์นี้สำหรับการเชื่อมโยง

setMultiline(multiline)

กำหนดว่าข้อความที่ป้อนจะแสดงในบรรทัดเดียวหรือหลายบรรทัด

พารามิเตอร์

ชื่อประเภทคำอธิบาย
multilineBooleanการตั้งค่าหลายบรรทัด

รีเทิร์น

TextInput - ออบเจ็กต์นี้สำหรับการเชื่อมโยง

setOnChangeAction(action)

กำหนดการดำเนินการที่จะทำทุกครั้งที่การป้อนข้อความเปลี่ยนแปลง

พารามิเตอร์

ชื่อประเภทคำอธิบาย
actionActionการดำเนินการที่ต้องทำ

รีเทิร์น

TextInput - ออบเจ็กต์นี้สำหรับการเชื่อมโยง

setSuggestions(suggestions)

ตั้งค่าคำแนะนำสำหรับการเติมข้อความอัตโนมัติในช่องข้อความ

พารามิเตอร์

ชื่อประเภทคำอธิบาย
suggestionsSuggestionsชุดคำแนะนำที่จะใช้

รีเทิร์น

TextInput - ออบเจ็กต์นี้สำหรับการเชื่อมโยง

setSuggestionsAction(suggestionsAction)

ตั้งค่าการดำเนินการเรียกกลับเพื่อดึงคำแนะนำตามข้อมูลที่ผู้ใช้ป้อนสำหรับการเติมข้อความอัตโนมัติ พารามิเตอร์ Action ต้องระบุฟังก์ชัน Callback ที่แสดงผลออบเจ็กต์ SuggestionsResponse 

const action = CardService.newAction()
                   .setFunctionName('suggestionCallback')
                   .setParameters({numSuggestions: 3});

CardService.newTextInput()
    .setFieldName('option-field')
    .setTitle('Option Selected')
    .setSuggestionsAction(action);

// ...

function suggestionCallback(e) {
  const suggestions = CardService.newSuggestions();
  const numSuggestions = Number.parseInt(e.parameter.numSuggestions);
  for (let i = 1; i <= numSuggestions; i++) {
    suggestions.addSuggestion(`Suggestion ${i}`);
  }
  return CardService.newSuggestionsResponseBuilder()
      .setSuggestions(suggestions)
      .build();
}

พารามิเตอร์

ชื่อประเภทคำอธิบาย
suggestionsActionActionการดำเนินการที่ดึงข้อมูลคำแนะนำสำหรับการป้อนข้อมูลนี้

รีเทิร์น

TextInput - ออบเจ็กต์นี้สำหรับการเชื่อมโยง

setTitle(title)

ตั้งค่าชื่อที่จะแสดงเหนือช่องป้อนข้อมูล ต้องระบุ

พารามิเตอร์

ชื่อประเภทคำอธิบาย
titleStringป้ายกำกับข้อความสำหรับอินพุตนี้

รีเทิร์น

TextInput - ออบเจ็กต์นี้สำหรับการเชื่อมโยง

setValidation(validation)

ตั้งค่ากฎการตรวจสอบสำหรับวิดเจ็ตนี้ 

const validation = CardService.newValidation().setCharacterLimit('10').setType(
    CardService.InputType.TEXT);

const input = CardService.newTextInput()
                  .setFieldName('text_name_xxx1')
                  .setTitle('Max 10 characters')
                  .setValidation(validation);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
validationValidationกฎการตรวจสอบสำหรับวิดเจ็ต TextInput นี้

รีเทิร์น

TextInput - ออบเจ็กต์นี้สำหรับการเชื่อมโยง

setValue(value)

ตั้งค่าที่กรอกไว้ล่วงหน้าที่จะตั้งในช่องป้อนข้อมูล

พารามิเตอร์

ชื่อประเภทคำอธิบาย
valueStringค่าเริ่มต้นที่ป้อนในอินพุต โดยจะแสดงเป็นสตริงใน พารามิเตอร์การเรียกกลับของแบบฟอร์มเสมอ

รีเทิร์น

TextInput - ออบเจ็กต์นี้สำหรับการเชื่อมโยง