EventObject

EventObject

เหตุการณ์การโต้ตอบกับส่วนเสริมของ Google ที่มีข้อมูลเกี่ยวกับการโต้ตอบของผู้ใช้กับส่วนเสริมภายในแอปโฮสต์

ระบบจะส่งออบเจ็กต์เหตุการณ์เป็น JSON ไปยังฟังก์ชัน Callback หรือทริกเกอร์ (สำหรับ AppsScript) ของส่วนเสริม หรือปลายทาง https (สำหรับ HTTP) เมื่อผู้ใช้โต้ตอบกับส่วนเสริมภายในแอปโฮสต์ ออบเจ็กต์เหตุการณ์จะจัดเก็บออบเจ็กต์เหตุการณ์ของแอปโฮสต์ที่กำหนดโดยแอปโฮสต์แต่ละแอป รวมถึงออบเจ็กต์เหตุการณ์ทั่วไปที่มีฟิลด์ทั่วไปบางฟิลด์ที่เกี่ยวข้องกับเหตุการณ์

ดูข้อมูลเพิ่มเติมได้ที่ออบเจ็กต์เหตุการณ์

การแสดง JSON
{
  "commonEventObject": {
    object (CommonEventObject)
  },
  "authorizationEventObject": {
    object (AuthorizationEventObject)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "calendar": {
    object (CalendarEventObject)
  },
  "drive": {
    object (DriveEventObject)
  },
  "gmail": {
    object (GmailEventObject)
  },
  "sheets": {
    object (SheetsEventObject)
  },
  "slides": {
    object (SlidesEventObject)
  },
  "docs": {
    object (DocsEventObject)
  },
  "chat": {
    object (ChatEventObject)
  },
  "workflow": {
    object (WorkflowEventObject)
  }
  // End of mutually exclusive fields.
}
ช่อง
commonEventObject

object (CommonEventObject)

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

authorizationEventObject

object (AuthorizationEventObject)

ตั้งค่าสำหรับคำขอไปยังปลายทาง HTTP เท่านั้น

รายการต่อไปนี้คือช่องที่ใช้ร่วมกันไม่ได้ ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
calendar

object (CalendarEventObject)

จะแสดงก็ต่อเมื่อโฮสต์ที่เรียกใช้คือ Google ปฏิทินเท่านั้น ออบเจ็กต์ที่มีข้อมูลปฏิทินและกิจกรรม

drive

object (DriveEventObject)

จะแสดงก็ต่อเมื่อโฮสต์ที่เรียกใช้คือ Google ไดรฟ์ ออบเจ็กต์ที่มีข้อมูลไดรฟ์

gmail

object (GmailEventObject)

จะแสดงก็ต่อเมื่อโฮสต์ที่เรียกใช้คือ Gmail เท่านั้น ออบเจ็กต์ที่มีข้อมูล Gmail

sheets

object (SheetsEventObject)

แสดงเมื่อโฮสต์ที่เรียกใช้คือ Google ชีตเท่านั้น ออบเจ็กต์ที่มีข้อมูลชีต

slides

object (SlidesEventObject)

จะแสดงก็ต่อเมื่อโฮสต์ที่เรียกใช้คือ Google สไลด์ ออบเจ็กต์ที่มีข้อมูลสไลด์

docs

object (DocsEventObject)

แสดงเมื่อโฮสต์ที่เรียกใช้คือ Google เอกสารเท่านั้น ออบเจ็กต์ที่มีข้อมูลเอกสาร

chat

object (ChatEventObject)

แสดงเฉพาะเมื่อโฮสต์การโทรเป็น Google Chat ออบเจ็กต์ที่มีข้อมูล Chat

workflow

object (WorkflowEventObject)

จะแสดงก็ต่อเมื่อโฮสต์ที่เรียกใช้คือ Google Workspace Studio เท่านั้น ออบเจ็กต์ที่มีข้อมูลเวิร์กโฟลว์

สิ้นสุดฟิลด์ที่แยกกันโดยสิ้นเชิง

CommonEventObject

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

นอกเหนือจากทริกเกอร์หน้าแรกและทริกเกอร์ตามบริบทแล้ว ส่วนเสริมจะสร้างและส่งออบเจ็กต์เหตุการณ์ไปยังฟังก์ชัน Callback ของการดำเนินการเมื่อผู้ใช้โต้ตอบกับวิดเจ็ต ฟังก์ชัน Callback ของส่วนเสริมสามารถค้นหาออบเจ็กต์เหตุการณ์ทั่วไปเพื่อกำหนดเนื้อหาของวิดเจ็ตที่เปิดอยู่ในไคลเอ็นต์ของผู้ใช้ เช่น ส่วนเสริมสามารถค้นหาข้อความที่ผู้ใช้ป้อนลงในวิดเจ็ต TextInput ในออบเจ็กต์ eventObject.commentEventObject.formInputs ได้

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

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

string

ปิดใช้โดยค่าเริ่มต้น ตัวระบุภาษาและประเทศ/ภูมิภาคของผู้ใช้ในรูปแบบรหัสภาษา ISO 639-รหัสประเทศ/ภูมิภาค ISO 3166 ตัวอย่างเช่น en-US

หากต้องการเปิดช่องนี้ คุณต้องตั้งค่า addOns.common.useLocaleFromApp เป็น true ในไฟล์ Manifest ของส่วนเสริม รายการขอบเขตของส่วนเสริมต้องมี https://www.googleapis.com/auth/script.locale ด้วย ดูรายละเอียดเพิ่มเติมได้ที่การเข้าถึงภาษาและเขตเวลาของผู้ใช้

hostApp

enum (HostApp)

ระบุแอปโฮสต์ที่ส่วนเสริมทำงานอยู่เมื่อสร้างออบเจ็กต์เหตุการณ์ ค่าที่เป็นไปได้มีดังนี้

  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
  • CHAT
platform

enum (Platform)

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

timeZone

object (TimeZone)

ปิดใช้โดยค่าเริ่มต้น รหัสเขตเวลาและการชดเชยจากเวลาสากลเชิงพิกัด (UTC) หากต้องการเปิดช่องนี้ คุณต้องตั้งค่า addOns.common.useLocaleFromApp เป็น true ในไฟล์ Manifest ของส่วนเสริม รายการขอบเขตของส่วนเสริมต้องมี https://www.googleapis.com/auth/script.locale ด้วย ดูรายละเอียดเพิ่มเติมได้ที่การเข้าถึงภาษาและเขตเวลาของผู้ใช้

รองรับเฉพาะประเภทเหตุการณ์ CARD_CLICKED และ SUBMIT_DIALOG

formInputs

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

แผนที่ที่มีค่าปัจจุบันของวิดเจ็ตในการ์ดที่แสดง คีย์แผนที่เป็นค่าสตริง name ที่กำหนดให้กับวิดเจ็ตอินพุตแต่ละรายการ (เช่น TextInput.name, SelectionInput.name, DateTimePicker.name หรือ DecoratedText.SwitchControl.name)

โครงสร้างของออบเจ็กต์ค่าแผนที่จะขึ้นอยู่กับประเภทวิดเจ็ต ดังนี้

หมายเหตุ: ตัวอย่างต่อไปนี้จัดรูปแบบสำหรับรันไทม์ V8 ของ Apps Script หากใช้รันไทม์ Rhino คุณต้องเพิ่ม [""] หลังค่า เช่น จัดรูปแบบออบเจ็กต์เหตุการณ์เป็น e.commonEventObject.formInputs.employeeName[""].stringInputs.value[0] แทนที่จะเป็น e.commonEventObject.formInputs.employeeName.stringInputs.value[0] ดูข้อมูลเพิ่มเติมเกี่ยวกับรันไทม์ใน Apps Script ได้ที่ภาพรวมรันไทม์ V8

  • วิดเจ็ตที่มีค่าเดียว (เช่น วิดเจ็ต TextInput หรือวิดเจ็ต SelectionInput ประเภท DROPDOWN หรือ RADIO_BUTTON): ออบเจ็กต์ StringInputs ที่มีรายการองค์ประกอบเดียว (หรือรายการว่างหากไม่ได้เลือก)

ตัวอย่าง: สำหรับวิดเจ็ตการป้อนข้อความที่มี employeeName เป็น name ให้เข้าถึงค่าการป้อนข้อความด้วย e.commonEventObject.formInputs.employeeName.stringInputs.value[0]

  • วิดเจ็ตที่มีหลายค่า (เช่น วิดเจ็ต SelectionInput ประเภท CHECK_BOX, SWITCH หรือ MULTI_SELECT): ออบเจ็กต์ StringInputs ที่มีรายการสตริง value ของรายการที่เลือก

ตัวอย่าง: สำหรับวิดเจ็ตที่มีหลายค่าซึ่งมี participants เป็น name ให้เข้าถึงอาร์เรย์ค่าด้วย e.commonEventObject.formInputs.participants.stringInputs.value

  • วิดเจ็ต DecoratedText.SwitchControl: ออบเจ็กต์ StringInputs เมื่อ selected เป็น true stringInputs.value จะมีช่อง value ของสวิตช์ (หรือ "" หากไม่ได้ระบุ value ไว้ หากสวิตช์หลายตัวใช้ name เดียวกัน value ของสวิตช์ที่เลือกแต่ละตัวจะรวมอยู่ในรายการ) เมื่อ selected เป็น false ระบบจะไม่รวม value ของสวิตช์จาก stringInputs.value

  • เครื่องมือเลือกวันที่และเวลา (DateTimePickerType.DATE_AND_TIME): DateTimeInput object

ตัวอย่าง: สำหรับเครื่องมือเลือกที่มี name เป็น myDTPicker ให้เข้าถึงออบเจ็กต์ DateTimeInput โดยใช้ e.commonEventObject.formInputs.myDTPicker.dateTimeInput

  • เครื่องมือเลือกวันที่เท่านั้น (DateTimePickerType.DATE_ONLY): DateInput object

ตัวอย่าง: สำหรับเครื่องมือเลือกที่มี name เป็น myDatePicker ให้เข้าถึงออบเจ็กต์ DateInput โดยใช้ e.commonEventObject.formInputs.myDatePicker.dateInput

  • เครื่องมือเลือกเวลาเท่านั้น (DateTimePickerType.TIME_ONLY): TimeInput object

ตัวอย่าง: สำหรับเครื่องมือเลือกที่มี name เป็น myTimePicker ให้เข้าถึงออบเจ็กต์ TimeInput โดยใช้ e.commonEventObject.formInputs.myTimePicker.timeInput

ออบเจ็กต์ที่มีรายการคู่ "key": value รายการ เช่น { "name": "wrench", "mass": "1.3kg", "count": "3" }

parameters

map (key: string, value: string)

พารามิเตอร์เพิ่มเติมที่คุณระบุให้กับการดำเนินการโดยใช้ actionParameters หรือ Action.setParameters()

เวอร์ชันตัวอย่างสำหรับนักพัฒนาซอฟต์แวร์: สำหรับส่วนเสริมที่ขยาย Google Chat หากต้องการแนะนำรายการตามสิ่งที่ผู้ใช้พิมพ์ในเมนูแบบเลือกได้หลายรายการ ให้ใช้ค่าของคีย์ "autocomplete_widget_query" (event.commonEventObject.parameters["autocomplete_widget_query"]) คุณสามารถใช้ค่านี้เพื่อค้นหาฐานข้อมูลและแนะนำรายการที่เลือกได้ให้แก่ผู้ใช้ขณะพิมพ์ โปรดดูรายละเอียดที่หัวข้อรวบรวมและประมวลผลข้อมูลจากผู้ใช้ Google Chat

ออบเจ็กต์ที่มีรายการคู่ "key": value รายการ เช่น { "name": "wrench", "mass": "1.3kg", "count": "3" }

invokedFunction

string

ชื่อฟังก์ชันที่จะเรียกใช้

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

string

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

offset

integer

ออฟเซ็ตเขตเวลาของผู้ใช้เป็นมิลลิวินาทีจากเวลาสากลเชิงพิกัด (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 (StringInputs)
  },
  "dateTimeInput": {
    object (DateTimeInput)
  },
  "dateInput": {
    object (DateInput)
  },
  "timeInput": {
    object (TimeInput)
  }
  // End of mutually exclusive fields.
}
ช่อง
รายการต่อไปนี้คือช่องที่ใช้ร่วมกันไม่ได้ ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
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

