- EventObject
- CommonEventObject
- HostApp
- แพลตฟอร์ม
- TimeZone
- อินพุต
- StringInputs
- DateTimeInput
- DateInput
- TimeInput
- AuthorizationEventObject
- CalendarEventObject
- ผู้จัด
- ผู้เข้าร่วม
- ConferenceData
- ConferenceSolution
- คีย์
- EntryPoint
- พารามิเตอร์
- AddOnParameters
- ความสามารถ
- DriveEventObject
- DriveItemMetadata
- GmailEventObject
- SheetsEventObject
- MatchedUrl
- SlidesEventObject
- DocsEventObject
- ChatEventObject
- EventType
- MessagePayload
- AddedToSpacePayload
- RemovedFromSpacePayload
- ButtonClickedPayload
- DialogEventType
- WidgetUpdatedPayload
- AppCommandPayload
- AppCommandMetadata
- AppCommandType
- SystemCommandPayload
- SystemCommandMetadata
- CancelStream
- WorkflowEventObject
- ActionInvocation
- VariableData
- ResourceReference
- ResourceType
- WorkflowTextFormat
- TextFormatElement
- ชิป
- ไอคอน
- StyledText
- สไตล์
- FontWeight
- WrapStyle
- Hyperlink
- ListContainer
- ListType
- ListItem
- FlowLevelContext
- StepContext
- TriggerCreation
- TriggerType
- TriggerDeletion
- ResourceRetrieval
- ElementConfiguration
- DisplayDestination
- VariableReference
- DataType
- BasicType
- ValueMetadata
- SemanticDescriptor
- DynamicSchema
- ResourceFieldsDefinitionRetrieval
- ElementUiAutocomplete
- ExecutionMetadata
- TriggerEventSource
EventObject
เหตุการณ์การโต้ตอบกับส่วนเสริมของ Google ที่มีข้อมูลเกี่ยวกับการโต้ตอบของผู้ใช้กับส่วนเสริมภายในแอปโฮสต์
ระบบจะส่งออบเจ็กต์เหตุการณ์เป็น JSON ไปยังฟังก์ชัน Callback หรือทริกเกอร์ (สำหรับ AppsScript) ของส่วนเสริม หรือปลายทาง https (สำหรับ HTTP) เมื่อผู้ใช้โต้ตอบกับส่วนเสริมภายในแอปโฮสต์ ออบเจ็กต์เหตุการณ์จะจัดเก็บออบเจ็กต์เหตุการณ์ของแอปโฮสต์ที่กำหนดโดยแอปโฮสต์แต่ละแอป รวมถึงออบเจ็กต์เหตุการณ์ทั่วไปที่มีฟิลด์ทั่วไปบางฟิลด์ที่เกี่ยวข้องกับเหตุการณ์
ดูข้อมูลเพิ่มเติมได้ที่ออบเจ็กต์เหตุการณ์
| การแสดง JSON |
|---|
{ "commonEventObject": { object ( |
| ช่อง | |
|---|---|
commonEventObject |
ออบเจ็กต์ที่มีข้อมูลที่เหมือนกันสำหรับออบเจ็กต์เหตุการณ์ทั้งหมด ไม่ว่าจะเป็นแอปพลิเคชันแบบโฮสต์ใดก็ตาม |
authorizationEventObject |
ตั้งค่าสำหรับคำขอไปยังปลายทาง HTTP เท่านั้น |
| รายการต่อไปนี้คือช่องที่ใช้ร่วมกันไม่ได้ ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้ | |
calendar |
จะแสดงก็ต่อเมื่อโฮสต์ที่เรียกใช้คือ Google ปฏิทินเท่านั้น ออบเจ็กต์ที่มีข้อมูลปฏิทินและกิจกรรม |
drive |
จะแสดงก็ต่อเมื่อโฮสต์ที่เรียกใช้คือ Google ไดรฟ์ ออบเจ็กต์ที่มีข้อมูลไดรฟ์ |
gmail |
จะแสดงก็ต่อเมื่อโฮสต์ที่เรียกใช้คือ Gmail เท่านั้น ออบเจ็กต์ที่มีข้อมูล Gmail |
sheets |
แสดงเมื่อโฮสต์ที่เรียกใช้คือ Google ชีตเท่านั้น ออบเจ็กต์ที่มีข้อมูลชีต |
slides |
จะแสดงก็ต่อเมื่อโฮสต์ที่เรียกใช้คือ Google สไลด์ ออบเจ็กต์ที่มีข้อมูลสไลด์ |
docs |
แสดงเมื่อโฮสต์ที่เรียกใช้คือ Google เอกสารเท่านั้น ออบเจ็กต์ที่มีข้อมูลเอกสาร |
chat |
แสดงเฉพาะเมื่อโฮสต์การโทรเป็น Google Chat ออบเจ็กต์ที่มีข้อมูล Chat |
workflow |
จะแสดงก็ต่อเมื่อโฮสต์ที่เรียกใช้คือ Google Workspace Studio เท่านั้น ออบเจ็กต์ที่มีข้อมูลเวิร์กโฟลว์ |
| สิ้นสุดฟิลด์ที่แยกกันโดยสิ้นเชิง | |
CommonEventObject
ออบเจ็กต์เหตุการณ์ทั่วไปคือส่วนหนึ่งของออบเจ็กต์เหตุการณ์โดยรวมที่ส่งข้อมูลทั่วไปที่ไม่ขึ้นอยู่กับโฮสต์ไปยังส่วนเสริมจากไคลเอ็นต์ของผู้ใช้ ข้อมูลนี้รวมถึงรายละเอียดต่างๆ เช่น ภาษาของผู้ใช้ แอปโฮสต์ และแพลตฟอร์ม
นอกเหนือจากทริกเกอร์หน้าแรกและทริกเกอร์ตามบริบทแล้ว ส่วนเสริมจะสร้างและส่งออบเจ็กต์เหตุการณ์ไปยังฟังก์ชัน Callback ของการดำเนินการเมื่อผู้ใช้โต้ตอบกับวิดเจ็ต ฟังก์ชัน Callback ของส่วนเสริมสามารถค้นหาออบเจ็กต์เหตุการณ์ทั่วไปเพื่อกำหนดเนื้อหาของวิดเจ็ตที่เปิดอยู่ในไคลเอ็นต์ของผู้ใช้ เช่น ส่วนเสริมสามารถค้นหาข้อความที่ผู้ใช้ป้อนลงในวิดเจ็ต TextInput ในออบเจ็กต์ eventObject.commentEventObject.formInputs ได้
สำหรับแอปใน Chat ชื่อของฟังก์ชันที่ผู้ใช้เรียกใช้เมื่อโต้ตอบกับวิดเจ็ต
| การแสดง JSON |
|---|
{ "userLocale": string, "hostApp": enum ( |
| ช่อง | |
|---|---|
userLocale |
ปิดใช้โดยค่าเริ่มต้น ตัวระบุภาษาและประเทศ/ภูมิภาคของผู้ใช้ในรูปแบบรหัสภาษา ISO 639-รหัสประเทศ/ภูมิภาค ISO 3166 ตัวอย่างเช่น หากต้องการเปิดช่องนี้ คุณต้องตั้งค่า |
hostApp |
ระบุแอปโฮสต์ที่ส่วนเสริมทำงานอยู่เมื่อสร้างออบเจ็กต์เหตุการณ์ ค่าที่เป็นไปได้มีดังนี้
|
platform |
Enum ของแพลตฟอร์มซึ่งระบุแพลตฟอร์มที่เกิดเหตุการณ์ ( |
timeZone |
ปิดใช้โดยค่าเริ่มต้น รหัสเขตเวลาและการชดเชยจากเวลาสากลเชิงพิกัด (UTC) หากต้องการเปิดช่องนี้ คุณต้องตั้งค่า รองรับเฉพาะประเภทเหตุการณ์ |
formInputs |
แผนที่ที่มีค่าปัจจุบันของวิดเจ็ตในการ์ดที่แสดง คีย์แผนที่เป็นค่าสตริง โครงสร้างของออบเจ็กต์ค่าแผนที่จะขึ้นอยู่กับประเภทวิดเจ็ต ดังนี้ หมายเหตุ: ตัวอย่างต่อไปนี้จัดรูปแบบสำหรับรันไทม์ V8 ของ Apps Script หากใช้รันไทม์ Rhino คุณต้องเพิ่ม
ตัวอย่าง: สำหรับวิดเจ็ตการป้อนข้อความที่มี
ตัวอย่าง: สำหรับวิดเจ็ตที่มีหลายค่าซึ่งมี
ตัวอย่าง: สำหรับเครื่องมือเลือกที่มี
ตัวอย่าง: สำหรับเครื่องมือเลือกที่มี
ตัวอย่าง: สำหรับเครื่องมือเลือกที่มี ออบเจ็กต์ที่มีรายการคู่ |
parameters |
พารามิเตอร์เพิ่มเติมที่คุณระบุให้กับการดำเนินการโดยใช้ เวอร์ชันตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์: สำหรับส่วนเสริมที่ขยาย Google Chat หากต้องการแนะนำรายการตามสิ่งที่ผู้ใช้พิมพ์ในเมนูแบบเลือกได้หลายรายการ ให้ใช้ค่าของคีย์ ออบเจ็กต์ที่มีรายการคู่ |
invokedFunction |
ชื่อฟังก์ชันที่จะเรียกใช้ ช่องนี้จะไม่ป้อนข้อมูลสำหรับส่วนเสริม Google Workspace ที่ขยาย Google Chat แต่หากต้องการรับข้อมูลฟังก์ชัน เช่น ตัวระบุ ส่วนเสริมที่ขยาย Chat ควรใช้ช่อง |
HostApp
แอปพลิเคชัน Google Workspace สำหรับส่วนเสริม Google Workspace หรือแอป Google Chat
สำหรับส่วนเสริม แอปพลิเคชัน Workspace ที่เปิดใช้ส่วนเสริมของ Google Workspace สำหรับแอปใน Chat แอปโฮสต์จะเป็น CHAT เสมอ
| Enum | |
|---|---|
UNSPECIFIED_HOST_APP |
Google ไม่สามารถระบุแอปโฮสต์ได้ |
GMAIL |
ส่วนเสริมจะเปิดขึ้นจาก Gmail |
CALENDAR |
ส่วนเสริมจะเปิดขึ้นจาก Google ปฏิทิน |
DRIVE |
ส่วนเสริมจะเปิดขึ้นจาก Google ไดรฟ์ |
DEMO |
ไม่ได้ใช้ |
DOCS |
ส่วนเสริมจะเปิดขึ้นจาก Google เอกสาร |
MEET |
ส่วนเสริมจะเปิดขึ้นจาก Google Meet |
SHEETS |
ส่วนเสริมจะเปิดขึ้นจาก Google ชีต |
SLIDES |
ส่วนเสริมจะเปิดขึ้นจาก Google สไลด์ |
DRAWINGS |
ส่วนเสริมจะเปิดขึ้นจาก Google วาดเขียน |
CHAT |
แอป Google Chat |
แพลตฟอร์ม
ระบุแพลตฟอร์มที่การโทรนี้เริ่มต้นขึ้น
| Enum | |
|---|---|
UNKNOWN_PLATFORM |
|
WEB |
|
IOS |
|
ANDROID |
|
TimeZone
รหัสเขตเวลาและการชดเชยจากเวลาสากลเชิงพิกัด (UTC) รองรับเฉพาะประเภทเหตุการณ์ CARD_CLICKED และ SUBMIT_DIALOG เท่านั้น
| การแสดง JSON |
|---|
{ "id": string, "offset": integer } |
| ช่อง | |
|---|---|
id |
รหัสฐานข้อมูลเขตเวลา IANA TZ เช่น "America/Toronto" |
offset |
ออฟเซ็ตเขตเวลาของผู้ใช้เป็นมิลลิวินาทีจากเวลาสากลเชิงพิกัด (UTC) |
อินพุต
ประเภทข้อมูลที่ผู้ใช้สามารถป้อนในการ์ดหรือกล่องโต้ตอบ ประเภทอินพุตจะขึ้นอยู่กับประเภทของค่าที่วิดเจ็ตยอมรับ
| การแสดง JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "stringInputs": { object ( |
| ช่อง | |
|---|---|
| รายการต่อไปนี้คือช่องที่ใช้ร่วมกันไม่ได้ ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้ | |
stringInputs |
รายการสตริงที่แสดงค่าที่ผู้ใช้ป้อนในวิดเจ็ต หากวิดเจ็ตยอมรับค่าเดียว เช่น วิดเจ็ต |
dateTimeInput |
ค่าอินพุตวันที่และเวลาจากวิดเจ็ต |
dateInput |
ค่าอินพุตวันที่จากวิดเจ็ต |
timeInput |
ค่าอินพุตเวลาจากวิดเจ็ต |
| สิ้นสุดฟิลด์ที่แยกกันโดยสิ้นเชิง | |
StringInputs
พารามิเตอร์อินพุตสำหรับวิดเจ็ตปกติ สำหรับวิดเจ็ตที่มีค่าเดียว จะเป็นรายการค่าเดียว สำหรับวิดเจ็ตที่มีหลายค่า เช่น ช่องทำเครื่องหมาย ระบบจะแสดงค่าทั้งหมด
| การแสดง JSON |
|---|
{ "value": [ string ] } |
| ช่อง | |
|---|---|
value[] |
รายการสตริงที่ผู้ใช้ป้อน |
DateTimeInput
ค่าอินพุตวันที่และเวลา
| การแสดง JSON |
|---|
{ "msSinceEpoch": string, "hasDate": boolean, "hasTime": boolean } |
| ช่อง | |
|---|---|
msSinceEpoch |
เวลาตั้งแต่เวลา Epoch ในหน่วยมิลลิวินาที |
hasDate |
ข้อมูลที่ป้อน |
hasTime |
ข้อมูลที่ป้อน |
DateInput
ค่าอินพุตวันที่
| การแสดง JSON |
|---|
{ "msSinceEpoch": string } |
| ช่อง | |
|---|---|
msSinceEpoch |
เวลาตั้งแต่เวลา Epoch ในหน่วยมิลลิวินาที |
TimeInput
ค่าเวลาที่ป้อน
| การแสดง JSON |
|---|
{ "hours": integer, "minutes": integer } |
| ช่อง | |
|---|---|
hours |
ชั่วโมงในนาฬิกาแบบ 24 ชั่วโมง |
minutes |
จำนวนนาทีที่ผ่านไปในชั่วโมง ค่าที่ใช้ได้คือ 0 ถึง 59 |
AuthorizationEventObject
สรุปข้อมูลการให้สิทธิ์สำหรับคำขอส่วนเสริม
| การแสดง JSON |
|---|
{ "userOAuthToken": string, "userIdToken": string, "systemIdToken": string, "authorizedScopes": [ string ] } |
| ช่อง | |
|---|---|
userOAuthToken |
โทเค็นเพื่อการเข้าถึง OAuth ของผู้ใช้ปลายทาง ซึ่งได้รับสิทธิ์ตามขอบเขตที่ขอ (หลังจากแยกกลุ่มความยินยอม OAuth แล้ว ระบบจะให้สิทธิ์นี้ด้วยขอบเขตที่ได้รับสิทธิ์จากผู้ใช้ปลายทาง) |
userIdToken |
โทเค็นรหัสผู้ใช้ปลายทาง หากมีการขอขอบเขตรหัสที่เหมาะสม |
systemIdToken |
โทเค็นรหัสสำหรับบัญชีบริการส่วนเสริมของ G Suite สำหรับการติดตั้งใช้งานนี้ |
authorizedScopes[] |
รายการขอบเขต OAuth ที่ผู้ใช้ให้สิทธิ์ |
CalendarEventObject
ออบเจ็กต์กิจกรรมในปฏิทินคือส่วนหนึ่งของออบเจ็กต์เหตุการณ์โดยรวมที่มีข้อมูลเกี่ยวกับปฏิทินและกิจกรรมในปฏิทินของผู้ใช้ ซึ่งจะปรากฏในออบเจ็กต์เหตุการณ์ก็ต่อเมื่อแอปพลิเคชันโฮสต์คือ Google ปฏิทินเท่านั้น
ตารางต่อไปนี้แสดงช่องที่มีอยู่ในช่อง calendar ของออบเจ็กต์เหตุการณ์ ช่องที่ทำเครื่องหมายเป็นข้อมูลที่ผู้ใช้สร้างขึ้นจะแสดงในออบเจ็กต์เหตุการณ์ก็ต่อเมื่อข้อมูลนั้นแสดงในกิจกรรมในปฏิทินและส่วนเสริมตั้งค่าช่อง addOns.calendar.currentEventAccess manifest เป็น READ หรือ READ_WRITE
| การแสดง JSON |
|---|
{ "id": string, "recurringEventId": string, "calendarId": string, "organizer": { object ( |
| ช่อง | |
|---|---|
id |
รหัสกิจกรรม |
recurringEventId |
รหัสของกิจกรรมที่เกิดซ้ำ |
calendarId |
รหัสปฏิทิน |
organizer |
ออบเจ็กต์ที่แสดงถึงผู้จัดกิจกรรม |
attendees[] |
ข้อมูลที่ผู้ใช้สร้างขึ้น รายชื่อผู้เข้าร่วมกิจกรรมในปฏิทิน |
conferenceData |
ข้อมูลที่ผู้ใช้สร้างขึ้น ออบเจ็กต์ที่แสดงข้อมูลการประชุมที่เชื่อมโยงกับกิจกรรมนี้ เช่น รายละเอียดการประชุม Google Meet |
capabilities |
ข้อมูลที่ผู้ใช้สร้างขึ้น ออบเจ็กต์ที่อธิบายความสามารถของส่วนเสริมในการดูหรืออัปเดตข้อมูลกิจกรรม |
ผู้จัด
| การแสดง JSON |
|---|
{ "email": string } |
| ช่อง | |
|---|---|
email |
อีเมลของผู้จัดกิจกรรม |
ผู้เข้าร่วม
ออบเจ็กต์ผู้เข้าร่วมจะมีข้อมูลเกี่ยวกับผู้เข้าร่วมแต่ละรายในกิจกรรมใน Google ปฏิทิน ข้อมูลนี้จะแสดงในออบเจ็กต์เหตุการณ์ก็ต่อเมื่อข้อมูลแสดงในกิจกรรมในปฏิทินและส่วนเสริมตั้งค่าช่อง addOns.calendar.currentEventAccess manifest เป็น READ หรือ READ_WRITE
| การแสดง JSON |
|---|
{ "email": string, "displayName": string, "organizer": boolean, "self": boolean, "resource": boolean, "optional": boolean, "responseStatus": string, "comment": string, "additionalGuests": integer } |
| ช่อง | |
|---|---|
email |
อีเมลของผู้เข้าร่วม |
displayName |
ชื่อที่แสดงของผู้เข้าร่วม |
organizer |
true หากผู้เข้าร่วมเป็นผู้จัดกิจกรรมนี้ |
self |
true หากผู้เข้าร่วมรายนี้แสดงถึงปฏิทินที่กิจกรรมนี้ปรากฏอยู่ หรือเป็น false ในกรณีอื่นๆ |
resource |
true หากผู้เข้าร่วมเป็นตัวแทนของทรัพยากร เช่น ห้องหรืออุปกรณ์ หากไม่เป็น false |
optional |
true หากการเข้าร่วมของผู้เข้าร่วมรายนี้ถูกทำเครื่องหมายว่าไม่บังคับ หรือเป็น false หากไม่ใช่ |
responseStatus |
สถานะการตอบกลับของผู้เข้าร่วม ค่าที่เป็นไปได้มีดังนี้
|
comment |
ความคิดเห็นในการตอบกลับของผู้เข้าร่วม (หากมี) |
additionalGuests |
จำนวนผู้เข้าร่วมเพิ่มเติมที่ผู้เข้าร่วมระบุว่าจะพามาด้วย ค่าเริ่มต้นคือ 0 |
ConferenceData
ออบเจ็กต์ข้อมูลการประชุมจะมีข้อมูลเกี่ยวกับการประชุมที่แนบมากับกิจกรรมใน Google ปฏิทิน ซึ่งอาจเป็นโซลูชันการประชุมของ Google เช่น Google Meet หรือการประชุมของบุคคลที่สาม ข้อมูลนี้จะแสดงในออบเจ็กต์เหตุการณ์ก็ต่อเมื่อข้อมูลแสดงในกิจกรรมในปฏิทินและส่วนเสริมตั้งค่าช่อง addOns.calendar.currentEventAccess manifest เป็น READ หรือ READ_WRITE
| การแสดง JSON |
|---|
{ "conferenceId": string, "conferenceSolution": { object ( |
| ช่อง | |
|---|---|
conferenceId |
รหัสของการประชุม รหัสนี้มีไว้เพื่อให้แอปพลิเคชันติดตามการประชุมได้ คุณไม่ควรแสดงรหัสนี้แก่ผู้ใช้ |
conferenceSolution |
ออบเจ็กต์ที่แสดงถึงโซลูชันการประชุม เช่น Hangouts หรือ Google Meet |
entryPoints[] |
รายการจุดแรกเข้าของการประชุม เช่น URL หรือหมายเลขโทรศัพท์ |
notes |
หมายเหตุเพิ่มเติม (เช่น วิธีการจากผู้ดูแลระบบโดเมนหรือประกาศทางกฎหมาย) เกี่ยวกับการประชุมที่จะแสดงต่อผู้ใช้ มี HTML ได้ ความยาวสูงสุดคือ 2,048 อักขระ |
parameters |
ออบเจ็กต์ที่มีแผนที่ของข้อมูลพารามิเตอร์ที่กำหนดไว้สำหรับใช้โดยส่วนเสริม |
ConferenceSolution
| การแสดง JSON |
|---|
{
"iconUri": string,
"key": {
object ( |
| ช่อง | |
|---|---|
iconUri |
URI สำหรับไอคอนที่ผู้ใช้มองเห็นได้ซึ่งแสดงถึงโซลูชันการประชุมนี้ |
key |
คีย์ที่ระบุโซลูชันการประชุมสำหรับกิจกรรมนี้โดยเฉพาะ |
name |
ชื่อที่ผู้ใช้มองเห็นได้ของโซลูชันการประชุมนี้ (ไม่ได้แปล) |
คีย์
| การแสดง JSON |
|---|
{ "type": string } |
| ช่อง | |
|---|---|
type |
ประเภทโซลูชันการประชุม ค่าที่เป็นไปได้มีดังนี้
|
EntryPoint
ออบเจ็กต์จุดแรกเข้าจะมีข้อมูลเกี่ยวกับวิธีการที่กำหนดไว้ในการเข้าถึงการประชุมหนึ่งๆ เช่น ทางโทรศัพท์หรือวิดีโอ ข้อมูลนี้จะแสดงในออบเจ็กต์เหตุการณ์ก็ต่อเมื่อข้อมูลแสดงในกิจกรรมในปฏิทินและส่วนเสริมตั้งค่าช่อง addOns.calendar.currentEventAccess manifest เป็น READ หรือ READ_WRITE
| การแสดง JSON |
|---|
{ "accessCode": string, "entryPointType": string, "label": string, "meetingCode": string, "passcode": string, "password": string, "pin": string, "uri": string, "regionCode": string, "entryPointFeatures": [ string ] } |
| ช่อง | |
|---|---|
accessCode |
รหัสการเข้าถึงที่ใช้เพื่อเข้าถึงการประชุม ความยาวสูงสุดคือ 128 อักขระ โดยทั่วไปแล้ว ผู้ให้บริการการประชุมจะใช้เฉพาะชุดย่อยของ {accessCode, meetingCode, passcode, password, pin} เพื่อให้สิทธิ์เข้าถึงการประชุม จับคู่และแสดงเฉพาะช่องที่ผู้ให้บริการการประชุมใช้ |
entryPointType |
ประเภทของจุดแรกเข้า ค่าที่เป็นไปได้มีดังนี้
|
label |
ป้ายกำกับที่ผู้ใช้มองเห็นได้สำหรับ URI ของจุดแรกเข้า (ไม่ได้แปล) |
meetingCode |
รหัสการประชุมที่ใช้เข้าถึงการประชุม ความยาวสูงสุดคือ 128 อักขระ โดยทั่วไปแล้ว ผู้ให้บริการการประชุมจะใช้เฉพาะชุดย่อยของ {accessCode, meetingCode, passcode, password, pin} เพื่อให้สิทธิ์เข้าถึงการประชุม จับคู่และแสดงเฉพาะช่องที่ผู้ให้บริการการประชุมใช้ |
passcode |
รหัสผ่านที่ใช้เข้าถึงการประชุม ความยาวสูงสุดคือ 128 อักขระ โดยทั่วไปแล้ว ผู้ให้บริการการประชุมจะใช้เฉพาะชุดย่อยของ {accessCode, meetingCode, passcode, password, pin} เพื่อให้สิทธิ์เข้าถึงการประชุม จับคู่และแสดงเฉพาะช่องที่ผู้ให้บริการการประชุมใช้ |
password |
รหัสผ่านที่ใช้เข้าถึงการประชุม ความยาวสูงสุดคือ 128 อักขระ โดยทั่วไปแล้ว ผู้ให้บริการการประชุมจะใช้เฉพาะชุดย่อยของ {accessCode, meetingCode, passcode, password, pin} เพื่อให้สิทธิ์เข้าถึงการประชุม จับคู่และแสดงเฉพาะช่องที่ผู้ให้บริการการประชุมใช้ |
pin |
PIN ที่ใช้เข้าถึงการประชุม ความยาวสูงสุดคือ 128 อักขระ โดยทั่วไปแล้ว ผู้ให้บริการการประชุมจะใช้เฉพาะชุดย่อยของ {accessCode, meetingCode, passcode, password, pin} เพื่อให้สิทธิ์เข้าถึงการประชุม จับคู่และแสดงเฉพาะช่องที่ผู้ให้บริการการประชุมใช้ |
uri |
URI ของจุดแรกเข้า ความยาวสูงสุดคือ 1,300 อักขระ การจัดรูปแบบจะขึ้นอยู่กับประเภทจุดแรกเข้า ดังนี้
|
regionCode |
รหัสภูมิภาคของหมายเลขโทรศัพท์ ผู้ใช้จำเป็นต้องใช้หาก URI ไม่มีรหัสประเทศ ค่าจะอิงตามรายการรหัสภูมิภาค CLDR สาธารณะ |
entryPointFeatures[] |
ฟีเจอร์ของจุดแรกเข้า ปัจจุบันฟีเจอร์เหล่านี้ใช้ได้กับจุดแรกเข้าทางโทรศัพท์เท่านั้น
|
พารามิเตอร์
| การแสดง JSON |
|---|
{
"addOnParameters": {
object ( |
| ช่อง | |
|---|---|
addOnParameters |
แมปของคีย์และค่าสตริงพารามิเตอร์ นักพัฒนาส่วนเสริมจะกำหนดคีย์และค่าเหล่านี้เพื่อแนบข้อมูลไปยังการประชุมที่เฉพาะเจาะจงสำหรับการใช้งานส่วนเสริม |
AddOnParameters
| การแสดง JSON |
|---|
{ "parameters": { string: string, ... } } |
| ช่อง | |
|---|---|
parameters |
ออบเจ็กต์ที่มีรายการคู่ |
ความสามารถ
| การแสดง JSON |
|---|
{ "canSeeAttendees": boolean, "canAddAttendees": boolean, "canSeeConferenceData": boolean, "canSetConferenceData": boolean, "canAddAttachments": boolean } |
| ช่อง | |
|---|---|
canSeeAttendees |
ข้อมูลที่ผู้ใช้สร้างขึ้น true หากส่วนเสริมอ่านรายชื่อผู้เข้าร่วมกิจกรรมได้ และ false หากอ่านไม่ได้ |
canAddAttendees |
ข้อมูลที่ผู้ใช้สร้างขึ้น true หากส่วนเสริมสามารถเพิ่มผู้เข้าร่วมใหม่ลงในรายชื่อผู้เข้าร่วมกิจกรรมได้ false หากไม่สามารถทำได้ |
canSeeConferenceData |
ข้อมูลที่ผู้ใช้สร้างขึ้น true หากส่วนเสริมอ่านข้อมูลการประชุมของกิจกรรมได้ หรือ false หากอ่านไม่ได้ |
canSetConferenceData |
ข้อมูลที่ผู้ใช้สร้างขึ้น true หากส่วนเสริมสามารถอัปเดตข้อมูลการประชุมของกิจกรรมได้ หรือ false หากไม่สามารถอัปเดตได้ |
canAddAttachments |
ข้อมูลที่ผู้ใช้สร้างขึ้น true หากส่วนเสริมสามารถเพิ่มไฟล์แนบใหม่ในกิจกรรมได้ หรือ false หากไม่สามารถเพิ่มได้ |
DriveEventObject
ออบเจ็กต์เหตุการณ์ในไดรฟ์คือส่วนหนึ่งของออบเจ็กต์เหตุการณ์โดยรวมที่มีข้อมูลเกี่ยวกับ Google ไดรฟ์ของผู้ใช้และเนื้อหาในไดรฟ์ โดยจะแสดงในออบเจ็กต์เหตุการณ์ก็ต่อเมื่อแอปพลิเคชันโฮสต์คือ Google ไดรฟ์เท่านั้น
| การแสดง JSON |
|---|
{ "selectedItems": [ { object ( |
| ช่อง | |
|---|---|
selectedItems[] |
รายการ (ไฟล์หรือโฟลเดอร์) ที่เลือกในไดรฟ์ |
activeCursorItem |
รายการในไดรฟ์ที่ใช้งานอยู่ในปัจจุบัน |
DriveItemMetadata
ออบเจ็กต์รายการในไดรฟ์จะมีข้อมูลเกี่ยวกับรายการในไดรฟ์ที่เฉพาะเจาะจง เช่น ไฟล์หรือโฟลเดอร์
| การแสดง JSON |
|---|
{ "id": string, "iconUrl": string, "mimeType": string, "title": string, "addonHasFileScopePermission": boolean } |
| ช่อง | |
|---|---|
id |
รหัสของรายการที่เลือก |
iconUrl |
URL ของไอคอนที่แสดงถึงรายการที่เลือก |
mimeType |
ประเภท MIME ของรายการที่เลือก |
title |
ชื่อของรายการที่เลือก |
addonHasFileScopePermission |
หากเป็น true แสดงว่าส่วนเสริมได้ขอและได้รับสิทธิ์ขอบเขต https://www.googleapis.com/auth/drive.file สำหรับรายการนี้แล้ว ไม่เช่นนั้น ช่องนี้จะเป็น false หากส่วนเสริมใช้ขอบเขตที่อนุญาตมากกว่า เช่น https://www.googleapis.com/auth/drive หรือ https://www.googleapis.com/auth/drive.readonly ช่องนี้จะไม่เกี่ยวข้อง ใช้ขอบเขตที่อนุญาตน้อยที่สุดเสมอเมื่อออกแบบส่วนเสริมเพื่อปกป้องข้อมูลผู้ใช้ |
GmailEventObject
ออบเจ็กต์เหตุการณ์ Gmail เป็นส่วนหนึ่งของออบเจ็กต์เหตุการณ์โดยรวมที่มีข้อมูลเกี่ยวกับข้อความ Gmail ของผู้ใช้ ซึ่งจะปรากฏในออบเจ็กต์เหตุการณ์ก็ต่อเมื่อแอปพลิเคชันโฮสต์คือ Gmail เท่านั้น
| การแสดง JSON |
|---|
{ "messageId": string, "threadId": string, "accessToken": string, "toRecipients": [ string ], "ccRecipients": [ string ], "bccRecipients": [ string ] } |
| ช่อง | |
|---|---|
messageId |
รหัสของข้อความ Gmail ที่เปิดอยู่ |
threadId |
รหัสชุดข้อความ Gmail ที่เปิดอยู่ |
accessToken |
โทเค็นเพื่อการเข้าถึงเฉพาะ Gmail คุณสามารถใช้โทเค็นนี้กับเมธอด |
toRecipients[] |
ปิดใช้โดยค่าเริ่มต้น รายการอีเมลผู้รับ "ถึง:" ที่รวมอยู่ในฉบับร่างที่ส่วนเสริมกำลังเขียนอยู่ หากต้องการเปิดช่องนี้ คุณต้องตั้งค่าช่อง |
ccRecipients[] |
ปิดใช้โดยค่าเริ่มต้น รายการอีเมลของผู้รับ "สำเนา:" ที่รวมอยู่ในฉบับร่างที่ส่วนเสริมกำลังเขียนอยู่ หากต้องการเปิดช่องนี้ คุณต้องตั้งค่าช่อง |
bccRecipients[] |
ปิดใช้โดยค่าเริ่มต้น รายการอีเมลของผู้รับ "สำเนาลับ:" ที่รวมอยู่ในฉบับร่างที่ส่วนเสริมกำลังเขียนอยู่ หากต้องการเปิดช่องนี้ คุณต้องตั้งค่าช่อง |
SheetsEventObject
ออบเจ็กต์เหตุการณ์ของชีตคือส่วนหนึ่งของออบเจ็กต์เหตุการณ์โดยรวมที่มีข้อมูลเกี่ยวกับเอกสารของผู้ใช้และเนื้อหาในเอกสาร ซึ่งจะแสดงในออบเจ็กต์เหตุการณ์ก็ต่อเมื่อส่วนเสริมขยาย Google ชีตเท่านั้น
| การแสดง JSON |
|---|
{
"id": string,
"title": string,
"addonHasFileScopePermission": boolean,
"matchedUrl": {
object ( |
| ช่อง | |
|---|---|
id |
จะแสดงก็ต่อเมื่อผู้ใช้ให้สิทธิ์ขอบเขต |
title |
จะแสดงก็ต่อเมื่อผู้ใช้ให้สิทธิ์ขอบเขต |
addonHasFileScopePermission |
หากเป็น |
matchedUrl |
จะแสดงก็ต่อเมื่อเป็นไปตามเงื่อนไขต่อไปนี้
URL ของลิงก์ที่สร้างตัวอย่างใน Google ชีต หากต้องการใช้ช่องนี้ คุณต้องกำหนดค่า ตัวอย่างเพย์โหลดเมื่อผู้ใช้ดูตัวอย่างลิงก์ |
MatchedUrl
ออบเจ็กต์เหตุการณ์ที่แสดงผลพร้อมคำขอแสดงตัวอย่างลิงก์
| การแสดง JSON |
|---|
{ "url": string } |
| ช่อง | |
|---|---|
url |
URL ที่ตรงกัน |
SlidesEventObject
ออบเจ็กต์เหตุการณ์ของสไลด์เป็นส่วนหนึ่งของออบเจ็กต์เหตุการณ์โดยรวมที่มีข้อมูลเกี่ยวกับเอกสารของผู้ใช้และเนื้อหาในเอกสาร ซึ่งจะปรากฏในออบเจ็กต์เหตุการณ์ก็ต่อเมื่อส่วนเสริมขยาย Google สไลด์เท่านั้น
| การแสดง JSON |
|---|
{
"id": string,
"title": string,
"addonHasFileScopePermission": boolean,
"matchedUrl": {
object ( |
| ช่อง | |
|---|---|
id |
จะแสดงก็ต่อเมื่อผู้ใช้ให้สิทธิ์ขอบเขต |
title |
จะแสดงก็ต่อเมื่อผู้ใช้ให้สิทธิ์ขอบเขต |
addonHasFileScopePermission |
หากเป็น |
matchedUrl |
จะแสดงก็ต่อเมื่อเป็นไปตามเงื่อนไขต่อไปนี้
URL ของลิงก์ที่สร้างตัวอย่างใน Google สไลด์ หากต้องการใช้ช่องนี้ คุณต้องกำหนดค่า ตัวอย่างเพย์โหลดเมื่อผู้ใช้ดูตัวอย่างลิงก์ |
DocsEventObject
ออบเจ็กต์เหตุการณ์ของเอกสารเป็นส่วนหนึ่งของออบเจ็กต์เหตุการณ์โดยรวมที่มีข้อมูลเกี่ยวกับเอกสารของผู้ใช้และเนื้อหาในเอกสาร ซึ่งจะปรากฏในออบเจ็กต์เหตุการณ์ก็ต่อเมื่อส่วนเสริมขยาย Google เอกสารเท่านั้น
| การแสดง JSON |
|---|
{
"id": string,
"title": string,
"addonHasFileScopePermission": boolean,
"matchedUrl": {
object ( |
| ช่อง | |
|---|---|
id |
จะแสดงก็ต่อเมื่อผู้ใช้ให้สิทธิ์ขอบเขต |
title |
จะแสดงก็ต่อเมื่อผู้ใช้ให้สิทธิ์ขอบเขต |
addonHasFileScopePermission |
หากเป็น |
matchedUrl |
จะแสดงก็ต่อเมื่อเป็นไปตามเงื่อนไขต่อไปนี้
URL ของลิงก์ที่สร้างตัวอย่างใน Google เอกสาร หากต้องการใช้ช่องนี้ คุณต้องกำหนดค่า ตัวอย่างเพย์โหลดเมื่อผู้ใช้ดูตัวอย่างลิงก์ |
ChatEventObject
เพย์โหลดออบเจ็กต์เหตุการณ์ของแอป Google Chat ที่ส่งจากเซิร์ฟเวอร์ Google ไปยังส่วนเสริม เพย์โหลดใช้เพื่อระบุประเภทของเหตุการณ์ได้
| การแสดง JSON |
|---|
{ "type": enum ( |
| ช่อง | |
|---|---|
type |
ประเภทของเหตุการณ์ ซึ่งจะป้อนข้อมูลสำหรับเหตุการณ์ในหน้าแรกของแอปในแอป Chat ที่ไม่ใช่ส่วนเสริมเท่านั้น |
user |
ผู้ใช้ที่โต้ตอบกับแอปใน Chat |
space |
พื้นที่ทำงานที่เกิดเหตุการณ์ขึ้น โดยจะป้อนข้อมูลสำหรับเหตุการณ์ App Home ในแอปใน Chat ที่ไม่ใช่ส่วนเสริมเท่านั้น |
eventTime |
การประทับเวลาที่ระบุเวลาที่ออบเจ็กต์เหตุการณ์เกิดขึ้น ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น |
| เพย์โหลดของออบเจ็กต์เหตุการณ์ เพย์โหลดจะขึ้นอยู่กับประเภทออบเจ็กต์เหตุการณ์ รายการต่อไปนี้คือช่องที่ใช้ร่วมกันไม่ได้ ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้ | |
messagePayload |
ผู้ใช้ส่งข้อความถึงแอปใน Chat หรือ @พูดถึงแอปใน Chat ในพื้นที่ทำงาน การเรียกใช้คำสั่งแอป (เช่น คำสั่งเครื่องหมายทับและคำสั่งด่วน) จะแสดงใน |
addedToSpacePayload |
ผู้ใช้เพิ่มแอปใน Chat ไปยังพื้นที่ใน Chat หรือผู้ดูแลระบบ Google Workspace ติดตั้งแอปใน Chat ในพื้นที่ข้อความส่วนตัวสำหรับผู้ใช้ในองค์กร |
removedFromSpacePayload |
ผู้ใช้นำแอปใน Chat ออกจากพื้นที่ทำงาน |
buttonClickedPayload |
แสดงข้อมูลเพย์โหลดเมื่อผู้ใช้โต้ตอบกับองค์ประกอบแบบอินเทอร์แอกทีฟของการ์ดหรือกล่องโต้ตอบที่ทริกเกอร์ Callback หากผู้ใช้โต้ตอบกับกล่องโต้ตอบ ระบบจะตั้งค่าช่อง เพย์โหลดที่สมบูรณ์ยังมี |
widgetUpdatedPayload |
ผู้ใช้อัปเดตวิดเจ็ตในการ์ดในสตรีมหรือในกล่องโต้ตอบ เพย์โหลดที่สมบูรณ์ยังมี |
appCommandPayload |
ผู้ใช้เรียกใช้คำสั่งแอป |
systemCommandPayload |
ผู้ใช้เรียกใช้คำสั่งของระบบ |
| สิ้นสุดฟิลด์ที่แยกกันโดยสิ้นเชิง | |
EventType
ประเภทของเหตุการณ์ ซึ่งจะป้อนข้อมูลสำหรับเหตุการณ์ในหน้าแรกของแอปในแอป Chat ที่ไม่ใช่ส่วนเสริมเท่านั้น
| Enum | |
|---|---|
EVENT_TYPE_UNSPECIFIED |
ค่าเริ่มต้นสำหรับ enum DO NOT USE. |
APP_HOME |
ผู้ใช้เปิดข้อความส่วนตัวจากแอปใน Chat ที่ใช้หน้าแรกของแอป เฉพาะช่อง type, user และ space เท่านั้นที่รวมอยู่ในเหตุการณ์ประเภทนี้ ดูข้อมูลเพิ่มเติมได้ที่สร้างหน้าแรกสำหรับแอป Google Chat |
SUBMIT_FORM |
ผู้ใช้ส่งข้อมูลในการ์ดหน้าแรกของแอป เฉพาะช่อง type, user และ space เท่านั้นที่รวมอยู่ในเหตุการณ์ประเภทนี้ ดูข้อมูลเพิ่มเติมได้ที่หัวข้อ[สร้างหน้าแรกสำหรับแอป Google Chat]((https://developers.google.com/workspace/chat/send-app-home-card-message) |
MessagePayload
ผู้ใช้ส่งข้อความถึงแอปใน Chat หรือ @พูดถึงแอปใน Chat ในพื้นที่ทำงาน การเรียกใช้คำสั่งแอป (เช่น คำสั่งเครื่องหมายทับและคำสั่งด่วน) จะใช้ AppCommandPayload แทน
| การแสดง JSON |
|---|
{ "space": { object ( |
| ช่อง | |
|---|---|
space |
ต้องระบุ พื้นที่ใน Chat ที่ออบเจ็กต์เหตุการณ์เกิดขึ้น |
message |
ข้อความที่ทริกเกอร์ออบเจ็กต์เหตุการณ์ |
configCompleteRedirectUri |
ไม่บังคับ URL ที่แอปใน Chat ควรเปลี่ยนเส้นทางผู้ใช้ไปหลังจากที่ผู้ใช้ทำขั้นตอนการให้สิทธิ์หรือการกำหนดค่านอก Google Chat เสร็จสมบูรณ์ ดูข้อมูลเพิ่มเติมได้ที่หัวข้อเชื่อมต่อแอปใน Chat กับบริการและเครื่องมืออื่นๆ |
AddedToSpacePayload
ผู้ใช้เพิ่มแอปใน Chat ไปยังพื้นที่ทำงาน หรือมีการสร้าง DM ระหว่างแอปกับผู้ใช้
| การแสดง JSON |
|---|
{
"space": {
object ( |
| ช่อง | |
|---|---|
space |
ต้องระบุ พื้นที่ใน Chat ที่ออบเจ็กต์เหตุการณ์เกิดขึ้น |
interactionAdd |
มีการเพิ่มแอปไปยังพื้นที่ทำงานด้วยการโต้ตอบของผู้ใช้หรือไม่ (เช่น โดยการ @ พูดถึงแอป Chat หรือเรียกใช้ด้วยคำสั่งเครื่องหมายทับ) หากตั้งค่าเป็น "จริง" ระบบจะส่งออบเจ็กต์เหตุการณ์แยกต่างหากที่เชื่อมโยงกับการโต้ตอบไปยังแอปใน Chat |
configCompleteRedirectUri |
ไม่บังคับ URL ที่แอปใน Chat ควรเปลี่ยนเส้นทางผู้ใช้ไปหลังจากที่ผู้ใช้ทำขั้นตอนการให้สิทธิ์หรือการกำหนดค่านอก Google Chat เสร็จสมบูรณ์ ดูข้อมูลเพิ่มเติมได้ที่หัวข้อเชื่อมต่อแอปใน Chat กับบริการและเครื่องมืออื่นๆ |
RemovedFromSpacePayload
ผู้ใช้นำแอปใน Chat ออกจากพื้นที่ทำงาน
| การแสดง JSON |
|---|
{
"space": {
object ( |
| ช่อง | |
|---|---|
space |
ต้องระบุ พื้นที่ใน Chat ที่ออบเจ็กต์เหตุการณ์เกิดขึ้น |
ButtonClickedPayload
ผู้ใช้โต้ตอบกับองค์ประกอบแบบอินเทอร์แอกทีฟของการ์ดหรือกล่องโต้ตอบจากส่วนเสริมของ Chat ที่ทริกเกอร์ Callback Action แม้ว่าจะมีชื่อเช่นนี้ แต่เพย์โหลดนี้จะสร้างขึ้นสำหรับ Callback ของการ์ดและกล่องโต้ตอบ Action ทั้งหมด ซึ่งรวมถึงการคลิกปุ่ม, ทริกเกอร์ onChangeAction, การดำเนินการ onClick, การคลิก CardAction และการส่งหรือยกเลิกกล่องโต้ตอบ (SUBMIT_DIALOG และ CANCEL_DIALOG)
หากผู้ใช้โต้ตอบกับกล่องโต้ตอบ ระบบจะตั้งค่าช่อง isDialogEvent ของ ButtonClickedPayload เป็น true และรวม DialogEventType ไว้ด้วย เพย์โหลดนี้จะแมปกับประเภทเหตุการณ์ SUBMIT_FORM และ CARD_CLICKED สำหรับแอปใน Chat ที่ไม่ใช่ส่วนเสริม
เพย์โหลดที่สมบูรณ์ยังมี CommonEventObject.form_inputs และ CommonEventObject.parameters ด้วย
| การแสดง JSON |
|---|
{ "space": { object ( |
| ช่อง | |
|---|---|
space |
ต้องระบุ พื้นที่ใน Chat ที่ออบเจ็กต์เหตุการณ์เกิดขึ้น |
message |
ข้อความที่ทริกเกอร์ออบเจ็กต์เหตุการณ์ |
isDialogEvent |
สำหรับออบเจ็กต์เหตุการณ์ |
dialogEventType |
ประเภทของออบเจ็กต์เหตุการณ์กล่องโต้ตอบที่ได้รับ |
DialogEventType
สำหรับออบเจ็กต์เหตุการณ์ที่มีเพย์โหลดเหตุการณ์ ButtonClicked หรือ AppCommand ประเภทของการโต้ตอบกับกล่องโต้ตอบ
ดูข้อมูลเพิ่มเติมเกี่ยวกับออบเจ็กต์เหตุการณ์ของแอป Google Chat ได้ที่หัวข้อรับและตอบสนองต่อการโต้ตอบกับแอป Google Chat
| Enum | |
|---|---|
DIALOG_EVENT_TYPE_UNSPECIFIED |
ค่าเริ่มต้น ไม่ระบุ |
REQUEST_DIALOG |
ผู้ใช้เปิดกล่องโต้ตอบ |
SUBMIT_DIALOG |
ผู้ใช้คลิกองค์ประกอบแบบอินเทอร์แอกทีฟของกล่องโต้ตอบ เช่น ผู้ใช้กรอกข้อมูลในกล่องโต้ตอบและคลิกปุ่มเพื่อส่งข้อมูล |
CANCEL_DIALOG |
ผู้ใช้ปิดกล่องโต้ตอบโดยไม่ส่งข้อมูล หรือกล่องโต้ตอบถูกยกเลิก |
WidgetUpdatedPayload
ผู้ใช้อัปเดตวิดเจ็ตในการ์ดหรือกล่องโต้ตอบในสตรีม
เพย์โหลดที่สมบูรณ์ยังมี CommonEventObject.parameters['autocomplete_widget_query'] ด้วย
| การแสดง JSON |
|---|
{
"space": {
object ( |
| ช่อง | |
|---|---|
space |
ต้องระบุ พื้นที่ใน Chat ที่ออบเจ็กต์เหตุการณ์เกิดขึ้น |
AppCommandPayload
ผู้ใช้เรียกใช้คำสั่งแอป
| การแสดง JSON |
|---|
{ "appCommandMetadata": { object ( |
| ช่อง | |
|---|---|
appCommandMetadata |
ป้อนข้อมูลสำหรับคำสั่งแอป รวมถึงคำสั่งเครื่องหมายทับและคำสั่งด่วน |
space |
ไม่บังคับ พื้นที่ใน Chat ที่ออบเจ็กต์เหตุการณ์เกิดขึ้น |
thread |
ไม่บังคับ ชุดข้อความที่ออบเจ็กต์เหตุการณ์เกิดขึ้น (หากมี) ระบบจะป้อนข้อมูลในช่องนี้หากออบเจ็กต์เหตุการณ์เชื่อมโยงกับข้อความหรือชุดข้อความที่เฉพาะเจาะจง |
message |
ไม่บังคับ ข้อความที่ทริกเกอร์ออบเจ็กต์เหตุการณ์ (หากมี) ระบบจะป้อนข้อมูลในช่องนี้สำหรับคำสั่งเครื่องหมายทับเท่านั้น |
configCompleteRedirectUri |
ไม่บังคับ URL ที่ควรเปลี่ยนเส้นทางผู้ใช้ไปหลังจากที่ผู้ใช้ดำเนินการให้สิทธิ์หรือกำหนดค่าภายนอก Google Chat เสร็จสมบูรณ์ ดูข้อมูลเพิ่มเติมได้ที่หัวข้อเชื่อมต่อแอปใน Chat กับบริการและเครื่องมืออื่นๆ |
isDialogEvent |
ไม่บังคับ ผู้ใช้กำลังโต้ตอบหรือกำลังจะโต้ตอบกับกล่องโต้ตอบหรือไม่ |
dialogEventType |
ไม่บังคับ ประเภทของออบเจ็กต์เหตุการณ์กล่องโต้ตอบที่ได้รับ ช่องนี้จะมีผลก็ต่อเมื่อ |
AppCommandMetadata
ข้อมูลเมตาเกี่ยวกับคำสั่งแอปใน Chat
| การแสดง JSON |
|---|
{
"appCommandId": integer,
"appCommandType": enum ( |
| ช่อง | |
|---|---|
appCommandId |
รหัสสำหรับคำสั่งที่ระบุไว้ในการกำหนดค่า Chat API |
appCommandType |
ประเภทคำสั่งของแอปใน Chat |
AppCommandType
ประเภทคำสั่งของแอปใน Chat โปรดดูรายละเอียดที่หัวข้อประเภทคำสั่งของแอปใน Chat
| Enum | |
|---|---|
APP_COMMAND_TYPE_UNSPECIFIED |
ค่าเริ่มต้น ไม่ระบุ |
SLASH_COMMAND |
คำสั่งเครื่องหมายทับ ผู้ใช้ส่งคำสั่งในข้อความแชท |
QUICK_COMMAND |
คำสั่งด่วน ผู้ใช้เลือกคำสั่งจากเมนู Chat ในส่วนตอบกลับข้อความ |
MESSAGE_ACTION |
การดำเนินการกับข้อความ ผู้ใช้เลือกคำสั่งจากเมนูตามบริบทของข้อความใน Chat |
SystemCommandPayload
ผู้ใช้เรียกใช้คำสั่งของระบบ
| การแสดง JSON |
|---|
{ "systemCommandMetadata": { object ( |
| ช่อง | |
|---|---|
systemCommandMetadata |
ข้อมูลเมตาเกี่ยวกับคำสั่งของระบบที่มีการเรียกใช้ |
space |
ไม่บังคับ พื้นที่ใน Chat ที่ออบเจ็กต์เหตุการณ์เกิดขึ้น |
thread |
ไม่บังคับ ชุดข้อความที่ออบเจ็กต์เหตุการณ์เกิดขึ้น (หากมี) ระบบจะป้อนข้อมูลในช่องนี้หากออบเจ็กต์เหตุการณ์เชื่อมโยงกับข้อความหรือชุดข้อความที่เฉพาะเจาะจง |
SystemCommandMetadata
ข้อมูลเมตาเกี่ยวกับคำสั่งของระบบที่ผู้ใช้เรียกใช้
| การแสดง JSON |
|---|
{
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"cancelStream": {
object ( |
| ช่อง | |
|---|---|
| เรียกใช้คำสั่งของระบบแล้ว รายการต่อไปนี้คือช่องที่ใช้ร่วมกันไม่ได้ ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้ | |
cancelStream |
คำสั่งสำหรับยกเลิกข้อความสตรีมที่ใช้งานอยู่ |
| สิ้นสุดฟิลด์ที่แยกกันโดยสิ้นเชิง | |
CancelStream
คำสั่งสำหรับยกเลิกข้อความสตรีมที่ใช้งานอยู่
| การแสดง JSON |
|---|
{ "streamMessage": string } |
| ช่อง | |
|---|---|
streamMessage |
ต้องระบุ ชื่อทรัพยากรของข้อความสตรีมที่มีการใช้คำสั่งยกเลิก รูปแบบ: |
WorkflowEventObject
LINT.IfChange ออบเจ็กต์เหตุการณ์ที่ส่งไปยังส่วนเสริมเวิร์กโฟลว์
| การแสดง JSON |
|---|
{ "executionMetadata": { object ( |
| ช่อง | |
|---|---|
executionMetadata |
ข้อมูลเมตาเกี่ยวกับการดำเนินการเวิร์กโฟลว์ |
triggerEventSource |
แหล่งที่มาของเหตุการณ์ที่ทริกเกอร์ |
| ประเภทเพย์โหลดเหตุการณ์เวิร์กโฟลว์ รายการต่อไปนี้คือช่องที่ใช้ร่วมกันไม่ได้ ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้ | |
actionInvocation |
การเรียกใช้การดำเนินการเวิร์กโฟลว์ |
triggerCreation |
การสร้างทริกเกอร์เวิร์กโฟลว์ |
triggerDeletion |
การลบทริกเกอร์เวิร์กโฟลว์ |
resourceRetrieval |
การดึงข้อมูลทรัพยากร (ใช้สำหรับการขยายตัวแปร) |
elementConfiguration |
การกำหนดค่าองค์ประกอบเวิร์กโฟลว์ |
resourceFieldsDefinitionRetrieval |
การดึงข้อมูลการกำหนดฟิลด์ที่ทรัพยากรรองรับ |
elementUiAutocomplete |
คำแนะนำที่เติมข้อความอัตโนมัติสำหรับการ์ดที่แสดงผลอยู่ในปัจจุบัน |
| สิ้นสุดฟิลด์ที่แยกกันโดยสิ้นเชิง | |
ActionInvocation
การเรียกใช้การดำเนินการเวิร์กโฟลว์
| การแสดง JSON |
|---|
{ "inputs": { string: { object ( |
| ช่อง | |
|---|---|
inputs |
แผนที่ของตัวแปรอินพุตที่คีย์ตามชื่อตัวแปรอินพุต ออบเจ็กต์ที่มีรายการคู่ |
triggerId |
รหัสทริกเกอร์ที่จะใช้สำหรับการตอบกลับการดำเนินการแบบไม่พร้อมกัน |
flowLevelContext |
ไม่บังคับ บริบทระดับโฟลว์จากขั้นตอนก่อนหน้า |
VariableData
แสดงข้อมูลตัวแปร ซึ่งเก็บค่าได้หลายค่าซึ่งมีประเภทต่างกัน
| การแสดง JSON |
|---|
{ "booleanValues": [ boolean ], "integerValues": [ string ], "floatValues": [ number ], "stringValues": [ string ], "timestampValues": [ string ], "resourceReferences": [ { object ( |
| ช่อง | |
|---|---|
booleanValues[] |
ค่าบูลีน |
integerValues[] |
ค่าจำนวนเต็ม |
floatValues[] |
ค่าจำนวนลอยตัว |
stringValues[] |
ค่าสตริง |
timestampValues[] |
ค่าการประทับเวลา ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น |
resourceReferences[] |
การอ้างอิงทรัพยากร (รหัส) |
emailAddressValues[] |
ค่าอีเมล |
googleUserValues[] |
ค่าผู้ใช้ Google ในรูปแบบ |
textFormatValues[] |
ค่ารูปแบบข้อความของเวิร์กโฟลว์ |
ResourceReference
ค่ารหัสของทรัพยากรเฉพาะแอปพลิเคชัน
| การแสดง JSON |
|---|
{
"resourceType": {
object ( |
| ช่อง | |
|---|---|
resourceType |
ประเภทของทรัพยากรที่รหัสนี้ชี้ไป |
resourceId |
รหัสของทรัพยากร |
ResourceType
ชื่อประเภททรัพยากรที่กำหนดเอง
| การแสดง JSON |
|---|
{ "workflowBundleId": string, "workflowResourceDefinitionId": string } |
| ช่อง | |
|---|---|
workflowBundleId |
รหัสของแพ็กเกจเวิร์กโฟลว์ที่เป็นเจ้าของทรัพยากรประเภทนี้ ซึ่งเป็นค่าที่ไม่บังคับ และหากเว้นว่างไว้ ระบบจะถือว่าเป็นแพ็กเกจเดียวกับที่ใช้แพ็กเกจนั้นอยู่ |
workflowResourceDefinitionId |
ตัวระบุที่ไม่ซ้ำกันของทรัพยากร โดยรหัสนี้ต้องไม่ซ้ำกันภายในแพ็กเกจเดียวกันเท่านั้น |
WorkflowTextFormat
บล็อกข้อความที่มีตัวเลือกการจัดรูปแบบที่หลากหลาย ซึ่งรวมถึงรูปแบบ ไฮเปอร์ลิงก์ และองค์ประกอบแบบอินเทอร์แอกทีฟ
| การแสดง JSON |
|---|
{
"textFormatElements": [
{
object ( |
| ช่อง | |
|---|---|
textFormatElements[] |
คอลเล็กชันองค์ประกอบรูปแบบข้อความ |
TextFormatElement
องค์ประกอบเดียวภายในข้อความ WorkflowTextFormat ซึ่งอาจเป็นชิป ข้อความที่มีสไตล์ ไฮเปอร์ลิงก์ หรือคอนเทนเนอร์รายการ
| การแสดง JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "text": string, "chip": { object ( |
| ช่อง | |
|---|---|
| องค์ประกอบที่แสดงถึงองค์ประกอบรูปแบบข้อความที่เป็นไปได้รายการใดรายการหนึ่ง รายการต่อไปนี้คือช่องที่ใช้ร่วมกันไม่ได้ ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้ | |
text |
ข้อความในรูปแบบข้อความ |
chip |
ชิปที่คลิกได้ในรูปแบบข้อความ |
styledText |
ข้อความที่มีการจัดสไตล์ในรูปแบบข้อความ |
hyperlink |
ไฮเปอร์ลิงก์ในรูปแบบข้อความ |
listContainer |
คอนเทนเนอร์รายการในรูปแบบข้อความ |
| สิ้นสุดฟิลด์ที่แยกกันโดยสิ้นเชิง | |
ชิป
ชิปที่คลิกได้ในรูปแบบข้อความ
| การแสดง JSON |
|---|
{
"icon": {
object ( |
| ช่อง | |
|---|---|
icon |
ไอคอนที่แสดงในชิป |
label |
ข้อความที่แสดงในชิป |
url |
URL ที่จะไปยังเมื่อคลิกชิป |
ไอคอน
ไอคอนในชิป
| การแสดง JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "iconUrl": string, "materialIconName": string // End of mutually exclusive fields. } |
| ช่อง | |
|---|---|
| ไอคอนที่แสดงในชิป รายการต่อไปนี้คือช่องที่ใช้ร่วมกันไม่ได้ ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้ | |
iconUrl |
แสดงไอคอนที่กำหนดเองซึ่งโฮสต์ที่ HTTPS URL เช่น ประเภทไฟล์ที่รองรับ ได้แก่ |
materialIconName |
ชื่อไอคอนที่กำหนดไว้ในไอคอนจากดีไซน์ Material ของ Google เช่น |
| สิ้นสุดฟิลด์ที่แยกกันโดยสิ้นเชิง | |
StyledText
องค์ประกอบของข้อความที่มีรูปแบบต่างๆ เช่น ตัวหนา ตัวเอียง และสี
| การแสดง JSON |
|---|
{ "text": string, "styles": [ enum ( |
| ช่อง | |
|---|---|
text |
เนื้อหาหลักของข้อความ |
styles[] |
คอลเล็กชันของรูปแบบที่ใช้กับข้อความ |
fontWeight |
น้ำหนักแบบอักษรของข้อความ |
color |
สีของข้อความ |
wrapStyle |
รูปแบบการตัดข้อความขึ้นบรรทัดใหม่ |
รูปแบบ
Enum สำหรับรูปแบบข้อความต่างๆ เช่น ตัวเอียง ขีดเส้นใต้ ฯลฯ
| Enum | |
|---|---|
STYLE_UNSPECIFIED |
ไม่ได้ใช้รูปแบบ DO NOT USE. |
ITALIC |
รูปแบบตัวเอียง |
UNDERLINE |
รูปแบบขีดเส้นใต้ |
STRIKETHROUGH |
รูปแบบขีดทับ |
LINE_BREAK |
ขึ้นบรรทัดใหม่ |
UPPERCASE |
รูปแบบตัวพิมพ์ใหญ่ |
CODE |
เขียนโค้ด |
CODE_BLOCK |
โค้ดบล็อก |
FontWeight
Enum สำหรับน้ำหนักแบบอักษรต่างๆ
| Enum | |
|---|---|
FONT_WEIGHT_UNSPECIFIED |
น้ำหนักมาตรฐานที่มีความหนาปกติ DO NOT USE. |
LIGHT |
น้ำหนักเบาลงและบางลง |
MEDIUM |
น้ำหนักปานกลางระหว่างบางและหนา |
BOLD |
น้ำหนักมากขึ้นและหนาขึ้น |
WrapStyle
Enum สำหรับรูปแบบการตัดข้อความที่แตกต่างกัน
| Enum | |
|---|---|
WRAP_STYLE_UNSPECIFIED |
ไม่ได้ระบุรูปแบบการตัดข้อความ |
NO_WRAP |
ไม่มีรูปแบบการตัดข้อความ |
ไฮเปอร์ลิงก์
องค์ประกอบไฮเปอร์ลิงก์ที่มีข้อความและลิงก์
| การแสดง JSON |
|---|
{ "link": string, "text": string } |
| ช่อง | |
|---|---|
link |
URL ปลายทางของไฮเปอร์ลิงก์ |
text |
ข้อความของไฮเปอร์ลิงก์ |
ListContainer
คอนเทนเนอร์สำหรับรายการในลิสต์ โดยแต่ละรายการในลิสต์สามารถมี TextFormatElement ได้หลายรายการ
| การแสดง JSON |
|---|
{ "listNestLevel": string, "listType": enum ( |
| ช่อง | |
|---|---|
listNestLevel |
ระดับการซ้อนของรายการ เริ่มต้นจาก 0 สำหรับระดับบนสุด และเพิ่มขึ้นทีละ 1 สำหรับรายการที่ฝังแต่ละรายการ |
listType |
ประเภทของรายการ |
listItems[] |
คอลเล็กชันของรายการในลิสต์ |
ListType
Enum สำหรับรายการประเภทต่างๆ
| Enum | |
|---|---|
LIST_TYPE_UNSPECIFIED |
ไม่ได้ระบุประเภทรายการ DO NOT USE. |
ORDERED |
รายการตามลำดับ |
UNORDERED |
รายการที่ไม่เรียงลำดับ |
BLOCKQUOTE |
แสดงรายการ Blockquote |
ListItem
รายการ
| การแสดง JSON |
|---|
{
"textFormatElements": [
{
object ( |
| ช่อง | |
|---|---|
textFormatElements[] |
คอลเล็กชันองค์ประกอบรูปแบบข้อความ |
FlowLevelContext
บริบทระดับโฟลว์ที่มีเอาต์พุตจากขั้นตอนก่อนหน้า
| การแสดง JSON |
|---|
{
"stepContexts": [
{
object ( |
| ฟิลด์ | |
|---|---|
stepContexts[] |
ไม่บังคับ รายการขั้นตอนก่อนหน้า ลำดับมีความสำคัญ ดังนั้นโปรดตรวจสอบว่าลำดับการดำเนินการยังคงอยู่ในรายการนี้ |
StepContext
ข้อมูลเมตาและเอาต์พุตของบริบทขั้นตอนสำหรับบริบทระดับโฟลว์
| การแสดง JSON |
|---|
{
"stepId": string,
"outputs": {
string: {
object ( |
| ฟิลด์ | |
|---|---|
stepId |
ไม่บังคับ รหัสที่ไม่ซ้ำกันของขั้นตอนในกราฟเวิร์กโฟลว์ |
outputs |
ไม่บังคับ แผนที่ของตัวแปรผลลัพธ์ที่สร้างขึ้นโดยขั้นตอนนี้ โดยมีคีย์เป็นชื่อตัวแปร ออบเจ็กต์ที่มีรายการคู่ |
TriggerCreation
การสร้างทริกเกอร์เวิร์กโฟลว์
| การแสดง JSON |
|---|
{ "triggerId": string, "triggerType": enum ( |
| ช่อง | |
|---|---|
triggerId |
ตัวระบุที่ไม่ซ้ำกันของทริกเกอร์ที่ระบุระหว่างการสร้าง |
triggerType |
ประเภทของทริกเกอร์ |
inputs |
แผนที่ของตัวแปรอินพุตที่คีย์ตามชื่อตัวแปรอินพุต ออบเจ็กต์ที่มีรายการคู่ |
notifyUri |
ปลายทางที่จะเรียกใช้เมื่อทริกเกอร์เริ่มทำงาน |
TriggerType
ประเภทของทริกเกอร์
| Enum | |
|---|---|
TRIGGER_TYPE_UNDEFINED |
ค่าเริ่มต้น DO NOT USE. |
REPEATING |
ทริกเกอร์จะเริ่มทำงานทุกครั้งที่เป็นไปตามเงื่อนไขอินพุต |
TriggerDeletion
การลบทริกเกอร์เวิร์กโฟลว์
| การแสดง JSON |
|---|
{ "triggerId": string } |
| ช่อง | |
|---|---|
triggerId |
ตัวระบุที่ไม่ซ้ำกันของทริกเกอร์ที่ระบุระหว่างการสร้าง |
ResourceRetrieval
การดึงข้อมูลทรัพยากร
| การแสดง JSON |
|---|
{
"resourceReference": {
object ( |
| ช่อง | |
|---|---|
resourceReference |
ประเภทและรหัสของทรัพยากรที่จะดึงข้อมูล |
ElementConfiguration
การเรียกใช้เมื่อกำหนดค่าองค์ประกอบเวิร์กโฟลว์
| การแสดง JSON |
|---|
{ "inputs": { string: { object ( |
| ช่อง | |
|---|---|
inputs |
แผนที่ของตัวแปรอินพุตที่คีย์ตามชื่อตัวแปรอินพุต แผนที่นี้อาจว่างเปล่า ใช้เมื่อกำหนดค่าองค์ประกอบเวิร์กโฟลว์เดียว (ทริกเกอร์หรือการดำเนินการ) ในหน้าแรกของเวิร์กโฟลว์ ออบเจ็กต์ที่มีรายการคู่ |
displayDestination |
ปลายทางของการ์ดการกำหนดค่าองค์ประกอบ องค์ประกอบสามารถใช้ช่องนี้เพื่อแสดงเลย์เอาต์การ์ดการกำหนดค่าที่แตกต่างกันตามปลายทาง |
nodeId |
รหัสโหนดของการกำหนดค่าพื้นฐานที่แสดงผล |
workflowId |
รหัสเวิร์กโฟลว์ของการกำหนดค่าเบื้องต้นที่แสดงผล |
availableVariables[] |
ตัวแปรที่ใช้ได้จะเรียงตามตำแหน่งโหนด |
DisplayDestination
ระบุตำแหน่งที่จะแสดงการ์ดการกำหนดค่าองค์ประกอบที่แสดงผล
| Enum | |
|---|---|
DISPLAY_DESTINATION_UNSPECIFIED |
ค่าเริ่มต้น DO NOT USE. |
DISPLAY_DESTINATION_SIDE_PANEL |
การ์ดการกำหนดค่าจะแสดงในแผงด้านข้าง |
DISPLAY_DESTINATION_FULL_SCREEN |
การ์ดการกำหนดค่าจะแสดงในแอปแบบเต็มหน้าจอ |
VariableReference
การอ้างอิงตัวแปรไปยังตัวแปรในเวิร์กโฟลว์
| การแสดง JSON |
|---|
{
"parentElementId": string,
"nodeId": string,
"path": string,
"dataType": {
object ( |
| ช่อง | |
|---|---|
parentElementId |
รหัสพื้นฐานขององค์ประกอบที่สร้างตัวแปร เราสามารถขยายรหัสนี้เป็น WorkflowElement หรือโปรโตข้อมูลเมตาที่ละเอียดขึ้นได้หากจำเป็น |
nodeId |
รหัสอ้างอิงโหนด |
path |
ลายเซ็นเส้นทางของตัวเลือกตัวแปร |
dataType |
ประเภทข้อมูลตัวแปร |
iconUrl |
URL ไอคอนขององค์ประกอบพื้นฐานที่สร้างตัวแปรนี้ |
stepNumber |
หมายเลขขั้นตอนขององค์ประกอบพื้นฐานที่สร้างตัวแปรนี้ |
descriptionText |
คำอธิบายของตัวแปร |
displayText |
ข้อความที่แสดงของชิปตัวแปร |
DataType
ประเภทของตัวแปร
| การแสดง JSON |
|---|
{ "valueMetadata": { object ( |
| ช่อง | |
|---|---|
valueMetadata |
ข้อมูลเมตาเกี่ยวกับค่าที่เป็นไปได้ของตัวแปร |
| ประเภทของข้อมูล รายการต่อไปนี้คือช่องที่ใช้ร่วมกันไม่ได้ ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้ | |
basicType |
ประเภทข้อมูลพื้นฐาน |
resourceType |
ประเภทรหัสทรัพยากรของแอปพลิเคชัน |
| สิ้นสุดฟิลด์ที่แยกกันโดยสิ้นเชิง | |
BasicType
ประเภทข้อมูลทั่วไปพื้นฐาน
| Enum | |
|---|---|
BASIC_TYPE_UNSPECIFIED |
ค่าเริ่มต้น DO NOT USE. |
STRING |
สตริงอักขระ |
INTEGER |
จำนวนเต็ม |
FLOAT |
ซึ่งเป็นเลขทศนิยม |
TIMESTAMP |
การประทับเวลาในรูปแบบ ISO 8601 |
BOOLEAN |
ค่าที่เป็นจริงหรือเท็จได้ |
EMAIL_ADDRESS |
อีเมล ซึ่งเป็นสตริงในรูปแบบของอีเมล |
GOOGLE_USER |
ผู้ใช้บริการของ Google ในรูปแบบ users/{user} |
FILE |
ข้อมูลอ้างอิงไฟล์ |
FORMATTED_TEXT |
ข้อความที่มีการจัดรูปแบบ Rich Text |
ValueMetadata
ข้อมูลเกี่ยวกับค่าที่เป็นไปได้ของตัวแปร
| การแสดง JSON |
|---|
{ "enumValues": [ string ], "dynamicTypes": [ enum ( |
| ฟิลด์ | |
|---|---|
enumValues[] |
ไม่บังคับ ระบุค่าที่อนุญาตสำหรับสตริง คุณจะตั้งค่านี้ได้ก็ต่อเมื่อ |
dynamicTypes[] |
ไม่บังคับ ระบุประเภทที่อนุญาตซึ่งสามารถแคสต์แบบไดนามิกสำหรับตัวแปรได้ ซึ่งจะตั้งค่าได้ก็ต่อเมื่อ DataType เป็นสตริงและตัวแปรเป็นเอาต์พุต |
semanticDescriptors[] |
ไม่บังคับ ช่วยอธิบายความหมายเชิงความหมายของตัวแปร |
dynamicSchema |
ไม่บังคับ การกำหนดค่าสำหรับการแก้ไขสคีมาของตัวแปรนี้แบบไดนามิก |
defaultValue |
ไม่บังคับ สตริงที่ระบุค่าเริ่มต้นสำหรับตัวแปรนี้ เช่น สำหรับบูลีน ระบบอาจตั้งค่า |
SemanticDescriptor
ข้อมูลเมตาเกี่ยวกับความหมายเชิงความหมายของตัวแปร
| การแสดง JSON |
|---|
{ "resourceAttribute": string, "disallowedResourceAttributes": [ string ] } |
| ช่อง | |
|---|---|
resourceAttribute |
ระบุว่าตัวแปรสอดคล้องกับแอตทริบิวต์ที่เฉพาะเจาะจงของทรัพยากร ซึ่งจะเป็นประโยชน์อย่างยิ่งสำหรับตัวแปรที่แสดงตัวระบุของทรัพยากร (รหัส, URL, คีย์ ฯลฯ) รูปแบบที่แนะนำคือ - ตัวอย่าง: - ไคลเอ็นต์จะใช้ข้อมูลนี้เพื่อบอกใบ้ผู้ใช้ว่าตัวแปรผลลัพธ์ใดเข้ากันได้กับอินพุตหนึ่งๆ |
disallowedResourceAttributes[] |
ไม่บังคับ ใช้ได้กับอินพุตเท่านั้น และระบบจะไม่สนใจเอาต์พุต แอตทริบิวต์ที่ไม่ได้รับอนุญาตซึ่งสอดคล้องกับข้อบ่งชี้เชิงความหมายนี้ ไคลเอ็นต์จะป้องกันการเลือกตัวแปรสำหรับเอาต์พุตที่สอดคล้องกับแอตทริบิวต์ทรัพยากรที่ไม่อนุญาตเหล่านี้อย่างชัดเจน |
DynamicSchema
การกำหนดค่าสำหรับการแก้ไขสคีมาของตัวแปรนี้แบบไดนามิกที่รันไทม์
| การแสดง JSON |
|---|
{ "requiredInputIds": [ string ], "strictEnum": boolean } |
| ช่อง | |
|---|---|
requiredInputIds[] |
รหัสของตัวแปรอินพุตที่เกี่ยวข้องซึ่งต้องระบุก่อนจึงจะแก้ไขสคีมาของตัวแปรนี้แบบไดนามิกได้ |
strictEnum |
เมื่อเป็นจริง ค่าของตัวแปรต้องตรงกับค่า enum ที่ได้รับการแก้ไขแบบไดนามิกค่าใดค่าหนึ่ง เมื่อเป็นเท็จ ระบบจะถือว่าค่าที่แก้ไขแบบไดนามิกเป็นคำแนะนำที่ไม่เข้มงวด |
ResourceFieldsDefinitionRetrieval
ดึงข้อมูลคำจำกัดความของฟิลด์ที่ทรัพยากรรองรับ
| การแสดง JSON |
|---|
{
"elementId": string,
"inputs": {
string: {
object ( |
| ช่อง | |
|---|---|
elementId |
ระบุรหัสขององค์ประกอบที่มีสคีมาทรัพยากรแบบไดนามิกที่จะดึงข้อมูล |
inputs |
ซึ่งประกอบด้วยอินพุตช่องของโหนดที่ให้ตัวแปร แผนที่ของตัวแปรอินพุตที่คีย์ตามชื่อตัวแปรอินพุต ออบเจ็กต์ที่มีรายการคู่ |
ElementUiAutocomplete
คำแนะนำที่เติมข้อความอัตโนมัติสำหรับการ์ดที่แสดงผลอยู่ในปัจจุบัน
| การแสดง JSON |
|---|
{
"query": string,
"inputs": {
string: {
object ( |
| ช่อง | |
|---|---|
query |
คำค้นหาที่จะเติมข้อความอัตโนมัติ |
inputs |
แผนที่ของตัวแปรอินพุตที่คีย์ตามชื่อตัวแปรอินพุต ออบเจ็กต์ที่มีรายการคู่ |
invokedFunction |
ฟังก์ชันที่เรียกใช้ซึ่งเชื่อมโยงกับวิดเจ็ต |
resourceId |
รหัสทรัพยากรที่ควรเติมข้อความอัตโนมัติ ฟิลด์นี้เป็นฟิลด์ที่ไม่บังคับและอาจไม่ได้ตั้งค่าไว้ |
operationId |
รหัสของการดำเนินการที่ระบุทรัพยากรที่จะเติมข้อความอัตโนมัติ ฟิลด์นี้เป็นฟิลด์ที่ไม่บังคับและอาจไม่ได้ตั้งค่าไว้ |
ExecutionMetadata
ข้อมูลเมตาเกี่ยวกับการดำเนินการเวิร์กโฟลว์
| การแสดง JSON |
|---|
{ "versionId": integer, "timeZone": string, "stepNumber": integer } |
| ช่อง | |
|---|---|
versionId |
เวอร์ชันขององค์ประกอบเวิร์กโฟลว์ที่เรียกใช้ |
timeZone |
เขตเวลาของเวิร์กโฟลว์ที่บันทึก เช่น "America/Los_Angeles" |
stepNumber |
แสดงหมายเลขขั้นตอนของพริมิทีฟที่เรียกใช้ |
TriggerEventSource
แหล่งที่มาของเหตุการณ์ทริกเกอร์ที่ทริกเกอร์การดำเนินการนี้
| Enum | |
|---|---|
TRIGGER_EVENT_SOURCE_UNSPECIFIED |
ค่าเริ่มต้น DO NOT USE. |
TRIGGER_EVENT_SOURCE_AUTOMATED |
การดำเนินการจะทริกเกอร์โดยอัตโนมัติจากเหตุการณ์ |
TRIGGER_EVENT_SOURCE_TEST_RUN |
การดำเนินการจะทริกเกอร์ผ่านการรันเพื่อทดสอบ |