Event

เหตุการณ์การโต้ตอบกับแอป Google Chat

ดูข้อมูลเกี่ยวกับเหตุการณ์การโต้ตอบได้ที่หัวข้อรับและตอบกลับการโต้ตอบกับแอป Google Chat หากต้องการดูข้อมูลเกี่ยวกับประเภทเหตุการณ์และตัวอย่างเพย์โหลดของเหตุการณ์ โปรดดูประเภทของเหตุการณ์การโต้ตอบในแอป Google Chat

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

การแสดง JSON 
{
  "type": enum (EventType),
  "eventTime": string,
  "token": string,
  "threadKey": string,
  "message": {
    object (Message)
  },
  "user": {
    object (User)
  },
  "space": {
    object (Space)
  },
  "action": {
    object (FormAction)
  },
  "configCompleteRedirectUrl": string,
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType),
  "common": {
    object (CommonEventObject)
  }
}
ช่อง
type

enum (EventType)

ประเภทของเหตุการณ์การโต้ตอบ โปรดดูรายละเอียดที่หัวข้อประเภทเหตุการณ์การโต้ตอบกับแอป Google Chat
eventTime

string (Timestamp format)

การประทับเวลาที่ระบุเมื่อเหตุการณ์การโต้ตอบเกิดขึ้น
token

string

ค่าลับที่แอป Chat เดิมสามารถใช้เพื่อยืนยันว่าคำขอมาจาก Google หรือไม่ Google จะสร้างโทเค็นแบบสุ่ม และค่าโทเค็นจะยังคงอยู่ คุณจะรับ เพิกถอน หรือสร้างโทเค็นใหม่ได้จากหน้าการกำหนดค่า Chat API ใน Google Cloud Console

แอป Chat สมัยใหม่ไม่ใช้ช่องนี้ ซึ่งจะไม่แสดงในการตอบกลับจาก API และหน้าการกำหนดค่า Chat API
threadKey

string

คีย์ที่แอป Chat กำหนดสำหรับชุดข้อความที่เกี่ยวข้องกับเหตุการณ์การโต้ตอบ ดูข้อมูลเพิ่มเติมได้ที่ spaces.messages.thread.threadKey
message

object (Message)

ข้อความที่เรียกเหตุการณ์การโต้ตอบ (หากมี)
user

object (User)

ผู้ใช้ที่ทริกเกอร์เหตุการณ์การโต้ตอบ
space

object (Space)

พื้นที่ที่เกิดเหตุการณ์การโต้ตอบ
action

object (FormAction)

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

string

URL ที่แอป Chat ควรเปลี่ยนเส้นทางผู้ใช้ไปหลังจากเสร็จสิ้นขั้นตอนการให้สิทธิ์หรือกำหนดค่านอก Google Chat แล้ว โปรดดูข้อมูลเพิ่มเติมที่หัวข้อเชื่อมต่อแอป Chat กับบริการและเครื่องมืออื่นๆ
isDialogEvent

boolean

สำหรับเหตุการณ์การโต้ตอบ CARD_CLICKED รายการ ไม่ว่าผู้ใช้จะโต้ตอบกับกล่องโต้ตอบหรือไม่
dialogEventType

enum (DialogEventType)

ประเภทของเหตุการณ์การโต้ตอบในกล่องโต้ตอบที่ได้รับ
common

object (CommonEventObject)

แสดงข้อมูลเกี่ยวกับไคลเอ็นต์ของผู้ใช้ เช่น ภาษา แอปโฮสต์ และแพลตฟอร์ม สำหรับแอปใน Chat CommonEventObject จะมีข้อมูลที่ส่งมาจากผู้ใช้ที่โต้ตอบกับกล่องโต้ตอบ เช่น ข้อมูลที่ป้อนลงในการ์ด

CommonEventObject

แสดงข้อมูลเกี่ยวกับไคลเอ็นต์ของผู้ใช้ เช่น ภาษา แอปโฮสต์ และแพลตฟอร์ม สำหรับแอปใน Chat CommonEventObject จะรวมข้อมูลที่ส่งจากผู้ใช้ที่โต้ตอบกับการ์ด เช่น ข้อมูลที่ป้อนในกล่องโต้ตอบ

การแสดง JSON 
{
  "userLocale": string,
  "hostApp": enum (HostApp),
  "platform": enum (Platform),
  "timeZone": {
    object (TimeZone)
  },
  "formInputs": {
    string: {
      object (Inputs)
    },
    ...
  },
  "parameters": {
    string: string,
    ...
  },
  "invokedFunction": string
}
ช่อง
userLocale

string

locale.displayName แบบเต็มในรูปแบบ [รหัสภาษา ISO 639]-[รหัสประเทศ/ภูมิภาค ISO 3166] เช่น "en-US"
hostApp