AuthorizationEventObject

สรุปข้อมูลการให้สิทธิ์สำหรับคำขอส่วนเสริม

การแสดง JSON
{
  "userOAuthToken": string,
  "userIdToken": string,
  "systemIdToken": string,
  "authorizedScopes": [
    string
  ]
}
ช่อง
userOAuthToken

string

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

userIdToken

string

โทเค็นรหัสผู้ใช้ปลายทาง หากมีการขอขอบเขตรหัสที่เหมาะสม

systemIdToken

string

โทเค็นรหัสสำหรับบัญชีบริการส่วนเสริมของ G Suite สำหรับการติดตั้งใช้งานนี้

authorizedScopes[]

string

รายการขอบเขต OAuth ที่ผู้ใช้ให้สิทธิ์

CalendarEventObject

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

ตารางต่อไปนี้แสดงช่องที่มีอยู่ในช่อง calendar ของออบเจ็กต์เหตุการณ์ ช่องที่ทำเครื่องหมายเป็นข้อมูลที่ผู้ใช้สร้างขึ้นจะแสดงในออบเจ็กต์เหตุการณ์ก็ต่อเมื่อข้อมูลนั้นแสดงในกิจกรรมในปฏิทินและส่วนเสริมตั้งค่าช่อง addOns.calendar.currentEventAccess manifest เป็น READ หรือ READ_WRITE

การแสดง JSON
{
  "id": string,
  "recurringEventId": string,
  "calendarId": string,
  "organizer": {
    object (Organizer)
  },
  "attendees": [
    {
      object (Attendee)
    }
  ],
  "conferenceData": {
    object (ConferenceData)
  },
  "capabilities": {
    object (Capabilities)
  }
}
ช่อง
id

string

รหัสกิจกรรม

recurringEventId

string

รหัสของกิจกรรมที่เกิดซ้ำ

calendarId

string

รหัสปฏิทิน

organizer

object (Organizer)

ออบเจ็กต์ที่แสดงถึงผู้จัดกิจกรรม

attendees[]

object (Attendee)

ข้อมูลที่ผู้ใช้สร้างขึ้น รายชื่อผู้เข้าร่วมกิจกรรมในปฏิทิน

conferenceData

object (ConferenceData)

ข้อมูลที่ผู้ใช้สร้างขึ้น ออบเจ็กต์ที่แสดงข้อมูลการประชุมที่เชื่อมโยงกับกิจกรรมนี้ เช่น รายละเอียดการประชุม Google Meet

capabilities

object (Capabilities)

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

ผู้จัด

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

string

อีเมลของผู้จัดกิจกรรม

ผู้เข้าร่วม

ออบเจ็กต์ผู้เข้าร่วมจะมีข้อมูลเกี่ยวกับผู้เข้าร่วมแต่ละรายในกิจกรรมใน 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

string

อีเมลของผู้เข้าร่วม

displayName

string

ชื่อที่แสดงของผู้เข้าร่วม

organizer

boolean

true หากผู้เข้าร่วมเป็นผู้จัดกิจกรรมนี้

self

boolean

true หากผู้เข้าร่วมรายนี้แสดงถึงปฏิทินที่กิจกรรมนี้ปรากฏอยู่ หรือเป็น false ในกรณีอื่นๆ

resource

boolean

true หากผู้เข้าร่วมเป็นตัวแทนของทรัพยากร เช่น ห้องหรืออุปกรณ์ หากไม่เป็น false

optional

boolean

true หากการเข้าร่วมของผู้เข้าร่วมรายนี้ถูกทำเครื่องหมายว่าไม่บังคับ หรือเป็น false หากไม่ใช่

responseStatus

string

สถานะการตอบกลับของผู้เข้าร่วม ค่าที่เป็นไปได้มีดังนี้

  • accepted: ผู้เข้าร่วมยอมรับคำเชิญเข้าร่วมกิจกรรม
  • declined: ผู้เข้าร่วมปฏิเสธคำเชิญเข้าร่วมกิจกรรม
  • needsAction: ผู้เข้าร่วมยังไม่ได้ตอบกลับคำเชิญเข้าร่วมกิจกรรม
  • tentative: ผู้เข้าร่วมตอบรับคำเชิญเข้าร่วมกิจกรรมแบบไม่แน่ใจ
comment

string

ความคิดเห็นในการตอบกลับของผู้เข้าร่วม (หากมี)

additionalGuests

integer

