Event

เหตุการณ์การโต้ตอบของแอป Google Chat ที่แสดงและมีข้อมูลเกี่ยวกับการโต้ตอบของผู้ใช้กับแอป Chat หากต้องการกำหนดค่าแอปใน 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)

ประเภทการโต้ตอบของผู้ใช้กับแอป Chat เช่น MESSAGE หรือ ADDED_TO_SPACE
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)

สำหรับเหตุการณ์การโต้ตอบ ADDED_TO_SPACE, CARD_CLICKED และ MESSAGE ข้อความที่ทริกเกอร์เหตุการณ์การโต้ตอบ หากมี
user

object (User)

ผู้ใช้ที่โต้ตอบกับแอป Chat
space

object (Space)

พื้นที่ทำงานที่ผู้ใช้โต้ตอบกับแอป Chat
action

object (FormAction)

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

string

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

boolean

สำหรับเหตุการณ์การโต้ตอบ CARD_CLICKED และ MESSAGE ไม่ว่าผู้ใช้จะโต้ตอบด้วยหรือกำลังจะโต้ตอบกับกล่องโต้ตอบ
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)

รหัสเขตเวลาและออฟเซ็ตจาก Coordinated Universal Time (UTC) รองรับเฉพาะประเภทเหตุการณ์ CARD_CLICKED และ SUBMIT_DIALOG
formInputs

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

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

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

map (key: string, value: string)

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

string

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

TimeZone

รหัสเขตเวลาและออฟเซ็ตจาก Coordinated Universal Time (UTC) รองรับเฉพาะประเภทเหตุการณ์ CARD_CLICKED และ SUBMIT_DIALOG

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

string

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

integer

ออฟเซ็ตเขตเวลาของผู้ใช้ในหน่วยมิลลิวินาทีจาก Coordinated Universal Time (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