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)
  },
  "appCommandMetadata": {
    object (AppCommandMetadata)
  }
}
ช่อง
type

enum (EventType)

ประเภทการโต้ตอบของผู้ใช้กับแอป Chat เช่น MESSAGE หรือ ADDED_TO_SPACE
eventTime

string (Timestamp format)

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

string

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

แอป 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 จะรวมข้อมูลที่ส่งโดยผู้ใช้ที่โต้ตอบกับกล่องโต้ตอบ เช่น ข้อมูลที่ป้อนในการ์ด
appCommandMetadata

object (AppCommandMetadata)

สร้างขึ้นสำหรับคำสั่งแอป ซึ่งรวมถึงคำสั่งเครื่องหมายทับและคำสั่งด่วน

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)

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

enum (Platform)

รายการค่าแพลตฟอร์มที่ระบุแพลตฟอร์มที่เป็นต้นทางของเหตุการณ์ (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)

เวลานับตั้งแต่เวลาเริ่มต้นเป็นมิลลิวินาที
hasDate

boolean

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

boolean

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

DateInput

ค่าอินพุตวันที่

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

string (int64 format)

เวลานับตั้งแต่เวลาเริ่มต้นเป็นมิลลิวินาที

TimeInput

ค่าอินพุตเวลา

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

integer

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

integer

จํานวนนาทีที่ผ่านไปแล้วในชั่วโมง ค่าที่ใช้ได้คือ 0 ถึง 59

AppCommandMetadata

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

การแสดง JSON 
{
  "appCommandId": integer,
  "appCommandType": enum (AppCommandType)
}
ช่อง
appCommandId

integer

รหัสคําสั่งสําหรับการโต้ตอบของแอปหนึ่งๆ
appCommandType

enum (AppCommandType)

ประเภทของคําสั่งแอป