จำนวนผู้เข้าร่วมเพิ่มเติมที่ผู้เข้าร่วมระบุว่าจะพามาด้วย ค่าเริ่มต้นคือ 0

ConferenceData

ออบเจ็กต์ข้อมูลการประชุมจะมีข้อมูลเกี่ยวกับการประชุมที่แนบมากับกิจกรรมใน Google ปฏิทิน ซึ่งอาจเป็นโซลูชันการประชุมของ Google เช่น Google Meet หรือการประชุมของบุคคลที่สาม ข้อมูลนี้จะแสดงในออบเจ็กต์เหตุการณ์ก็ต่อเมื่อข้อมูลแสดงในกิจกรรมในปฏิทินและส่วนเสริมตั้งค่าช่อง addOns.calendar.currentEventAccess manifest เป็น READ หรือ READ_WRITE

การแสดง JSON
{
  "conferenceId": string,
  "conferenceSolution": {
    object (ConferenceSolution)
  },
  "entryPoints": [
    {
      object (EntryPoint)
    }
  ],
  "notes": string,
  "parameters": {
    object (Parameters)
  }
}
ช่อง
conferenceId

string

รหัสของการประชุม รหัสนี้มีไว้เพื่อให้แอปพลิเคชันติดตามการประชุมได้ คุณไม่ควรแสดงรหัสนี้แก่ผู้ใช้

conferenceSolution

object (ConferenceSolution)

ออบเจ็กต์ที่แสดงถึงโซลูชันการประชุม เช่น Hangouts หรือ Google Meet

entryPoints[]

object (EntryPoint)

รายการจุดแรกเข้าของการประชุม เช่น URL หรือหมายเลขโทรศัพท์

notes

string

หมายเหตุเพิ่มเติม (เช่น วิธีการจากผู้ดูแลระบบโดเมนหรือประกาศทางกฎหมาย) เกี่ยวกับการประชุมที่จะแสดงต่อผู้ใช้ มี HTML ได้ ความยาวสูงสุดคือ 2,048 อักขระ

parameters

object (Parameters)

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

ConferenceSolution

การแสดง JSON
{
  "iconUri": string,
  "key": {
    object (Key)
  },
  "name": string
}
ช่อง
iconUri

string

URI สำหรับไอคอนที่ผู้ใช้มองเห็นได้ซึ่งแสดงถึงโซลูชันการประชุมนี้

key

object (Key)

คีย์ที่ระบุโซลูชันการประชุมสำหรับกิจกรรมนี้โดยเฉพาะ

name

string

ชื่อที่ผู้ใช้มองเห็นได้ของโซลูชันการประชุมนี้ (ไม่ได้แปล)

คีย์

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

string

