Action

การดำเนินการที่อธิบายลักษณะการทำงานเมื่อส่งแบบฟอร์ม เช่น คุณสามารถเรียกใช้สคริปต์ Apps Script เพื่อจัดการแบบฟอร์มได้ หากมีการเรียกใช้การดำเนินการ ระบบจะส่งค่าของแบบฟอร์มไปยังเซิร์ฟเวอร์

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

การแสดง JSON 
{
  "function": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ],
  "loadIndicator": enum (LoadIndicator),
  "persistValues": boolean,
  "interaction": enum (Interaction),
  "requiredWidgets": [
    string
  ],
  "allWidgetsAreRequired": boolean
}
ช่อง
function

string

ฟังก์ชันที่กำหนดเองที่จะเรียกใช้เมื่อมีการคลิกหรือเปิดใช้งานองค์ประกอบที่มีอยู่

ดูตัวอย่างการใช้งานได้ที่อ่านข้อมูลแบบฟอร์ม
parameters[]

object (ActionParameter)

รายการพารามิเตอร์การดำเนินการ
loadIndicator

enum (LoadIndicator)

ระบุสัญญาณบอกสถานะการโหลดที่การดำเนินการแสดงขณะเรียกใช้การดำเนินการ
persistValues

boolean

ระบุว่าค่าของแบบฟอร์มยังคงอยู่หลังจากการดำเนินการหรือไม่ ค่าเริ่มต้นคือ false

หากเป็น true ค่าในแบบฟอร์มจะยังคงอยู่หลังจากทริกเกอร์การดำเนินการ หากต้องการให้ผู้ใช้ทำการเปลี่ยนแปลงขณะที่ระบบกำลังประมวลผลการดำเนินการ ให้ตั้งค่า LoadIndicator เป็น NONE สำหรับข้อความการ์ดในแอปใน Chat คุณต้องตั้งค่า ResponseType ของการดำเนินการเป็น UPDATE_MESSAGE และใช้ cardId เดียวกันจากการ์ดที่มีการดำเนินการนั้น

หากเป็น false ระบบจะล้างค่าในแบบฟอร์มเมื่อมีการทริกเกอร์การดำเนินการ หากต้องการป้องกันไม่ให้ผู้ใช้ทำการเปลี่ยนแปลงขณะที่ระบบกำลังประมวลผลการดำเนินการ ให้ตั้งค่า LoadIndicator เป็น SPINNER
interaction

enum (Interaction)

ไม่บังคับ ต้องระบุเมื่อเปิดกล่องโต้ตอบ

สิ่งที่ต้องทำเพื่อตอบสนองต่อการโต้ตอบกับผู้ใช้ เช่น ผู้ใช้คลิกปุ่มในข้อความการ์ด

หากไม่ได้ระบุ แอปจะตอบสนองโดยดำเนินการ action เช่น เปิดลิงก์หรือเรียกใช้ฟังก์ชันตามปกติ

การระบุ interaction จะช่วยให้แอปตอบสนองในรูปแบบอินเทอร์แอกทีฟพิเศษได้ เช่น การตั้งค่า interaction เป็น OPEN_DIALOG จะทำให้แอปเปิดกล่องโต้ตอบได้ เมื่อระบุแล้ว สัญญาณบอกสถานะการโหลดจะไม่แสดง หากระบุไว้สำหรับส่วนเสริม ระบบจะตัดการ์ดทั้งหมดออกและไม่แสดงสิ่งใดในไคลเอ็นต์

ใช้ได้กับแอป Google Chat และใช้ไม่ได้กับส่วนเสริม Google Workspace
requiredWidgets[]

string

ไม่บังคับ กรอกชื่อวิดเจ็ตที่การดำเนินการนี้ต้องใช้สำหรับการส่งที่ถูกต้องลงในรายการนี้

หากวิดเจ็ตที่แสดงที่นี่ไม่มีค่าเมื่อมีการเรียกใช้การดำเนินการนี้ ระบบจะยกเลิกการส่งแบบฟอร์ม

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

boolean

ไม่บังคับ หากเป็นจริง ระบบจะถือว่าการดำเนินการนี้ต้องใช้วิดเจ็ตทั้งหมด

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

ActionParameter

รายการพารามิเตอร์สตริงที่จะระบุเมื่อมีการเรียกใช้เมธอดการดำเนินการ ตัวอย่างเช่น ลองพิจารณาปุ่มเลื่อนการแจ้งเตือน 3 ปุ่ม ได้แก่ เลื่อนการแจ้งเตือนตอนนี้ เลื่อนการแจ้งเตือน 1 วัน หรือเลื่อนการแจ้งเตือนเป็นสัปดาห์หน้า คุณอาจใช้ action method = snooze() โดยส่งประเภทการเลื่อนการปลุกและเวลาเลื่อนการปลุกในรายการพารามิเตอร์สตริง

ดูข้อมูลเพิ่มเติมได้ที่ CommonEventObject

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

การแสดง JSON 
{
  "key": string,
  "value": string
}
ช่อง
key

string

ชื่อพารามิเตอร์สำหรับสคริปต์การดำเนินการ
value

string

ค่าของพารามิเตอร์

LoadIndicator

ระบุสัญญาณบอกสถานะการโหลดที่การดำเนินการแสดงขณะเรียกใช้การดำเนินการ

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

Enum
SPINNER แสดงภาพหมุนเพื่อระบุว่ากำลังโหลดเนื้อหา
NONE ไม่มีอะไรแสดง

การโต้ตอบ

ไม่บังคับ ต้องระบุเมื่อเปิดกล่องโต้ตอบ

สิ่งที่ต้องทำเพื่อตอบสนองต่อการโต้ตอบกับผู้ใช้ เช่น ผู้ใช้คลิกปุ่มในข้อความการ์ด

หากไม่ได้ระบุ แอปจะตอบสนองโดยดำเนินการ action เช่น เปิดลิงก์หรือเรียกใช้ฟังก์ชันตามปกติ

การระบุ interaction จะช่วยให้แอปตอบสนองในรูปแบบอินเทอร์แอกทีฟพิเศษได้ เช่น การตั้งค่า interaction เป็น OPEN_DIALOG จะทำให้แอปเปิดกล่องโต้ตอบได้

เมื่อระบุแล้ว สัญญาณบอกสถานะการโหลดจะไม่แสดง หากระบุไว้สำหรับส่วนเสริม ระบบจะตัดการ์ดทั้งหมดออกและไม่แสดงสิ่งใดในไคลเอ็นต์

ใช้ได้กับแอป Google Chat และใช้ไม่ได้กับส่วนเสริม Google Workspace

Enum
INTERACTION_UNSPECIFIED ค่าเริ่มต้น action จะทำงานตามปกติ
OPEN_DIALOG

เปิดกล่องโต้ตอบ ซึ่งเป็นอินเทอร์เฟซแบบการ์ดในหน้าต่างที่แอปใน Chat ใช้เพื่อโต้ตอบกับผู้ใช้

รองรับเฉพาะแอปใน Chat เพื่อตอบสนองต่อการคลิกปุ่มในข้อความการ์ด หากระบุไว้สำหรับส่วนเสริม ระบบจะตัดการ์ดทั้งหมดออกและไม่แสดงสิ่งใดในไคลเอ็นต์

ใช้ได้กับแอป Google Chat และใช้ไม่ได้กับส่วนเสริม Google Workspace