enum (HostApp)

enum ของ hostApp ที่บ่งชี้ว่าแอปมีการเรียกใช้ส่วนเสริม CHAT เสมอสำหรับแอป Chat
platform

enum (Platform)

enum ของแพลตฟอร์มซึ่งระบุแพลตฟอร์มที่เหตุการณ์เกิดขึ้น (WEB, IOS หรือ ANDROID) ไม่รองรับในแอป Chat
timeZone

object (TimeZone)

รหัสเขตเวลาและการชดเชยจากเวลาสากลเชิงพิกัด (UTC) รองรับเฉพาะประเภทเหตุการณ์ CARD_CLICKED และ SUBMIT_DIALOG
formInputs

map (key: string, value: object (Inputs))

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

โปรดดูรายละเอียดที่หัวข้อประมวลผลข้อมูลที่ผู้ใช้ป้อน
parameters

map (key: string, value: string)

พารามิเตอร์ที่กำหนดเองที่ส่งผ่านไปยังฟังก์ชันที่เรียกใช้ ทั้งคีย์และค่าต้องเป็นสตริง
invokedFunction

string

ชื่อของฟังก์ชันที่เรียกใช้ซึ่งเชื่อมโยงกับวิดเจ็ต ตั้งค่าสำหรับแอป Chat เท่านั้น

TimeZone

รหัสเขตเวลาและการชดเชยจากเวลาสากลเชิงพิกัด (UTC) รองรับเฉพาะประเภทเหตุการณ์ CARD_CLICKED และ SUBMIT_DIALOG

การแสดง JSON 
{
  "id": string,
  "offset": integer
}
ช่อง
id

string

รหัสฐานข้อมูลเขตเวลา IANA TZ เช่น "อเมริกา/โตรอนโต"
offset

integer

การชดเชยเขตเวลาของผู้ใช้ในหน่วยมิลลิวินาทีจากเวลาสากลเชิงพิกัด (UTC)

อินพุต

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

การแสดง JSON 
{

  // Union field inputs can be only one of the following:
  "stringInputs": {
    object (StringInputs)
  },
  "dateTimeInput": {
    object (DateTimeInput)
  },
  "dateInput": {
    object (DateInput)
  },
  "timeInput": {
    object (TimeInput)
  }
  // End of list of possible types for union field inputs.
}
ช่อง

ฟิลด์สหภาพ inputs

inputs ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
stringInputs

object (StringInputs)

รายการสตริงที่แสดงถึงค่าที่ผู้ใช้ป้อนในวิดเจ็ต

หากวิดเจ็ตยอมรับเพียงค่าเดียว เช่น วิดเจ็ต TextInput รายการจะมีออบเจ็กต์สตริง 1 รายการ หากวิดเจ็ตยอมรับหลายค่า เช่น วิดเจ็ต SelectionInput ของช่องทำเครื่องหมาย รายการจะมีออบเจ็กต์สตริงสำหรับแต่ละค่าที่ผู้ใช้ป้อนหรือเลือก
dateTimeInput

object (DateTimeInput)

ค่าที่ป้อนวันที่และเวลาจากวิดเจ็ต DateTimePicker ที่ยอมรับทั้งวันที่และเวลา
dateInput

object (DateInput)

ค่าที่ป้อนวันที่จากวิดเจ็ต DateTimePicker ที่ยอมรับเฉพาะค่าวันที่เท่านั้น
timeInput

object (TimeInput)

ค่าที่ป้อนเวลาจากวิดเจ็ต DateTimePicker ที่ยอมรับเฉพาะค่าเวลาเท่านั้น

StringInputs

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

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

string

รายการสตริงที่ผู้ใช้ป้อน

DateTimeInput

ค่าที่ป้อนวันที่และเวลา

การแสดง JSON 
{
  "msSinceEpoch": string,
  "hasDate": boolean,
  "hasTime": boolean
}
ช่อง
msSinceEpoch

string (int64 format)

เวลานับจากเวลา Epoch ในหน่วยมิลลิวินาที
hasDate

boolean

อินพุต datetime มีวันที่ในปฏิทินหรือไม่
hasTime

boolean

อินพุต datetime มีการประทับเวลาหรือไม่

DateInput

ค่าที่ป้อนวันที่

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

string (int64 format)

เวลานับจากเวลา Epoch ในหน่วยมิลลิวินาที

TimeInput

ค่าที่ป้อนเวลา

การแสดง JSON 
{
  "hours": integer,
  "minutes": integer
}
ช่อง
hours

integer

ชั่วโมงในรูปแบบเวลา 24 ชั่วโมง
minutes

integer

จำนวนนาทีที่ผ่านมา ค่าที่ใช้ได้คือ 0 ถึง 59