ประเภทโซลูชันการประชุม ค่าที่เป็นไปได้มีดังนี้

  • eventHangout สำหรับ Hangouts สำหรับผู้บริโภค (http://hangouts.google.com)
  • eventNamedHangout สำหรับ Hangouts แบบคลาสสิกสำหรับผู้ใช้ Google Workspace (http://hangouts.google.com)
  • hangoutsMeet สำหรับ Google Meet (http://meet.google.com)
  • addOn สำหรับโซลูชันการประชุมของบุคคลที่สาม

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

string

รหัสการเข้าถึงที่ใช้เพื่อเข้าถึงการประชุม ความยาวสูงสุดคือ 128 อักขระ โดยทั่วไปแล้ว ผู้ให้บริการการประชุมจะใช้เฉพาะชุดย่อยของ {accessCode, meetingCode, passcode, password, pin} เพื่อให้สิทธิ์เข้าถึงการประชุม จับคู่และแสดงเฉพาะช่องที่ผู้ให้บริการการประชุมใช้

entryPointType

string

ประเภทของจุดแรกเข้า ค่าที่เป็นไปได้มีดังนี้

  • more: วิธีการเข้าร่วมการประชุมเพิ่มเติม เช่น หมายเลขโทรศัพท์สำรอง การประชุมจะมีจุดแรกเข้าเพิ่มเติมได้เพียงจุดเดียว หากมีจุดแรกเข้าประเภทนี้ จะต้องมีจุดแรกเข้าประเภทอื่นอย่างน้อย 1 จุดด้วย
  • phone: เข้าร่วมการประชุมผ่านหมายเลขโทรศัพท์ การประชุมอาจมีจุดแรกเข้าทางโทรศัพท์หรือไม่มีเลยก็ได้ Google ปฏิทินจะแสดงเฉพาะจุดแรกเข้าทางโทรศัพท์ 2 จุดแรก หลังจากจัดรูปแบบและจัดเรียงตามตัวอักษรแล้ว
  • sip: เข้าร่วมการประชุมผ่าน SIP การประชุมหนึ่งๆ จะมีจุดแรกเข้า sip ได้ไม่เกิน 1 จุด
  • video: เข้าร่วมการประชุมผ่าน HTTP การประชุมมีจุดแรกเข้าวิดีโอได้สูงสุด 1 จุด
label

string

ป้ายกำกับที่ผู้ใช้มองเห็นได้สำหรับ URI ของจุดแรกเข้า (ไม่ได้แปล)

meetingCode

string

รหัสการประชุมที่ใช้เข้าถึงการประชุม ความยาวสูงสุดคือ 128 อักขระ โดยทั่วไปแล้ว ผู้ให้บริการการประชุมจะใช้เฉพาะชุดย่อยของ {accessCode, meetingCode, passcode, password, pin} เพื่อให้สิทธิ์เข้าถึงการประชุม จับคู่และแสดงเฉพาะช่องที่ผู้ให้บริการการประชุมใช้

passcode

string

รหัสผ่านที่ใช้เข้าถึงการประชุม ความยาวสูงสุดคือ 128 อักขระ โดยทั่วไปแล้ว ผู้ให้บริการการประชุมจะใช้เฉพาะชุดย่อยของ {accessCode, meetingCode, passcode, password, pin} เพื่อให้สิทธิ์เข้าถึงการประชุม จับคู่และแสดงเฉพาะช่องที่ผู้ให้บริการการประชุมใช้

password

string

รหัสผ่านที่ใช้เข้าถึงการประชุม ความยาวสูงสุดคือ 128 อักขระ โดยทั่วไปแล้ว ผู้ให้บริการการประชุมจะใช้เฉพาะชุดย่อยของ {accessCode, meetingCode, passcode, password, pin} เพื่อให้สิทธิ์เข้าถึงการประชุม จับคู่และแสดงเฉพาะช่องที่ผู้ให้บริการการประชุมใช้

pin

string

PIN ที่ใช้เข้าถึงการประชุม ความยาวสูงสุดคือ 128 อักขระ โดยทั่วไปแล้ว ผู้ให้บริการการประชุมจะใช้เฉพาะชุดย่อยของ {accessCode, meetingCode, passcode, password, pin} เพื่อให้สิทธิ์เข้าถึงการประชุม จับคู่และแสดงเฉพาะช่องที่ผู้ให้บริการการประชุมใช้

uri

string

URI ของจุดแรกเข้า ความยาวสูงสุดคือ 1,300 อักขระ การจัดรูปแบบจะขึ้นอยู่กับประเภทจุดแรกเข้า ดังนี้

  • เพิ่มเติม: ต้องใช้สคีมา http: หรือ https:
  • phone: ต้องใช้สคีมา tel: URI ควรมีลำดับการโทรทั้งหมด (เช่น "tel:+12345678900,,,12345678;1234")
  • sip: ต้องใช้สคีมา sip: หรือ sips: เช่น "sip:12345678@myprovider.com"
  • video: ต้องใช้สคีมา http: หรือ https:
regionCode

string

รหัสภูมิภาคของหมายเลขโทรศัพท์ ผู้ใช้จำเป็นต้องใช้หาก URI ไม่มีรหัสประเทศ ค่าจะอิงตามรายการรหัสภูมิภาค CLDR สาธารณะ

entryPointFeatures[]

string

ฟีเจอร์ของจุดแรกเข้า ปัจจุบันฟีเจอร์เหล่านี้ใช้ได้กับจุดแรกเข้าทางโทรศัพท์เท่านั้น

  • toll: จุดแรกเข้าคือการโทรแบบมีค่าบริการ
  • toll_free: จุดแรกเข้าคือการโทรฟรี

พารามิเตอร์

การแสดง JSON
{
  "addOnParameters": {
    object (AddOnParameters)
  }
}
ช่อง
addOnParameters

object (AddOnParameters)

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

AddOnParameters

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

map (key: string, value: string)

ออบเจ็กต์ที่มีรายการคู่ "key": value รายการ เช่น { "name": "wrench", "mass": "1.3kg", "count": "3" }

ความสามารถ

การแสดง JSON
{
  "canSeeAttendees": boolean,
  "canAddAttendees": boolean,
  "canSeeConferenceData": boolean,
  "canSetConferenceData": boolean,
  "canAddAttachments": boolean
}
ช่อง
canSeeAttendees

boolean

ข้อมูลที่ผู้ใช้สร้างขึ้น true หากส่วนเสริมอ่านรายชื่อผู้เข้าร่วมกิจกรรมได้ และ false หากอ่านไม่ได้

canAddAttendees

boolean

ข้อมูลที่ผู้ใช้สร้างขึ้น true หากส่วนเสริมสามารถเพิ่มผู้เข้าร่วมใหม่ลงในรายชื่อผู้เข้าร่วมกิจกรรมได้ false หากไม่สามารถทำได้

canSeeConferenceData

boolean

ข้อมูลที่ผู้ใช้สร้างขึ้น true หากส่วนเสริมอ่านข้อมูลการประชุมของกิจกรรมได้ หรือ false หากอ่านไม่ได้

canSetConferenceData

boolean

ข้อมูลที่ผู้ใช้สร้างขึ้น true หากส่วนเสริมสามารถอัปเดตข้อมูลการประชุมของกิจกรรมได้ หรือ false หากไม่สามารถอัปเดตได้

canAddAttachments

boolean

ข้อมูลที่ผู้ใช้สร้างขึ้น true หากส่วนเสริมสามารถเพิ่มไฟล์แนบใหม่ในกิจกรรมได้ หรือ false หากไม่สามารถเพิ่มได้

DriveEventObject

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

การแสดง JSON
{
  "selectedItems": [
    {
      object (DriveItemMetadata)
    }
  ],
  "activeCursorItem": {
    object (DriveItemMetadata)
  }
}
ช่อง
selectedItems[]

object (DriveItemMetadata)

รายการ (ไฟล์หรือโฟลเดอร์) ที่เลือกในไดรฟ์

activeCursorItem

object (DriveItemMetadata)

รายการในไดรฟ์ที่ใช้งานอยู่ในปัจจุบัน

DriveItemMetadata

ออบเจ็กต์รายการในไดรฟ์จะมีข้อมูลเกี่ยวกับรายการในไดรฟ์ที่เฉพาะเจาะจง เช่น ไฟล์หรือโฟลเดอร์

การแสดง JSON
{
  "id": string,
  "iconUrl": string,
  "mimeType": string,
  "title": string,
  "addonHasFileScopePermission": boolean
}
ช่อง
id

string

รหัสของรายการที่เลือก

iconUrl

string

URL ของไอคอนที่แสดงถึงรายการที่เลือก

mimeType

string

ประเภท MIME ของรายการที่เลือก

title

string

ชื่อของรายการที่เลือก

addonHasFileScopePermission

boolean

หากเป็น 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

string

รหัสของข้อความ Gmail ที่เปิดอยู่

threadId

string

รหัสชุดข้อความ Gmail ที่เปิดอยู่

accessToken

string

โทเค็นเพื่อการเข้าถึงเฉพาะ Gmail คุณสามารถใช้โทเค็นนี้กับเมธอด GmailApp.setCurrentMessageAccessToken(accessToken) เพื่อให้สิทธิ์เข้าถึงชั่วคราวแก่ส่วนเสริมของคุณสำหรับข้อความ Gmail ของผู้ใช้ที่เปิดอยู่ หรือให้ส่วนเสริมเขียนฉบับร่างใหม่ได้

toRecipients[]

string

ปิดใช้โดยค่าเริ่มต้น รายการอีเมลผู้รับ "ถึง:" ที่รวมอยู่ในฉบับร่างที่ส่วนเสริมกำลังเขียนอยู่ หากต้องการเปิดช่องนี้ คุณต้องตั้งค่าช่อง addOns.gmail.composeTrigger.draftAccess ในไฟล์ Manifest เป็น METADATA

ccRecipients[]

string

ปิดใช้โดยค่าเริ่มต้น รายการอีเมลของผู้รับ "สำเนา:" ที่รวมอยู่ในฉบับร่างที่ส่วนเสริมกำลังเขียนอยู่ หากต้องการเปิดช่องนี้ คุณต้องตั้งค่าช่อง addOns.gmail.composeTrigger.draftAccess ในไฟล์ Manifest เป็น METADATA

bccRecipients[]

string

ปิดใช้โดยค่าเริ่มต้น รายการอีเมลของผู้รับ "สำเนาลับ:" ที่รวมอยู่ในฉบับร่างที่ส่วนเสริมกำลังเขียนอยู่ หากต้องการเปิดช่องนี้ คุณต้องตั้งค่าช่อง addOns.gmail.composeTrigger.draftAccess ในไฟล์ Manifest เป็น METADATA

SheetsEventObject

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

การแสดง JSON
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
ช่อง
id

string

จะแสดงก็ต่อเมื่อผู้ใช้ให้สิทธิ์ขอบเขต https://www.googleapis.com/auth/drive.file เท่านั้น รหัสของสเปรดชีตที่เปิดใน UI ของชีต

title

string

จะแสดงก็ต่อเมื่อผู้ใช้ให้สิทธิ์ขอบเขต https://www.googleapis.com/auth/drive.file เท่านั้น ชื่อของสเปรดชีตที่เปิดใน UI ของชีต

addonHasFileScopePermission

boolean

หากเป็น true แสดงว่าส่วนเสริมได้ขอและได้รับสิทธิ์ขอบเขต https://www.googleapis.com/auth/drive.file สำหรับสเปรดชีตที่เปิดอยู่ใน UI ของชีต ไม่เช่นนั้นช่องนี้จะเป็น false

matchedUrl

object (MatchedUrl)

จะแสดงก็ต่อเมื่อเป็นไปตามเงื่อนไขต่อไปนี้

  • https://www.googleapis.com/auth/workspace.linkpreview ได้รับอนุญาตจากผู้ใช้แล้ว
  • URL ตรงกับรูปแบบโฮสต์ที่ระบุในทริกเกอร์ LinkPreviewTriggers

URL ของลิงก์ที่สร้างตัวอย่างใน Google ชีต หากต้องการใช้ช่องนี้ คุณต้องกำหนดค่า LinkPreviewTriggers ในไฟล์ Manifest ของส่วนเสริม ดูรายละเอียดเพิ่มเติมได้ที่หัวข้อแสดงตัวอย่างลิงก์ด้วยชิปอัจฉริยะ

ตัวอย่างเพย์โหลดเมื่อผู้ใช้ดูตัวอย่างลิงก์ https://www.example.com/12345:

"sheets" : {
  "matchedUrl" : {
    "url" : "https://www.example.com/12345"
  }
}

MatchedUrl

ออบเจ็กต์เหตุการณ์ที่แสดงผลพร้อมคำขอแสดงตัวอย่างลิงก์

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

string

URL ที่ตรงกัน

SlidesEventObject

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

การแสดง JSON
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
ช่อง
id

string

จะแสดงก็ต่อเมื่อผู้ใช้ให้สิทธิ์ขอบเขต https://www.googleapis.com/auth/drive.file เท่านั้น รหัสของงานนำเสนอที่เปิดอยู่ใน UI ของสไลด์

title

string

จะแสดงก็ต่อเมื่อผู้ใช้ให้สิทธิ์ขอบเขต https://www.googleapis.com/auth/drive.file เท่านั้น ชื่อของงานนำเสนอที่เปิดอยู่ใน UI ของสไลด์

addonHasFileScopePermission

boolean

หากเป็น true แสดงว่าส่วนเสริมได้ขอและได้รับสิทธิ์เข้าถึงขอบเขต https://www.googleapis.com/auth/drive.file สำหรับงานนำเสนอที่เปิดอยู่ใน UI ของสไลด์ ไม่เช่นนั้นช่องนี้จะเป็น false

matchedUrl

object (MatchedUrl)

จะแสดงก็ต่อเมื่อเป็นไปตามเงื่อนไขต่อไปนี้

  • https://www.googleapis.com/auth/workspace.linkpreview ได้รับอนุญาตจากผู้ใช้แล้ว
  • URL ตรงกับรูปแบบโฮสต์ที่ระบุในทริกเกอร์ LinkPreviewTriggers

URL ของลิงก์ที่สร้างตัวอย่างใน Google สไลด์ หากต้องการใช้ช่องนี้ คุณต้องกำหนดค่า LinkPreviewTriggers ในไฟล์ Manifest ของส่วนเสริม ดูรายละเอียดเพิ่มเติมได้ที่หัวข้อแสดงตัวอย่างลิงก์ด้วยชิปอัจฉริยะ

ตัวอย่างเพย์โหลดเมื่อผู้ใช้ดูตัวอย่างลิงก์ https://www.example.com/12345:

"slides" : {
  "matchedUrl" : {
    "url" : "https://www.example.com/12345"
  }
}

DocsEventObject

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

การแสดง JSON
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
ช่อง
id

string

จะแสดงก็ต่อเมื่อผู้ใช้ให้สิทธิ์ขอบเขต https://www.googleapis.com/auth/drive.file เท่านั้น รหัสของเอกสารที่เปิดใน UI ของเอกสาร

title

string

จะแสดงก็ต่อเมื่อผู้ใช้ให้สิทธิ์ขอบเขต https://www.googleapis.com/auth/drive.file เท่านั้น ชื่อของเอกสารที่เปิดใน UI ของเอกสาร

addonHasFileScopePermission

boolean

หากเป็น true แสดงว่าส่วนเสริมได้ขอและได้รับสิทธิ์เข้าถึงขอบเขต https://www.googleapis.com/auth/drive.file สำหรับเอกสารที่เปิดใน UI ของเอกสารแล้ว มิฉะนั้น ช่องนี้จะเป็น false

matchedUrl

object (MatchedUrl)

จะแสดงก็ต่อเมื่อเป็นไปตามเงื่อนไขต่อไปนี้

  • https://www.googleapis.com/auth/workspace.linkpreview ได้รับอนุญาตจากผู้ใช้แล้ว
  • URL ตรงกับรูปแบบโฮสต์ที่ระบุในทริกเกอร์ LinkPreviewTriggers

URL ของลิงก์ที่สร้างตัวอย่างใน Google เอกสาร หากต้องการใช้ช่องนี้ คุณต้องกำหนดค่า LinkPreviewTriggers ในไฟล์ Manifest ของส่วนเสริม ดูรายละเอียดเพิ่มเติมได้ที่หัวข้อแสดงตัวอย่างลิงก์ด้วยชิปอัจฉริยะ

ตัวอย่างเพย์โหลดเมื่อผู้ใช้ดูตัวอย่างลิงก์ https://www.example.com/12345:

"docs" : {
  "matchedUrl" : {
    "url" : "https://www.example.com/12345"
  }
}

ChatEventObject

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

การแสดง JSON
{
  "type": enum (EventType),
  "user": {
    object (User)
  },
  "space": {
    object (Space)
  },
  "eventTime": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "messagePayload": {
    object (MessagePayload)
  },
  "addedToSpacePayload": {
    object (AddedToSpacePayload)
  },
  "removedFromSpacePayload": {
    object (RemovedFromSpacePayload)
  },
  "buttonClickedPayload": {
    object (ButtonClickedPayload)
  },
  "widgetUpdatedPayload": {
    object (WidgetUpdatedPayload)
  },
  "appCommandPayload": {
    object (AppCommandPayload)
  },
  "systemCommandPayload": {
    object (SystemCommandPayload)
  }
  // End of mutually exclusive fields.
}
ช่อง
type

enum (EventType)

ประเภทของเหตุการณ์ ซึ่งจะป้อนข้อมูลสำหรับเหตุการณ์ในหน้าแรกของแอปในแอป Chat ที่ไม่ใช่ส่วนเสริมเท่านั้น

user

object (User)

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

space

object (Space)

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

eventTime

string (Timestamp format)

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

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"

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

object (MessagePayload)

ผู้ใช้ส่งข้อความถึงแอปใน Chat หรือ @พูดถึงแอปใน Chat ในพื้นที่ทำงาน การเรียกใช้คำสั่งแอป (เช่น คำสั่งเครื่องหมายทับและคำสั่งด่วน) จะแสดงใน appCommandPayload แทน

addedToSpacePayload

object (AddedToSpacePayload)

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

removedFromSpacePayload

object (RemovedFromSpacePayload)

ผู้ใช้นำแอปใน Chat ออกจากพื้นที่ทำงาน

buttonClickedPayload

object (ButtonClickedPayload)

แสดงข้อมูลเพย์โหลดเมื่อผู้ใช้โต้ตอบกับองค์ประกอบแบบอินเทอร์แอกทีฟของการ์ดหรือกล่องโต้ตอบที่ทริกเกอร์ Callback Action แม้ว่าจะมีชื่อเช่นนี้ แต่เพย์โหลดนี้จะสร้างขึ้นสำหรับ Callback ของการ์ดและกล่องโต้ตอบ Action ทั้งหมด ไม่ใช่แค่การคลิกปุ่มเท่านั้น แต่ยังรวมถึงทริกเกอร์ onChangeAction, การดำเนินการ onClick, การคลิก CardAction และการส่งหรือการยกเลิกกล่องโต้ตอบ (SUBMIT_DIALOG และ CANCEL_DIALOG) ด้วย

หากผู้ใช้โต้ตอบกับกล่องโต้ตอบ ระบบจะตั้งค่าช่อง isDialogEvent ของ ButtonClickedPayload เป็น true และรวม DialogEventType ไว้ด้วย

เพย์โหลดที่สมบูรณ์ยังมี commonEventObject.formInputs และ commonEventObject.parameters ด้วย

widgetUpdatedPayload

object (WidgetUpdatedPayload)

ผู้ใช้อัปเดตวิดเจ็ตในการ์ดในสตรีมหรือในกล่องโต้ตอบ

เพย์โหลดที่สมบูรณ์ยังมี CommonEventObject.parameters['autocomplete_widget_query'] ด้วย

appCommandPayload

object (AppCommandPayload)

ผู้ใช้เรียกใช้คำสั่งแอป

systemCommandPayload

object (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)
  },
  "message": {
    object (Message)
  },
  "configCompleteRedirectUri": string
}
ช่อง
space

object (Space)

ต้องระบุ พื้นที่ใน Chat ที่ออบเจ็กต์เหตุการณ์เกิดขึ้น

message

object (Message)

ข้อความที่ทริกเกอร์ออบเจ็กต์เหตุการณ์

configCompleteRedirectUri

string

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

AddedToSpacePayload

ผู้ใช้เพิ่มแอปใน Chat ไปยังพื้นที่ทำงาน หรือมีการสร้าง DM ระหว่างแอปกับผู้ใช้

การแสดง JSON
{
  "space": {
    object (Space)
  },
  "interactionAdd": boolean,
  "configCompleteRedirectUri": string
}
ช่อง
space

object (Space)

ต้องระบุ พื้นที่ใน Chat ที่ออบเจ็กต์เหตุการณ์เกิดขึ้น

interactionAdd

boolean

มีการเพิ่มแอปไปยังพื้นที่ทำงานด้วยการโต้ตอบของผู้ใช้หรือไม่ (เช่น โดยการ @ พูดถึงแอป Chat หรือเรียกใช้ด้วยคำสั่งเครื่องหมายทับ) หากตั้งค่าเป็น "จริง" ระบบจะส่งออบเจ็กต์เหตุการณ์แยกต่างหากที่เชื่อมโยงกับการโต้ตอบไปยังแอปใน Chat

configCompleteRedirectUri

string

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

RemovedFromSpacePayload

ผู้ใช้นำแอปใน Chat ออกจากพื้นที่ทำงาน

การแสดง JSON
{
  "space": {
    object (Space)
  }
}
ช่อง
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)
  },
  "message": {
    object (Message)
  },
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType)
}
ช่อง
space

object (Space)

ต้องระบุ พื้นที่ใน Chat ที่ออบเจ็กต์เหตุการณ์เกิดขึ้น

message

object (Message)

ข้อความที่ทริกเกอร์ออบเจ็กต์เหตุการณ์

isDialogEvent

boolean

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

dialogEventType

enum (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)
  }
}
ช่อง
space

object (Space)

ต้องระบุ พื้นที่ใน Chat ที่ออบเจ็กต์เหตุการณ์เกิดขึ้น

AppCommandPayload

ผู้ใช้เรียกใช้คำสั่งแอป

การแสดง JSON
{
  "appCommandMetadata": {
    object (AppCommandMetadata)
  },
  "space": {
    object (Space)
  },
  "thread": {
    object (Thread)
  },
  "message": {
    object (Message)
  },
  "configCompleteRedirectUri": string,
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType)
}
ช่อง
appCommandMetadata

object (AppCommandMetadata)

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

space

object (Space)

ไม่บังคับ พื้นที่ใน Chat ที่ออบเจ็กต์เหตุการณ์เกิดขึ้น

thread

object (Thread)

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

message

object (Message)

ไม่บังคับ ข้อความที่ทริกเกอร์ออบเจ็กต์เหตุการณ์ (หากมี) ระบบจะป้อนข้อมูลในช่องนี้สำหรับคำสั่งเครื่องหมายทับเท่านั้น

configCompleteRedirectUri

string

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

isDialogEvent

boolean

ไม่บังคับ ผู้ใช้กำลังโต้ตอบหรือกำลังจะโต้ตอบกับกล่องโต้ตอบหรือไม่

dialogEventType

enum (DialogEventType)

ไม่บังคับ ประเภทของออบเจ็กต์เหตุการณ์กล่องโต้ตอบที่ได้รับ ช่องนี้จะมีผลก็ต่อเมื่อ isDialogEvent เป็น true เท่านั้น

AppCommandMetadata

ข้อมูลเมตาเกี่ยวกับคำสั่งแอปใน Chat

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

integer

รหัสสำหรับคำสั่งที่ระบุไว้ในการกำหนดค่า Chat API

appCommandType

enum (AppCommandType)

ประเภทคำสั่งของแอปใน Chat

AppCommandType

ประเภทคำสั่งของแอปใน Chat โปรดดูรายละเอียดที่หัวข้อประเภทคำสั่งของแอปใน Chat

Enum
APP_COMMAND_TYPE_UNSPECIFIED ค่าเริ่มต้น ไม่ระบุ
SLASH_COMMAND คำสั่งเครื่องหมายทับ ผู้ใช้ส่งคำสั่งในข้อความแชท
QUICK_COMMAND คำสั่งด่วน ผู้ใช้เลือกคำสั่งจากเมนู Chat ในส่วนตอบกลับข้อความ
MESSAGE_ACTION การดำเนินการกับข้อความ ผู้ใช้เลือกคำสั่งจากเมนูตามบริบทของข้อความใน Chat

SystemCommandPayload

ผู้ใช้เรียกใช้คำสั่งของระบบ

การแสดง JSON
{
  "systemCommandMetadata": {
    object (SystemCommandMetadata)
  },
  "space": string,
  "thread": {
    object (Thread)
  }
}
ช่อง
systemCommandMetadata

object (SystemCommandMetadata)

ข้อมูลเมตาเกี่ยวกับคำสั่งของระบบที่มีการเรียกใช้

space

string

ไม่บังคับ พื้นที่ใน Chat ที่ออบเจ็กต์เหตุการณ์เกิดขึ้น

thread

object (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 (CancelStream)
  }
  // End of mutually exclusive fields.
}
ช่อง
เรียกใช้คำสั่งของระบบแล้ว รายการต่อไปนี้คือช่องที่ใช้ร่วมกันไม่ได้ ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
cancelStream

object (CancelStream)

คำสั่งสำหรับยกเลิกข้อความสตรีมที่ใช้งานอยู่

สิ้นสุดฟิลด์ที่แยกกันโดยสิ้นเชิง

CancelStream

คำสั่งสำหรับยกเลิกข้อความสตรีมที่ใช้งานอยู่

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

string

ต้องระบุ ชื่อทรัพยากรของข้อความสตรีมที่มีการใช้คำสั่งยกเลิก

รูปแบบ: spaces/{space}/streamMessages/{streamMessage}

WorkflowEventObject

LINT.IfChange ออบเจ็กต์เหตุการณ์ที่ส่งไปยังส่วนเสริมเวิร์กโฟลว์

การแสดง JSON
{
  "executionMetadata": {
    object (ExecutionMetadata)
  },
  "triggerEventSource": enum (TriggerEventSource),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "actionInvocation": {
    object (ActionInvocation)
  },
  "triggerCreation": {
    object (TriggerCreation)
  },
  "triggerDeletion": {
    object (TriggerDeletion)
  },
  "resourceRetrieval": {
    object (ResourceRetrieval)
  },
  "elementConfiguration": {
    object (ElementConfiguration)
  },
  "resourceFieldsDefinitionRetrieval": {
    object (ResourceFieldsDefinitionRetrieval)
  },
  "elementUiAutocomplete": {
    object (ElementUiAutocomplete)
  }
  // End of mutually exclusive fields.
}
ช่อง
executionMetadata

object (ExecutionMetadata)

ข้อมูลเมตาเกี่ยวกับการดำเนินการเวิร์กโฟลว์

triggerEventSource

enum (TriggerEventSource)

แหล่งที่มาของเหตุการณ์ที่ทริกเกอร์

ประเภทเพย์โหลดเหตุการณ์เวิร์กโฟลว์ รายการต่อไปนี้คือช่องที่ใช้ร่วมกันไม่ได้ ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
actionInvocation

object (ActionInvocation)

การเรียกใช้การดำเนินการเวิร์กโฟลว์

triggerCreation

object (TriggerCreation)

การสร้างทริกเกอร์เวิร์กโฟลว์

triggerDeletion

object (TriggerDeletion)

การลบทริกเกอร์เวิร์กโฟลว์

resourceRetrieval

object (ResourceRetrieval)

การดึงข้อมูลทรัพยากร (ใช้สำหรับการขยายตัวแปร)

elementConfiguration

object (ElementConfiguration)

การกำหนดค่าองค์ประกอบเวิร์กโฟลว์

resourceFieldsDefinitionRetrieval

object (ResourceFieldsDefinitionRetrieval)

การดึงข้อมูลการกำหนดฟิลด์ที่ทรัพยากรรองรับ

elementUiAutocomplete

object (ElementUiAutocomplete)

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

สิ้นสุดฟิลด์ที่แยกกันโดยสิ้นเชิง

ActionInvocation

การเรียกใช้การดำเนินการเวิร์กโฟลว์

การแสดง JSON
{
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "triggerId": string,
  "flowLevelContext": {
    object (FlowLevelContext)
  }
}
ช่อง
inputs

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

แผนที่ของตัวแปรอินพุตที่คีย์ตามชื่อตัวแปรอินพุต

ออบเจ็กต์ที่มีรายการคู่ "key": value รายการ เช่น { "name": "wrench", "mass": "1.3kg", "count": "3" }

triggerId

string

รหัสทริกเกอร์ที่จะใช้สำหรับการตอบกลับการดำเนินการแบบไม่พร้อมกัน

flowLevelContext

object (FlowLevelContext)

ไม่บังคับ บริบทระดับโฟลว์จากขั้นตอนก่อนหน้า

VariableData

แสดงข้อมูลตัวแปร ซึ่งเก็บค่าได้หลายค่าซึ่งมีประเภทต่างกัน

การแสดง JSON
{
  "booleanValues": [
    boolean
  ],
  "integerValues": [
    string
  ],
  "floatValues": [
    number
  ],
  "stringValues": [
    string
  ],
  "timestampValues": [
    string
  ],
  "resourceReferences": [
    {
      object (ResourceReference)
    }
  ],
  "emailAddressValues": [
    string
  ],
  "googleUserValues": [
    string
  ],
  "textFormatValues": [
    {
      object (WorkflowTextFormat)
    }
  ]
}
ช่อง
booleanValues[]

boolean

ค่าบูลีน

integerValues[]

string (int64 format)

ค่าจำนวนเต็ม

floatValues[]

number

ค่าจำนวนลอยตัว

stringValues[]

string

ค่าสตริง

timestampValues[]

string (Timestamp format)

ค่าการประทับเวลา

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"

resourceReferences[]

object (ResourceReference)

การอ้างอิงทรัพยากร (รหัส)

emailAddressValues[]

string

ค่าอีเมล

googleUserValues[]

string

ค่าผู้ใช้ Google ในรูปแบบ users/{user}

textFormatValues[]

object (WorkflowTextFormat)

ค่ารูปแบบข้อความของเวิร์กโฟลว์

ResourceReference

ค่ารหัสของทรัพยากรเฉพาะแอปพลิเคชัน

การแสดง JSON
{
  "resourceType": {
    object (ResourceType)
  },
  "resourceId": string
}
ช่อง
resourceType

object (ResourceType)

ประเภทของทรัพยากรที่รหัสนี้ชี้ไป

resourceId

string

รหัสของทรัพยากร

ResourceType

ชื่อประเภททรัพยากรที่กำหนดเอง

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

string

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

workflowResourceDefinitionId

string

ตัวระบุที่ไม่ซ้ำกันของทรัพยากร โดยรหัสนี้ต้องไม่ซ้ำกันภายในแพ็กเกจเดียวกันเท่านั้น

WorkflowTextFormat

บล็อกข้อความที่มีตัวเลือกการจัดรูปแบบที่หลากหลาย ซึ่งรวมถึงรูปแบบ ไฮเปอร์ลิงก์ และองค์ประกอบแบบอินเทอร์แอกทีฟ

การแสดง JSON
{
  "textFormatElements": [
    {
      object (TextFormatElement)
    }
  ]
}
ช่อง
textFormatElements[]

object (TextFormatElement)

คอลเล็กชันองค์ประกอบรูปแบบข้อความ

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 (Chip)
  },
  "styledText": {
    object (StyledText)
  },
  "hyperlink": {
    object (Hyperlink)
  },
  "listContainer": {
    object (ListContainer)
  }
  // End of mutually exclusive fields.
}
ช่อง
องค์ประกอบที่แสดงถึงองค์ประกอบรูปแบบข้อความที่เป็นไปได้รายการใดรายการหนึ่ง รายการต่อไปนี้คือช่องที่ใช้ร่วมกันไม่ได้ ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
text

string

ข้อความในรูปแบบข้อความ

chip

object (Chip)

ชิปที่คลิกได้ในรูปแบบข้อความ

styledText

object (StyledText)

ข้อความที่มีการจัดสไตล์ในรูปแบบข้อความ

listContainer

object (ListContainer)

คอนเทนเนอร์รายการในรูปแบบข้อความ

สิ้นสุดฟิลด์ที่แยกกันโดยสิ้นเชิง

ชิป

ชิปที่คลิกได้ในรูปแบบข้อความ

การแสดง JSON
{
  "icon": {
    object (Icon)
  },
  "label": string,
  "url": string
}
ช่อง
icon

object (Icon)

ไอคอนที่แสดงในชิป

label

string

ข้อความที่แสดงในชิป

url

string

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

string

แสดงไอคอนที่กำหนดเองซึ่งโฮสต์ที่ HTTPS URL

เช่น

"iconUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"

ประเภทไฟล์ที่รองรับ ได้แก่ .png และ .jpg

materialIconName

string

ชื่อไอคอนที่กำหนดไว้ในไอคอนจากดีไซน์ Material ของ Google เช่น check_box ระบบจะละทิ้งชื่อที่ไม่ถูกต้องและแทนที่ด้วยสตริงว่าง ซึ่งส่งผลให้ไอคอนแสดงผลไม่สำเร็จ

สิ้นสุดฟิลด์ที่แยกกันโดยสิ้นเชิง

StyledText

องค์ประกอบของข้อความที่มีรูปแบบต่างๆ เช่น ตัวหนา ตัวเอียง และสี

การแสดง JSON
{
  "text": string,
  "styles": [
    enum (Style)
  ],
  "fontWeight": enum (FontWeight),
  "color": {
    object (Color)
  },
  "wrapStyle": enum (WrapStyle)
}
ช่อง
text

string

เนื้อหาหลักของข้อความ

styles[]

enum (Style)

คอลเล็กชันของรูปแบบที่ใช้กับข้อความ

fontWeight

enum (FontWeight)

น้ำหนักแบบอักษรของข้อความ

color

object (Color)

สีของข้อความ

wrapStyle

enum (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 ไม่มีรูปแบบการตัดข้อความ

ListContainer

คอนเทนเนอร์สำหรับรายการในลิสต์ โดยแต่ละรายการในลิสต์สามารถมี TextFormatElement ได้หลายรายการ

การแสดง JSON
{
  "listNestLevel": string,
  "listType": enum (ListType),
  "listItems": [
    {
      object (ListItem)
    }
  ]
}
ช่อง
listNestLevel

string (int64 format)

ระดับการซ้อนของรายการ เริ่มต้นจาก 0 สำหรับระดับบนสุด และเพิ่มขึ้นทีละ 1 สำหรับรายการที่ฝังแต่ละรายการ

listType

enum (ListType)

ประเภทของรายการ

listItems[]

object (ListItem)

คอลเล็กชันของรายการในลิสต์

ListType

Enum สำหรับรายการประเภทต่างๆ

Enum
LIST_TYPE_UNSPECIFIED ไม่ได้ระบุประเภทรายการ DO NOT USE.
ORDERED รายการตามลำดับ
UNORDERED รายการที่ไม่เรียงลำดับ
BLOCKQUOTE แสดงรายการ Blockquote

ListItem

รายการ

การแสดง JSON
{
  "textFormatElements": [
    {
      object (TextFormatElement)
    }
  ]
}
ช่อง
textFormatElements[]

object (TextFormatElement)

คอลเล็กชันองค์ประกอบรูปแบบข้อความ

FlowLevelContext

บริบทระดับโฟลว์ที่มีเอาต์พุตจากขั้นตอนก่อนหน้า

การแสดง JSON
{
  "stepContexts": [
    {
      object (StepContext)
    }
  ]
}
ฟิลด์
stepContexts[]

object (StepContext)

ไม่บังคับ รายการขั้นตอนก่อนหน้า ลำดับมีความสำคัญ ดังนั้นโปรดตรวจสอบว่าลำดับการดำเนินการยังคงอยู่ในรายการนี้

StepContext

ข้อมูลเมตาและเอาต์พุตของบริบทขั้นตอนสำหรับบริบทระดับโฟลว์

การแสดง JSON
{
  "stepId": string,
  "outputs": {
    string: {
      object (VariableData)
    },
    ...
  }
}
ฟิลด์
stepId

string

ไม่บังคับ รหัสที่ไม่ซ้ำกันของขั้นตอนในกราฟเวิร์กโฟลว์

outputs

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

ไม่บังคับ แผนที่ของตัวแปรผลลัพธ์ที่สร้างขึ้นโดยขั้นตอนนี้ โดยมีคีย์เป็นชื่อตัวแปร

ออบเจ็กต์ที่มีรายการคู่ "key": value รายการ เช่น { "name": "wrench", "mass": "1.3kg", "count": "3" }

TriggerCreation

การสร้างทริกเกอร์เวิร์กโฟลว์

การแสดง JSON
{
  "triggerId": string,
  "triggerType": enum (TriggerType),
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "notifyUri": string
}
ช่อง
triggerId

string

ตัวระบุที่ไม่ซ้ำกันของทริกเกอร์ที่ระบุระหว่างการสร้าง

triggerType

enum (TriggerType)

ประเภทของทริกเกอร์

inputs

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

แผนที่ของตัวแปรอินพุตที่คีย์ตามชื่อตัวแปรอินพุต

ออบเจ็กต์ที่มีรายการคู่ "key": value รายการ เช่น { "name": "wrench", "mass": "1.3kg", "count": "3" }

notifyUri

string

ปลายทางที่จะเรียกใช้เมื่อทริกเกอร์เริ่มทำงาน

TriggerType

ประเภทของทริกเกอร์

Enum
TRIGGER_TYPE_UNDEFINED ค่าเริ่มต้น DO NOT USE.
REPEATING ทริกเกอร์จะเริ่มทำงานทุกครั้งที่เป็นไปตามเงื่อนไขอินพุต

TriggerDeletion

การลบทริกเกอร์เวิร์กโฟลว์

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

string

ตัวระบุที่ไม่ซ้ำกันของทริกเกอร์ที่ระบุระหว่างการสร้าง

ResourceRetrieval

การดึงข้อมูลทรัพยากร

การแสดง JSON
{
  "resourceReference": {
    object (ResourceReference)
  }
}
ช่อง
resourceReference

object (ResourceReference)

ประเภทและรหัสของทรัพยากรที่จะดึงข้อมูล

ElementConfiguration

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

การแสดง JSON
{
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "displayDestination": enum (DisplayDestination),
  "nodeId": string,
  "workflowId": string,
  "availableVariables": [
    {
      object (VariableReference)
    }
  ]
}
ช่อง
inputs

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

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

ออบเจ็กต์ที่มีรายการคู่ "key": value รายการ เช่น { "name": "wrench", "mass": "1.3kg", "count": "3" }

displayDestination

enum (DisplayDestination)

ปลายทางของการ์ดการกำหนดค่าองค์ประกอบ องค์ประกอบสามารถใช้ช่องนี้เพื่อแสดงเลย์เอาต์การ์ดการกำหนดค่าที่แตกต่างกันตามปลายทาง

nodeId

string

รหัสโหนดของการกำหนดค่าพื้นฐานที่แสดงผล

workflowId

string

รหัสเวิร์กโฟลว์ของการกำหนดค่าเบื้องต้นที่แสดงผล

availableVariables[]

object (VariableReference)

ตัวแปรที่ใช้ได้จะเรียงตามตำแหน่งโหนด

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 (DataType)
  },
  "iconUrl": string,
  "stepNumber": integer,
  "descriptionText": string,
  "displayText": string
}
ช่อง
parentElementId

string

รหัสพื้นฐานขององค์ประกอบที่สร้างตัวแปร เราสามารถขยายรหัสนี้เป็น WorkflowElement หรือโปรโตข้อมูลเมตาที่ละเอียดขึ้นได้หากจำเป็น

nodeId

string

รหัสอ้างอิงโหนด

path

string

ลายเซ็นเส้นทางของตัวเลือกตัวแปร

dataType

object (DataType)

ประเภทข้อมูลตัวแปร

iconUrl

string

URL ไอคอนขององค์ประกอบพื้นฐานที่สร้างตัวแปรนี้

stepNumber

integer

หมายเลขขั้นตอนขององค์ประกอบพื้นฐานที่สร้างตัวแปรนี้

descriptionText

string

คำอธิบายของตัวแปร

displayText

string

ข้อความที่แสดงของชิปตัวแปร

DataType

ประเภทของตัวแปร

การแสดง JSON
{
  "valueMetadata": {
    object (ValueMetadata)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "basicType": enum (BasicType),
  "resourceType": {
    object (ResourceType)
  }
  // End of mutually exclusive fields.
}
ช่อง
valueMetadata

object (ValueMetadata)

ข้อมูลเมตาเกี่ยวกับค่าที่เป็นไปได้ของตัวแปร

ประเภทของข้อมูล รายการต่อไปนี้คือช่องที่ใช้ร่วมกันไม่ได้ ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
basicType

enum (BasicType)

ประเภทข้อมูลพื้นฐาน

resourceType

object (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 (BasicType)
  ],
  "semanticDescriptors": [
    {
      object (SemanticDescriptor)
    }
  ],
  "dynamicSchema": {
    object (DynamicSchema)
  },
  "defaultValue": string
}
ฟิลด์
enumValues[]

string

ไม่บังคับ ระบุค่าที่อนุญาตสำหรับสตริง คุณจะตั้งค่านี้ได้ก็ต่อเมื่อ DataType เป็น STRING เท่านั้น

dynamicTypes[]

enum (BasicType)

ไม่บังคับ ระบุประเภทที่อนุญาตซึ่งสามารถแคสต์แบบไดนามิกสำหรับตัวแปรได้ ซึ่งจะตั้งค่าได้ก็ต่อเมื่อ DataType เป็นสตริงและตัวแปรเป็นเอาต์พุต

semanticDescriptors[]

object (SemanticDescriptor)

ไม่บังคับ ช่วยอธิบายความหมายเชิงความหมายของตัวแปร

dynamicSchema

object (DynamicSchema)

ไม่บังคับ การกำหนดค่าสำหรับการแก้ไขสคีมาของตัวแปรนี้แบบไดนามิก

defaultValue

string

ไม่บังคับ สตริงที่ระบุค่าเริ่มต้นสำหรับตัวแปรนี้ เช่น สำหรับบูลีน ระบบอาจตั้งค่า defaultValue เป็น true หรือ false

SemanticDescriptor

ข้อมูลเมตาเกี่ยวกับความหมายเชิงความหมายของตัวแปร

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

string

ระบุว่าตัวแปรสอดคล้องกับแอตทริบิวต์ที่เฉพาะเจาะจงของทรัพยากร ซึ่งจะเป็นประโยชน์อย่างยิ่งสำหรับตัวแปรที่แสดงตัวระบุของทรัพยากร (รหัส, URL, คีย์ ฯลฯ)

รูปแบบที่แนะนำคือ - "{brand}/{appName}/{resource}:{attribute}" {brand} เป็นตัวเลือกและควรละเว้นหากเหมือนกับ {appName}

ตัวอย่าง: - "google/drive/file:id" - "google/drive/folder:id" - "google/docs/document:id" - "google/sheets/spreadsheet:id" - "jira/issue:key" - "slack/channel:id" เป็นต้น

ไคลเอ็นต์จะใช้ข้อมูลนี้เพื่อบอกใบ้ผู้ใช้ว่าตัวแปรผลลัพธ์ใดเข้ากันได้กับอินพุตหนึ่งๆ

disallowedResourceAttributes[]

string

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

DynamicSchema

การกำหนดค่าสำหรับการแก้ไขสคีมาของตัวแปรนี้แบบไดนามิกที่รันไทม์

การแสดง JSON
{
  "requiredInputIds": [
    string
  ],
  "strictEnum": boolean
}
ช่อง
requiredInputIds[]

string

รหัสของตัวแปรอินพุตที่เกี่ยวข้องซึ่งต้องระบุก่อนจึงจะแก้ไขสคีมาของตัวแปรนี้แบบไดนามิกได้

strictEnum

boolean

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

ResourceFieldsDefinitionRetrieval

ดึงข้อมูลคำจำกัดความของฟิลด์ที่ทรัพยากรรองรับ

การแสดง JSON
{
  "elementId": string,
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  }
}
ช่อง
elementId

string

ระบุรหัสขององค์ประกอบที่มีสคีมาทรัพยากรแบบไดนามิกที่จะดึงข้อมูล

inputs

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

ซึ่งประกอบด้วยอินพุตช่องของโหนดที่ให้ตัวแปร แผนที่ของตัวแปรอินพุตที่คีย์ตามชื่อตัวแปรอินพุต

ออบเจ็กต์ที่มีรายการคู่ "key": value รายการ เช่น { "name": "wrench", "mass": "1.3kg", "count": "3" }

ElementUiAutocomplete

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

การแสดง JSON
{
  "query": string,
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "invokedFunction": string,
  "resourceId": string,
  "operationId": string
}
ช่อง
query

string

คำค้นหาที่จะเติมข้อความอัตโนมัติ

inputs

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

แผนที่ของตัวแปรอินพุตที่คีย์ตามชื่อตัวแปรอินพุต

ออบเจ็กต์ที่มีรายการคู่ "key": value รายการ เช่น { "name": "wrench", "mass": "1.3kg", "count": "3" }

invokedFunction

string

ฟังก์ชันที่เรียกใช้ซึ่งเชื่อมโยงกับวิดเจ็ต

resourceId

string

รหัสทรัพยากรที่ควรเติมข้อความอัตโนมัติ ฟิลด์นี้เป็นฟิลด์ที่ไม่บังคับและอาจไม่ได้ตั้งค่าไว้

operationId

string

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

ExecutionMetadata

ข้อมูลเมตาเกี่ยวกับการดำเนินการเวิร์กโฟลว์

การแสดง JSON
{
  "versionId": integer,
  "timeZone": string,
  "stepNumber": integer
}
ช่อง
versionId

integer

เวอร์ชันขององค์ประกอบเวิร์กโฟลว์ที่เรียกใช้

timeZone

string

เขตเวลาของเวิร์กโฟลว์ที่บันทึก เช่น "America/Los_Angeles"

stepNumber

integer

แสดงหมายเลขขั้นตอนของพริมิทีฟที่เรียกใช้

TriggerEventSource

แหล่งที่มาของเหตุการณ์ทริกเกอร์ที่ทริกเกอร์การดำเนินการนี้

Enum
TRIGGER_EVENT_SOURCE_UNSPECIFIED ค่าเริ่มต้น DO NOT USE.
TRIGGER_EVENT_SOURCE_AUTOMATED การดำเนินการจะทริกเกอร์โดยอัตโนมัติจากเหตุการณ์
TRIGGER_EVENT_SOURCE_TEST_RUN การดำเนินการจะทริกเกอร์ผ่านการรันเพื่อทดสอบ