EventObject

EventObject

Sự kiện tương tác với tiện ích bổ sung của Google chứa dữ liệu về hoạt động tương tác của người dùng với tiện ích bổ sung trong ứng dụng lưu trữ.

Đối tượng sự kiện được truyền dưới dạng JSON đến hàm callback hoặc điểm kích hoạt của tiện ích bổ sung (đối với AppsScript) hoặc điểm cuối https (đối với HTTP), khi người dùng tương tác với tiện ích bổ sung trong ứng dụng lưu trữ. Đối tượng sự kiện lưu trữ một đối tượng sự kiện của ứng dụng lưu trữ do mỗi ứng dụng lưu trữ xác định, cũng như một đối tượng sự kiện chung chứa một số trường chung liên quan đến sự kiện.

Để biết thêm thông tin, hãy xem bài viết Đối tượng sự kiện.

Biểu diễn dưới dạng 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.
}
Trường
commonEventObject

object (CommonEventObject)

Một đối tượng chứa thông tin chung cho tất cả đối tượng sự kiện, bất kể ứng dụng lưu trữ.

authorizationEventObject

object (AuthorizationEventObject)

Chỉ đặt cho các yêu cầu đến điểm cuối HTTP

Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
calendar

object (CalendarEventObject)

Chỉ xuất hiện nếu máy chủ gọi là Lịch Google. Một đối tượng chứa thông tin về lịch và sự kiện.

drive

object (DriveEventObject)

Chỉ xuất hiện nếu máy chủ gọi là Google Drive. Một đối tượng chứa thông tin về Drive.

gmail

object (GmailEventObject)

Chỉ xuất hiện nếu máy chủ gọi là Gmail. Một đối tượng chứa thông tin về Gmail.

sheets

object (SheetsEventObject)

Chỉ xuất hiện nếu máy chủ gọi là Google Trang tính. Một đối tượng chứa thông tin về Trang tính.

slides

object (SlidesEventObject)

Chỉ xuất hiện nếu máy chủ gọi là Google Trang trình bày. Một đối tượng chứa thông tin về Trang trình bày.

docs

object (DocsEventObject)

Chỉ xuất hiện nếu máy chủ lưu trữ gọi là Google Tài liệu. Một đối tượng chứa thông tin về Tài liệu.

chat

object (ChatEventObject)

Chỉ xuất hiện nếu máy chủ gọi là Google Chat. Một đối tượng chứa thông tin về cuộc trò chuyện.

workflow

object (WorkflowEventObject)

Chỉ xuất hiện nếu máy chủ gọi là Google Workspace Studio. Một đối tượng chứa thông tin về quy trình công việc.

Kết thúc các trường loại trừ lẫn nhau.

CommonEventObject

Đối tượng sự kiện chung là một phần của đối tượng sự kiện tổng thể, mang thông tin chung, độc lập với máy chủ lưu trữ đến tiện ích bổ sung từ ứng dụng của người dùng. Thông tin này bao gồm các thông tin chi tiết như ngôn ngữ, ứng dụng lưu trữ và nền tảng của người dùng.

Ngoài trình kích hoạt trang chủ và trình kích hoạt theo bối cảnh, các tiện ích bổ sung còn tạo và truyền đối tượng sự kiện đến hàm callback hành động khi người dùng tương tác với các tiện ích. Hàm callback của tiện ích bổ sung có thể truy vấn đối tượng sự kiện chung để xác định nội dung của các tiện ích đang mở trong ứng dụng khách của người dùng. Ví dụ: tiện ích bổ sung của bạn có thể tìm thấy văn bản mà người dùng đã nhập vào tiện ích TextInput trong đối tượng eventObject.commentEventObject.formInputs.

Đối với ứng dụng Chat, tên của hàm mà người dùng gọi khi tương tác với một tiện ích.

Biểu diễn dưới dạng JSON
{
  "userLocale": string,
  "hostApp": enum (HostApp),
  "platform": enum (Platform),
  "timeZone": {
    object (TimeZone)
  },
  "formInputs": {
    string: {
      object (Inputs)
    },
    ...
  },
  "parameters": {
    string: string,
    ...
  },
  "invokedFunction": string
}
Trường
userLocale

string

Tắt theo mặc định. Giá trị nhận dạng ngôn ngữ và quốc gia/khu vực của người dùng theo định dạng mã ngôn ngữ ISO 639-mã quốc gia/khu vực ISO 3166. Ví dụ: en-US.

Để bật trường này, bạn phải đặt addOns.common.useLocaleFromApp thành true trong tệp kê khai của tiện ích bổ sung. Danh sách phạm vi của tiện ích bổ sung cũng phải bao gồm https://www.googleapis.com/auth/script.locale. Hãy xem phần Truy cập vào ngôn ngữ và múi giờ của người dùng để biết thêm thông tin chi tiết.

hostApp

enum (HostApp)

Cho biết ứng dụng lưu trữ mà tiện ích bổ sung đang hoạt động khi đối tượng sự kiện được tạo. Các giá trị có thể bao gồm:

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

enum (Platform)

Enum nền tảng cho biết nền tảng nơi sự kiện bắt nguồn (WEB, IOS hoặc ANDROID). Các ứng dụng Chat không hỗ trợ enum này.

timeZone

object (TimeZone)

Tắt theo mặc định. Mã múi giờ và độ lệch so với Giờ phối hợp quốc tế (UTC). Để bật trường này, bạn phải đặt addOns.common.useLocaleFromApp thành true trong tệp kê khai của tiện ích bổ sung. Danh sách phạm vi của tiện ích bổ sung cũng phải bao gồm https://www.googleapis.com/auth/script.locale. Hãy xem phần Truy cập vào ngôn ngữ và múi giờ của người dùng để biết thêm thông tin chi tiết.

Chỉ được hỗ trợ cho các loại sự kiện CARD_CLICKED và SUBMIT_DIALOG.

formInputs

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

Một bản đồ chứa các giá trị hiện tại của các tiện ích trong thẻ hiển thị. Khoá bản đồ là các giá trị chuỗi name được chỉ định cho từng tiện ích đầu vào (chẳng hạn như TextInput.name, SelectionInput.name, DateTimePicker.name hoặc DecoratedText.SwitchControl.name).

Cấu trúc của đối tượng giá trị bản đồ phụ thuộc vào loại tiện ích:

Lưu ý: Các ví dụ sau đây được định dạng cho môi trường thời gian chạy V8 của Apps Script. Nếu đang sử dụng thời gian chạy Rhino, bạn phải thêm [""] sau giá trị. Ví dụ: thay vì e.commonEventObject.formInputs.employeeName.stringInputs.value[0], hãy định dạng đối tượng sự kiện là e.commonEventObject.formInputs.employeeName[""].stringInputs.value[0]. Để tìm hiểu thêm về môi trường thời gian chạy trong Apps Script, hãy xem bài viết Tổng quan về môi trường thời gian chạy V8.

  • Tiện ích có một giá trị (ví dụ: tiện ích TextInput hoặc tiện ích SelectionInput thuộc loại DROPDOWN hoặc RADIO_BUTTON): đối tượng StringInputs chứa danh sách có một phần tử (hoặc danh sách trống nếu không có lựa chọn nào).

Ví dụ: đối với một tiện ích nhập văn bản có employeeName là name, hãy truy cập vào giá trị nhập văn bản bằng: e.commonEventObject.formInputs.employeeName.stringInputs.value[0].

  • Tiện ích nhiều giá trị (ví dụ: tiện ích SelectionInput thuộc loại CHECK_BOX, SWITCH hoặc MULTI_SELECT): đối tượng StringInputs chứa danh sách chuỗi value của mục đã chọn.

Ví dụ: đối với một tiện ích nhiều giá trị có participants là name, hãy truy cập vào mảng giá trị bằng: e.commonEventObject.formInputs.participants.stringInputs.value.

  • Tiện ích DecoratedText.SwitchControl: đối tượng StringInputs. Khi selected là true, stringInputs.value chứa trường value của nút chuyển (hoặc "" nếu value không được chỉ định; nếu nhiều nút chuyển có cùng name, thì value của mỗi nút chuyển đã chọn sẽ được đưa vào danh sách). Khi selected là false, value của nút chuyển sẽ bị bỏ qua khỏi stringInputs.value.

  • Bộ chọn ngày giờ (DateTimePickerType.DATE_AND_TIME): DateTimeInput object.

Ví dụ: Đối với bộ chọn có name là myDTPicker, hãy truy cập vào đối tượng DateTimeInput bằng e.commonEventObject.formInputs.myDTPicker.dateTimeInput.

Ví dụ: Đối với bộ chọn có name là myDatePicker, hãy truy cập vào đối tượng DateInput bằng e.commonEventObject.formInputs.myDatePicker.dateInput.

  • Bộ chọn chỉ thời gian (DateTimePickerType.TIME_ONLY): TimeInput object.

Ví dụ: Đối với bộ chọn có name là myTimePicker, hãy truy cập vào đối tượng TimeInput bằng e.commonEventObject.formInputs.myTimePicker.timeInput.

Một đối tượng chứa danh sách các cặp "key": value. Ví dụ: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

parameters

map (key: string, value: string)

Bất kỳ tham số bổ sung nào bạn cung cấp cho một hành động bằng cách sử dụng actionParameters hoặc Action.setParameters().

Bản dùng trước cho nhà phát triển: Đối với tiện ích bổ sung mở rộng Google Chat, để đề xuất các mục dựa trên nội dung người dùng nhập vào trình đơn chọn nhiều mục, hãy sử dụng giá trị của khoá "autocomplete_widget_query" (event.commonEventObject.parameters["autocomplete_widget_query"]). Bạn có thể sử dụng giá trị này để truy vấn cơ sở dữ liệu và đề xuất các mục có thể chọn cho người dùng khi họ nhập. Để biết thông tin chi tiết, hãy xem bài viết Thu thập và xử lý thông tin của người dùng Google Chat.

Một đối tượng chứa danh sách các cặp "key": value. Ví dụ: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

invokedFunction

string

Tên của hàm cần gọi.

Trường này không được điền sẵn cho các Tiện ích bổ sung của Google Workspace mở rộng Google Chat. Thay vào đó, để nhận dữ liệu hàm như giá trị nhận dạng, các tiện ích bổ sung mở rộng Chat nên sử dụng trường parameters. Xem bài viết Xây dựng giao diện tương tác cho ứng dụng Chat.

HostApp

Ứng dụng Google Workspace cho một tiện ích bổ sung của Google Workspace hoặc ứng dụng Google Chat.

Đối với tiện ích bổ sung, ứng dụng Workspace mà tiện ích bổ sung của Google Workspace khởi chạy. Đối với ứng dụng Chat, ứng dụng lưu trữ luôn là CHAT.

Enum
UNSPECIFIED_HOST_APP Google không thể xác định ứng dụng lưu trữ.
GMAIL Tiện ích bổ sung sẽ chạy trong Gmail.
CALENDAR Tiện ích bổ sung này chạy trong Lịch Google.
DRIVE Tiện ích bổ sung này chạy trong Google Drive.
DEMO Không được sử dụng.
DOCS Tiện ích bổ sung này chạy trong Google Tài liệu.
MEET Tiện ích bổ sung sẽ chạy trong Google Meet.
SHEETS Tiện ích bổ sung này sẽ chạy trong Google Trang tính.
SLIDES Tiện ích bổ sung này chạy trong Google Trang trình bày.
DRAWINGS Tiện ích bổ sung sẽ chạy trong Google Bản vẽ.
CHAT Một ứng dụng Google Chat.

Nền tảng

Xác định nền tảng mà cuộc gọi này bắt nguồn.

Enum
UNKNOWN_PLATFORM
WEB
IOS
ANDROID

TimeZone

Mã múi giờ và độ lệch so với Giờ phối hợp quốc tế (UTC). Chỉ được hỗ trợ cho các loại sự kiện CARD_CLICKED và SUBMIT_DIALOG.

Biểu diễn dưới dạng JSON
{
  "id": string,
  "offset": integer
}
Trường
id

string

Mã cơ sở dữ liệu múi giờ IANA TZ, chẳng hạn như "America/Toronto".

offset

integer

Độ lệch múi giờ của người dùng, tính bằng mili giây, so với Giờ phối hợp quốc tế (UTC).

Thông tin đầu vào

Các loại dữ liệu mà người dùng có thể nhập vào thẻ hoặc hộp thoại. Loại dữ liệu đầu vào phụ thuộc vào loại giá trị mà tiện ích chấp nhận.

Biểu diễn dưới dạng 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.
}
Trường
Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
stringInputs

object (StringInputs)

Danh sách các chuỗi đại diện cho giá trị mà người dùng nhập vào một tiện ích.

Nếu tiện ích chỉ chấp nhận một giá trị, chẳng hạn như tiện ích TextInput, thì danh sách sẽ chứa một đối tượng chuỗi. Nếu tiện ích chấp nhận nhiều giá trị, chẳng hạn như tiện ích SelectionInput của hộp đánh dấu, thì danh sách sẽ chứa một đối tượng chuỗi cho mỗi giá trị mà người dùng nhập hoặc chọn.

dateTimeInput

object (DateTimeInput)

Giá trị nhập ngày và giờ từ một tiện ích DateTimePicker chấp nhận cả ngày và giờ.

dateInput

object (DateInput)

Giá trị nhập ngày từ một tiện ích DateTimePicker chỉ chấp nhận giá trị ngày.

timeInput

object (TimeInput)

Giá trị nhập thời gian từ một tiện ích DateTimePicker chỉ chấp nhận giá trị thời gian.

Kết thúc các trường loại trừ lẫn nhau.

StringInputs

Tham số đầu vào cho các tiện ích thông thường. Đối với các tiện ích có một giá trị, đây là danh sách một giá trị. Đối với các tiện ích có nhiều giá trị, chẳng hạn như hộp đánh dấu, tất cả các giá trị đều được trình bày.

Biểu diễn dưới dạng JSON
{
  "value": [
    string
  ]
}
Trường
value[]

string

Danh sách các chuỗi do người dùng nhập.

DateTimeInput

Giá trị nhập ngày và giờ.

Biểu diễn dưới dạng JSON
{
  "msSinceEpoch": string,
  "hasDate": boolean,
  "hasTime": boolean
}
Trường
msSinceEpoch

string (int64 format)

Thời gian kể từ thời gian bắt đầu của hệ thống, tính bằng mili giây.

hasDate

boolean

Liệu dữ liệu đầu vào datetime có bao gồm ngày theo lịch hay không.

hasTime

boolean

Liệu dữ liệu đầu vào datetime có bao gồm dấu thời gian hay không.

DateInput

Giá trị ngày nhập.

Biểu diễn dưới dạng JSON
{
  "msSinceEpoch": string
}
Trường
msSinceEpoch

string (int64 format)

Thời gian kể từ thời gian bắt đầu của hệ thống, tính bằng mili giây.

TimeInput

Giá trị thời gian đầu vào.

Biểu diễn dưới dạng JSON
{
  "hours": integer,
  "minutes": integer
}
Trường
hours

integer

Giờ trên đồng hồ 24 giờ.

minutes

integer

Số phút sau giờ. Giá trị hợp lệ là từ 0 đến 59.

AuthorizationEventObject

Đóng gói thông tin uỷ quyền cho yêu cầu của tiện ích bổ sung

Biểu diễn dưới dạng JSON
{
  "userOAuthToken": string,
  "userIdToken": string,
  "systemIdToken": string,
  "authorizedScopes": [
    string
  ]
}
Trường
userOAuthToken

string

Mã truy cập OAuth của người dùng cuối, được uỷ quyền theo phạm vi yêu cầu. (Sau khi tách riêng sự đồng ý của OAuth, việc này sẽ được uỷ quyền theo phạm vi mà người dùng cuối uỷ quyền)

userIdToken

string

Mã thông báo mã nhận dạng người dùng cuối, nếu bạn yêu cầu phạm vi mã nhận dạng thích hợp

systemIdToken

string

Mã thông báo giá trị nhận dạng cho tài khoản dịch vụ Tiện ích bổ sung của G Suite cho lần triển khai này

authorizedScopes[]

string

Danh sách phạm vi OAuth được người dùng uỷ quyền.

CalendarEventObject

Đối tượng sự kiện trên Lịch là một phần của đối tượng sự kiện tổng thể, chứa thông tin về lịch và sự kiện trên lịch của người dùng. Trường này chỉ xuất hiện trong đối tượng sự kiện nếu ứng dụng lưu trữ là Lịch Google.

Bảng sau đây liệt kê các trường có trong trường calendar của một đối tượng sự kiện. Các trường được đánh dấu là Dữ liệu do người dùng tạo sẽ xuất hiện trong đối tượng sự kiện nếu và chỉ khi dữ liệu đó có trong sự kiện trên Lịch và tiện ích bổ sung đặt trường manifest addOns.calendar.currentEventAccess thành READ hoặc READ_WRITE.

Biểu diễn dưới dạng JSON
{
  "id": string,
  "recurringEventId": string,
  "calendarId": string,
  "organizer": {
    object (Organizer)
  },
  "attendees": [
    {
      object (Attendee)
    }
  ],
  "conferenceData": {
    object (ConferenceData)
  },
  "capabilities": {
    object (Capabilities)
  }
}
Trường
id

string

Mã sự kiện.

recurringEventId

string

Mã nhận dạng của một sự kiện định kỳ.

calendarId

string

Mã lịch.

organizer

object (Organizer)

Một đối tượng đại diện cho người tổ chức sự kiện.

attendees[]

object (Attendee)

Dữ liệu do người dùng tạo. Danh sách người tham dự sự kiện trên lịch.

conferenceData

object (ConferenceData)

Dữ liệu do người dùng tạo. Đối tượng đại diện cho mọi dữ liệu hội nghị liên kết với sự kiện này, chẳng hạn như thông tin chi tiết về hội nghị trên Google Meet.

capabilities

object (Capabilities)

Dữ liệu do người dùng tạo. Một đối tượng mô tả các chức năng của tiện ích bổ sung để xem hoặc cập nhật thông tin sự kiện.

Người tổ chức

Biểu diễn dưới dạng JSON
{
  "email": string
}
Trường
email

string

Địa chỉ email của người tổ chức sự kiện.

Người tham dự

Đối tượng người tham dự chứa thông tin về từng người tham dự sự kiện trên Lịch Google. Thông tin này có trong đối tượng sự kiện nếu và chỉ khi dữ liệu có trong sự kiện trên Lịch và tiện ích bổ sung đặt trường addOns.calendar.currentEventAccess manifest thành READ hoặc READ_WRITE.

Biểu diễn dưới dạng JSON
{
  "email": string,
  "displayName": string,
  "organizer": boolean,
  "self": boolean,
  "resource": boolean,
  "optional": boolean,
  "responseStatus": string,
  "comment": string,
  "additionalGuests": integer
}
Trường
email

string

Địa chỉ email của người tham dự.

displayName

string

Tên hiển thị của người tham dự.

organizer

boolean

true nếu người tham dự là người tổ chức sự kiện này.

self

boolean

true nếu người tham dự này đại diện cho lịch mà sự kiện này xuất hiện; nếu không thì là false.

resource

boolean

true nếu người tham dự đại diện cho một tài nguyên, chẳng hạn như phòng hoặc thiết bị; nếu không thì là false.

optional

boolean

true nếu trạng thái tham dự của người tham dự này được đánh dấu là không bắt buộc; nếu không thì là false.

responseStatus

string

Trạng thái phản hồi của người tham dự. Các giá trị có thể bao gồm:

  • accepted: Người tham dự đã chấp nhận lời mời tham gia sự kiện.
  • declined: Người tham dự đã từ chối lời mời tham gia sự kiện.
  • needsAction: Người tham dự chưa phản hồi lời mời tham gia sự kiện.
  • tentative: Người tham dự đã tạm thời chấp nhận lời mời tham gia sự kiện.
comment

string

Bình luận phản hồi của người tham dự (nếu có).

additionalGuests

integer

Số lượng khách bổ sung mà người tham dự cho biết họ sẽ mời đến. Giá trị mặc định là 0.

ConferenceData

Đối tượng dữ liệu hội nghị truyền hình chứa thông tin về các hội nghị truyền hình được đính kèm vào sự kiện trên Lịch Google. Đây có thể là các giải pháp hội nghị truyền hình của Google, chẳng hạn như Google Meet hoặc hội nghị truyền hình của bên thứ ba. Thông tin này có trong đối tượng sự kiện nếu và chỉ khi dữ liệu có trong sự kiện trên Lịch và tiện ích bổ sung đặt trường addOns.calendar.currentEventAccess manifest thành READ hoặc READ_WRITE.

Biểu diễn dưới dạng JSON
{
  "conferenceId": string,
  "conferenceSolution": {
    object (ConferenceSolution)
  },
  "entryPoints": [
    {
      object (EntryPoint)
    }
  ],
  "notes": string,
  "parameters": {
    object (Parameters)
  }
}
Trường
conferenceId

string

Mã nhận dạng của hội nghị. Mã nhận dạng này giúp các ứng dụng theo dõi hội nghị; bạn không nên hiển thị mã nhận dạng này cho người dùng.

conferenceSolution

object (ConferenceSolution)

Một đối tượng đại diện cho giải pháp hội nghị truyền hình, chẳng hạn như Hangouts hoặc Google Meet.

entryPoints[]

object (EntryPoint)

Danh sách các điểm truy cập hội nghị, chẳng hạn như URL hoặc số điện thoại.

notes

string

Ghi chú bổ sung (chẳng hạn như hướng dẫn của quản trị viên miền hoặc thông báo pháp lý) về hội nghị để hiển thị cho người dùng. Có thể chứa HTML. Độ dài tối đa là 2048 ký tự.

parameters

object (Parameters)

Một đối tượng chứa bản đồ dữ liệu tham số đã xác định để tiện ích bổ sung sử dụng.

ConferenceSolution

Biểu diễn dưới dạng JSON
{
  "iconUri": string,
  "key": {
    object (Key)
  },
  "name": string
}
Trường
iconUri

string

URI cho biểu tượng mà người dùng nhìn thấy, đại diện cho giải pháp hội nghị truyền hình này.

key

object (Key)

Khoá xác định duy nhất giải pháp hội nghị truyền hình cho sự kiện này.

name

string

Tên hiển thị cho người dùng của giải pháp hội nghị truyền hình này (không được bản địa hoá).

Khoá

Biểu diễn dưới dạng JSON
{
  "type": string
}
Trường
type

string

Loại giải pháp hội nghị truyền hình. Các giá trị có thể bao gồm:

EntryPoint

Đối tượng điểm truy cập chứa thông tin về các phương tiện đã thiết lập để truy cập vào một hội nghị nhất định, chẳng hạn như qua điện thoại hoặc video. Thông tin này có trong đối tượng sự kiện nếu và chỉ khi dữ liệu có trong sự kiện trên Lịch và tiện ích bổ sung đặt trường addOns.calendar.currentEventAccess manifest thành READ hoặc READ_WRITE.

Biểu diễn dưới dạng JSON
{
  "accessCode": string,
  "entryPointType": string,
  "label": string,
  "meetingCode": string,
  "passcode": string,
  "password": string,
  "pin": string,
  "uri": string,
  "regionCode": string,
  "entryPointFeatures": [
    string
  ]
}
Trường
accessCode

string

Mã truy cập dùng để tham gia hội nghị. Độ dài tối đa là 128 ký tự. Nhà cung cấp dịch vụ hội nghị thường chỉ sử dụng một số {accessCode, meetingCode, passcode, password, pin} để cấp quyền truy cập vào hội nghị. So khớp và chỉ hiển thị các trường mà nhà cung cấp dịch vụ hội nghị sử dụng.

entryPointType

string

Loại điểm truy cập. Các giá trị có thể có như sau:

  • more: Hướng dẫn bổ sung về cách tham gia hội nghị, chẳng hạn như số điện thoại thay thế. Mỗi hội nghị truyền hình chỉ được có một điểm truy cập more; nếu có điểm truy cập này thì cũng phải có ít nhất một loại điểm truy cập khác.
  • phone: Tham gia hội nghị qua số điện thoại. Một hội nghị có thể không có hoặc có nhiều điểm truy cập điện thoại. Lịch Google chỉ hiển thị hai điểm truy cập đầu tiên qua điện thoại, sau khi định dạng và sắp xếp theo thứ tự bảng chữ cái.
  • sip: Tham gia hội nghị qua SIP. Một hội nghị truyền hình chỉ có thể có tối đa một điểm truy cập sip.
  • video: Tham gia hội nghị qua HTTP. Một hội nghị có thể có tối đa một điểm truy cập video.
label

string

Nhãn mà người dùng nhìn thấy cho URI điểm truy cập (không được bản địa hoá).

meetingCode

string

Mã cuộc họp dùng để tham gia hội nghị. Độ dài tối đa là 128 ký tự. Nhà cung cấp dịch vụ hội nghị thường chỉ sử dụng một số {accessCode, meetingCode, passcode, password, pin} để cấp quyền truy cập vào hội nghị. So khớp và chỉ hiển thị các trường mà nhà cung cấp dịch vụ hội nghị sử dụng.

passcode

string

Mật mã dùng để tham gia hội nghị. Độ dài tối đa là 128 ký tự. Nhà cung cấp dịch vụ hội nghị thường chỉ sử dụng một số {accessCode, meetingCode, passcode, password, pin} để cấp quyền truy cập vào hội nghị. So khớp và chỉ hiển thị các trường mà nhà cung cấp dịch vụ hội nghị sử dụng.

password

string

Mật khẩu dùng để tham gia hội nghị. Độ dài tối đa là 128 ký tự. Nhà cung cấp dịch vụ hội nghị thường chỉ sử dụng một số {accessCode, meetingCode, passcode, password, pin} để cấp quyền truy cập vào hội nghị. So khớp và chỉ hiển thị các trường mà nhà cung cấp dịch vụ hội nghị sử dụng.

pin

string

Mã PIN dùng để tham gia hội nghị. Độ dài tối đa là 128 ký tự. Nhà cung cấp dịch vụ hội nghị thường chỉ sử dụng một số {accessCode, meetingCode, passcode, password, pin} để cấp quyền truy cập vào hội nghị. So khớp và chỉ hiển thị các trường mà nhà cung cấp dịch vụ hội nghị sử dụng.

uri

string

URI của điểm truy cập. Độ dài tối đa là 1.300 ký tự. Định dạng phụ thuộc vào loại điểm truy cập:

  • more: Bạn phải sử dụng lược đồ http: hoặc https:.
  • phone: Bạn phải sử dụng lược đồ tel:. URI phải bao gồm toàn bộ trình tự quay số (ví dụ: "tel:+12345678900,,,12345678;1234").
  • sip: Cần có giản đồ sip: hoặc sips:. Ví dụ: "sip:12345678@myprovider.com".
  • video: Bạn phải sử dụng giao thức http: hoặc https:.
regionCode

string

Mã vùng của số điện thoại. Người dùng cần mã này nếu URI không có mã quốc gia. Giá trị dựa trên danh sách mã vùng CLDR công khai.

entryPointFeatures[]

string

Các tính năng của điểm truy cập. Hiện tại, các tính năng này chỉ áp dụng cho điểm truy cập qua điện thoại:

  • toll: Điểm truy cập là một cuộc gọi điện thoại có tính phí.
  • toll_free: Điểm truy cập là một cuộc gọi điện thoại miễn phí.

Thông số

Biểu diễn dưới dạng JSON
{
  "addOnParameters": {
    object (AddOnParameters)
  }
}
Trường
addOnParameters

object (AddOnParameters)

Bản đồ các khoá và giá trị chuỗi tham số. Các khoá và giá trị này do nhà phát triển tiện ích bổ sung xác định để đính kèm thông tin vào một hội nghị cụ thể cho tiện ích bổ sung sử dụng.

AddOnParameters

Biểu diễn dưới dạng JSON
{
  "parameters": {
    string: string,
    ...
  }
}
Trường
parameters

map (key: string, value: string)

Một đối tượng chứa danh sách các cặp "key": value. Ví dụ: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Tính năng

Biểu diễn dưới dạng JSON
{
  "canSeeAttendees": boolean,
  "canAddAttendees": boolean,
  "canSeeConferenceData": boolean,
  "canSetConferenceData": boolean,
  "canAddAttachments": boolean
}
Trường
canSeeAttendees

boolean

Dữ liệu do người dùng tạo. true nếu tiện ích bổ sung có thể đọc danh sách người tham dự sự kiện; false nếu không.

canAddAttendees

boolean

Dữ liệu do người dùng tạo. true nếu tiện ích bổ sung có thể thêm người tham dự mới vào danh sách người tham dự sự kiện; nếu không thì là false.

canSeeConferenceData

boolean

Dữ liệu do người dùng tạo. true nếu tiện ích bổ sung có thể đọc dữ liệu hội nghị của sự kiện; nếu không thì là false.

canSetConferenceData

boolean

Dữ liệu do người dùng tạo. true nếu tiện ích bổ sung có thể cập nhật dữ liệu hội nghị của sự kiện; nếu không thì là false.

canAddAttachments

boolean

Dữ liệu do người dùng tạo. true nếu tiện ích bổ sung có thể thêm tệp đính kèm mới vào sự kiện; nếu không thì là false.

DriveEventObject

Đối tượng sự kiện Drive là một phần của đối tượng sự kiện tổng thể, chứa thông tin về Google Drive của người dùng và nội dung trong đó. Trường này chỉ xuất hiện trong đối tượng sự kiện nếu ứng dụng lưu trữ là Google Drive.

Biểu diễn dưới dạng JSON
{
  "selectedItems": [
    {
      object (DriveItemMetadata)
    }
  ],
  "activeCursorItem": {
    object (DriveItemMetadata)
  }
}
Trường
selectedItems[]

object (DriveItemMetadata)

Danh sách các mục (tệp hoặc thư mục) được chọn trong Drive.

activeCursorItem

object (DriveItemMetadata)

Mục Drive hiện đang hoạt động.

DriveItemMetadata

Đối tượng mục trên Drive chứa thông tin về các mục cụ thể trên Drive, chẳng hạn như tệp hoặc thư mục.

Biểu diễn dưới dạng JSON
{
  "id": string,
  "iconUrl": string,
  "mimeType": string,
  "title": string,
  "addonHasFileScopePermission": boolean
}
Trường
id

string

Mã nhận dạng của mặt hàng đã chọn.

iconUrl

string

URL của biểu tượng đại diện cho mục đã chọn.

mimeType

string

Loại MIME của mục đã chọn.

title

string

Tiêu đề của mục đã chọn.

addonHasFileScopePermission

boolean

Nếu là true, thì tiện ích bổ sung đã yêu cầu và nhận được uỷ quyền phạm vi https://www.googleapis.com/auth/drive.file cho mục này. Nếu không, trường này sẽ là false.

Nếu tiện ích bổ sung sử dụng một phạm vi có nhiều quyền hơn, chẳng hạn như https://www.googleapis.com/auth/drive hoặc https://www.googleapis.com/auth/drive.readonly, thì trường này không liên quan. Luôn sử dụng phạm vi ít cho phép nhất có thể khi thiết kế tiện ích bổ sung để bảo vệ thông tin người dùng.

GmailEventObject

Đối tượng sự kiện Gmail là một phần của đối tượng sự kiện tổng thể, chứa thông tin về thư Gmail của người dùng. Trường này chỉ xuất hiện trong đối tượng sự kiện nếu ứng dụng lưu trữ là Gmail.

Biểu diễn dưới dạng JSON
{
  "messageId": string,
  "threadId": string,
  "accessToken": string,
  "toRecipients": [
    string
  ],
  "ccRecipients": [
    string
  ],
  "bccRecipients": [
    string
  ]
}
Trường
messageId

string

Mã nhận dạng của thư Gmail đang mở.

threadId

string

Mã chuỗi email hiện đang mở trong Gmail.

accessToken

string

Mã truy cập dành riêng cho Gmail. Bạn có thể sử dụng mã thông báo này với phương thức GmailApp.setCurrentMessageAccessToken(accessToken) để cấp cho tiện ích bổ sung quyền truy cập tạm thời vào thư Gmail hiện đang mở của người dùng hoặc cho phép tiện ích bổ sung soạn thư nháp mới.

toRecipients[]

string

Tắt theo mặc định. Danh sách địa chỉ email của người nhận trong trường "Đến:" hiện có trong thư nháp mà tiện ích bổ sung đang soạn. Để bật trường này, bạn phải đặt trường addOns.gmail.composeTrigger.draftAccess trong tệp kê khai thành METADATA.

ccRecipients[]

string

Tắt theo mặc định. Danh sách địa chỉ email của người nhận "CC:" hiện có trong bản nháp mà tiện ích bổ sung đang soạn. Để bật trường này, bạn phải đặt trường addOns.gmail.composeTrigger.draftAccess trong tệp kê khai thành METADATA.

bccRecipients[]

string

Tắt theo mặc định. Danh sách địa chỉ email của người nhận "BCC:" hiện có trong bản nháp mà tiện ích bổ sung đang soạn. Để bật trường này, bạn phải đặt trường addOns.gmail.composeTrigger.draftAccess trong tệp kê khai thành METADATA.

SheetsEventObject

Đối tượng sự kiện của Trang tính là một phần của đối tượng sự kiện tổng thể, chứa thông tin về tài liệu của người dùng và nội dung của tài liệu đó. Trường này chỉ xuất hiện trong đối tượng sự kiện nếu tiện ích bổ sung mở rộng Google Trang tính.

Biểu diễn dưới dạng JSON
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
Trường
id

string

Chỉ xuất hiện nếu phạm vi https://www.googleapis.com/auth/drive.file đã được người dùng cho phép. Mã nhận dạng của bảng tính đang mở trong giao diện người dùng của Trang tính.

title

string

Chỉ xuất hiện nếu phạm vi https://www.googleapis.com/auth/drive.file đã được người dùng cho phép. Tiêu đề của bảng tính đang mở trong giao diện người dùng của Trang tính.

addonHasFileScopePermission

boolean

Nếu true, thì tiện ích bổ sung đã yêu cầu và nhận được quyền uỷ quyền phạm vi https://www.googleapis.com/auth/drive.file cho bảng tính đang mở trong giao diện người dùng của Trang tính; nếu không, trường này là false.

matchedUrl

object (MatchedUrl)

Chỉ xuất hiện nếu đáp ứng các điều kiện sau:

  • https://www.googleapis.com/auth/workspace.linkpreview đã được người dùng uỷ quyền.
  • URL khớp với mẫu máy chủ lưu trữ được chỉ định trong điều kiện kích hoạt LinkPreviewTriggers.

URL của đường liên kết tạo bản xem trước trong Google Trang tính. Để sử dụng trường này, bạn phải định cấu hình LinkPreviewTriggers trong tệp kê khai của tiện ích bổ sung. Hãy xem bài viết Xem trước đường liên kết bằng khối thông minh để biết thêm thông tin.

Ví dụ về tải trọng khi người dùng xem trước đường liên kết https://www.example.com/12345:

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

MatchedUrl

Đối tượng sự kiện được trả về cùng với yêu cầu xem trước đường liên kết.

Biểu diễn dưới dạng JSON
{
  "url": string
}
Trường
url

string

URL khớp với mẫu.

SlidesEventObject

Đối tượng sự kiện của Trang trình bày là một phần của đối tượng sự kiện tổng thể, chứa thông tin về tài liệu của người dùng và nội dung của tài liệu đó. Trường này chỉ xuất hiện trong đối tượng sự kiện nếu tiện ích bổ sung mở rộng Google Trang trình bày.

Biểu diễn dưới dạng JSON
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
Trường
id

string

Chỉ xuất hiện nếu phạm vi https://www.googleapis.com/auth/drive.file đã được người dùng cho phép. Mã nhận dạng của bản trình bày đang mở trong giao diện người dùng của Trang trình bày.

title

string

Chỉ xuất hiện nếu phạm vi https://www.googleapis.com/auth/drive.file đã được người dùng cho phép. Tiêu đề của bản trình bày đang mở trong giao diện người dùng của Trang trình bày.

addonHasFileScopePermission

boolean

Nếu true, thì tiện ích bổ sung đã yêu cầu và nhận được uỷ quyền phạm vi https://www.googleapis.com/auth/drive.file cho bản trình bày đang mở trong giao diện người dùng của Trang trình bày; nếu không, trường này là false.

matchedUrl

object (MatchedUrl)

Chỉ xuất hiện nếu đáp ứng các điều kiện sau:

  • https://www.googleapis.com/auth/workspace.linkpreview đã được người dùng uỷ quyền.
  • URL khớp với mẫu máy chủ lưu trữ được chỉ định trong điều kiện kích hoạt LinkPreviewTriggers.

URL của đường liên kết tạo bản xem trước trong Google Trang trình bày. Để sử dụng trường này, bạn phải định cấu hình LinkPreviewTriggers trong tệp kê khai của tiện ích bổ sung. Hãy xem bài viết Xem trước đường liên kết bằng khối thông minh để biết thêm thông tin.

Ví dụ về tải trọng khi người dùng xem trước đường liên kết https://www.example.com/12345:

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

DocsEventObject

Đối tượng sự kiện của Tài liệu là một phần của đối tượng sự kiện tổng thể, chứa thông tin về tài liệu của người dùng và nội dung của tài liệu đó. Trường này chỉ xuất hiện trong một đối tượng sự kiện nếu tiện ích bổ sung mở rộng Google Tài liệu.

Biểu diễn dưới dạng JSON
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
Trường
id

string

Chỉ xuất hiện nếu phạm vi https://www.googleapis.com/auth/drive.file đã được người dùng cho phép. Mã nhận dạng của tài liệu đang mở trong giao diện người dùng của Tài liệu.

title

string

Chỉ xuất hiện nếu phạm vi https://www.googleapis.com/auth/drive.file đã được người dùng cho phép. Tiêu đề của tài liệu đang mở trong giao diện người dùng của Tài liệu.

addonHasFileScopePermission

boolean

Nếu true, tiện ích bổ sung đã yêu cầu và nhận được uỷ quyền phạm vi https://www.googleapis.com/auth/drive.file cho tài liệu đang mở trong giao diện người dùng của Tài liệu; nếu không, trường này là false.

matchedUrl

object (MatchedUrl)

Chỉ xuất hiện nếu đáp ứng các điều kiện sau:

  • https://www.googleapis.com/auth/workspace.linkpreview đã được người dùng uỷ quyền.
  • URL khớp với mẫu máy chủ lưu trữ được chỉ định trong điều kiện kích hoạt LinkPreviewTriggers.

URL của đường liên kết tạo bản xem trước trong Google Tài liệu. Để sử dụng trường này, bạn phải định cấu hình LinkPreviewTriggers trong tệp kê khai của tiện ích bổ sung. Hãy xem bài viết Xem trước đường liên kết bằng khối thông minh để biết thêm thông tin.

Ví dụ về tải trọng khi người dùng xem trước đường liên kết https://www.example.com/12345:

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

ChatEventObject

Trọng tải đối tượng sự kiện của ứng dụng Google Chat được gửi từ máy chủ của Google đến các tiện ích bổ sung. Bạn có thể dùng tải trọng để xác định loại sự kiện.

Biểu diễn dưới dạng 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.
}
Trường
type

enum (EventType)

Loại sự kiện, chỉ được điền sẵn cho các sự kiện Trang chủ ứng dụng trong những ứng dụng Chat không phải là tiện ích bổ sung.

user

object (User)

Người dùng tương tác với ứng dụng Chat.

space

object (Space)

Không gian nơi sự kiện xảy ra, chỉ được điền sẵn cho các sự kiện trên Trang chủ ứng dụng trong các ứng dụng Chat không phải là tiện ích bổ sung.

eventTime

string (Timestamp format)

Dấu thời gian cho biết thời điểm đối tượng sự kiện xảy ra.

Hãy dùng RFC 3339, trong đó dữ liệu đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các khoảng lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".

Phần tải của đối tượng sự kiện. Trọng tải phụ thuộc vào loại đối tượng sự kiện. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
messagePayload

object (MessagePayload)

Người dùng gửi tin nhắn cho ứng dụng Chat hoặc @đề_cập đến ứng dụng Chat trong một không gian. Thay vào đó, các lệnh gọi lệnh trong ứng dụng (chẳng hạn như lệnh dấu gạch chéo và lệnh nhanh) sẽ được gửi trong appCommandPayload.

addedToSpacePayload

object (AddedToSpacePayload)

Người dùng thêm ứng dụng Chat vào một không gian trong Chat hoặc quản trị viên Google Workspace cài đặt ứng dụng Chat trong không gian tin nhắn trực tiếp cho người dùng trong tổ chức của họ.

removedFromSpacePayload

object (RemovedFromSpacePayload)

Người dùng xoá ứng dụng Chat khỏi không gian.

buttonClickedPayload

object (ButtonClickedPayload)

Biểu thị dữ liệu tải trọng khi người dùng tương tác với một thành phần tương tác của thẻ hoặc hộp thoại kích hoạt lệnh gọi lại Action. Mặc dù có tên như vậy, nhưng tải trọng này được điền sẵn cho tất cả lệnh gọi lại của thẻ và hộp thoại Action, không chỉ các lượt nhấp vào nút mà còn cả trình kích hoạt onChangeAction, hành động onClick, lượt nhấp CardAction và việc gửi hoặc huỷ hộp thoại (SUBMIT_DIALOG và CANCEL_DIALOG).

Nếu người dùng tương tác với một hộp thoại, trường isDialogEvent của ButtonClickedPayload sẽ được đặt thành true và bao gồm một DialogEventType.

Trọng tải hoàn chỉnh cũng bao gồm commonEventObject.formInputs và commonEventObject.parameters.

widgetUpdatedPayload

object (WidgetUpdatedPayload)

Người dùng cập nhật một tiện ích trong thẻ trong luồng hoặc trong hộp thoại.

Trọng tải hoàn chỉnh cũng bao gồm CommonEventObject.parameters['autocomplete_widget_query'].

appCommandPayload

object (AppCommandPayload)

Người dùng gọi một lệnh ứng dụng.

systemCommandPayload

object (SystemCommandPayload)

Người dùng gọi một lệnh hệ thống.

Kết thúc các trường loại trừ lẫn nhau.

EventType

Loại sự kiện, chỉ được điền sẵn cho các sự kiện Trang chủ ứng dụng trong những ứng dụng Chat không phải là tiện ích bổ sung.

Enum
EVENT_TYPE_UNSPECIFIED Giá trị mặc định cho enum. DO NOT USE.
APP_HOME Người dùng mở một tin nhắn trực tiếp từ một ứng dụng Chat sử dụng trang chủ của ứng dụng. Chỉ các trường type, user và space mới được đưa vào cho các sự kiện thuộc loại này. Để biết thêm thông tin, hãy xem bài viết Tạo trang chủ cho ứng dụng Google Chat.
SUBMIT_FORM Người dùng gửi thông tin trong thẻ trang chủ của ứng dụng. Chỉ các trường type, user và space mới được đưa vào cho các sự kiện thuộc loại này. Để biết thêm thông tin, hãy xem bài viết [Xây dựng trang chủ cho ứng dụng Google Chat]((https://developers.google.com/workspace/chat/send-app-home-card-message).

MessagePayload

Người dùng gửi tin nhắn cho ứng dụng Chat hoặc @đề_cập đến ứng dụng Chat trong một không gian. Thay vào đó, lệnh gọi lệnh trong ứng dụng (chẳng hạn như lệnh dấu gạch chéo và lệnh nhanh) sẽ sử dụng AppCommandPayload.

Biểu diễn dưới dạng JSON
{
  "space": {
    object (Space)
  },
  "message": {
    object (Message)
  },
  "configCompleteRedirectUri": string
}
Trường
space

object (Space)

Bắt buộc. Phòng Chat nơi đối tượng sự kiện xảy ra.

message

object (Message)

Thông báo kích hoạt đối tượng sự kiện.

configCompleteRedirectUri

string

Không bắt buộc. URL mà ứng dụng Chat sẽ chuyển hướng người dùng đến sau khi họ hoàn tất quy trình uỷ quyền hoặc định cấu hình bên ngoài Google Chat. Để biết thêm thông tin, hãy xem bài viết Kết nối ứng dụng Chat với các dịch vụ và công cụ khác.

AddedToSpacePayload

Người dùng thêm ứng dụng Chat vào một không gian hoặc một tin nhắn trực tiếp giữa ứng dụng và người dùng được tạo.

Biểu diễn dưới dạng JSON
{
  "space": {
    object (Space)
  },
  "interactionAdd": boolean,
  "configCompleteRedirectUri": string
}
Trường
space

object (Space)

Bắt buộc. Phòng Chat nơi đối tượng sự kiện xảy ra.

interactionAdd

boolean

Liệu ứng dụng có được thêm vào không gian thông qua hoạt động tương tác của người dùng hay không (ví dụ: bằng cách đề cập đến ứng dụng Chat bằng @ hoặc gọi ứng dụng bằng lệnh dấu gạch chéo). Nếu bạn đặt giá trị này thành true, thì sẽ có một đối tượng sự kiện riêng biệt liên kết với chính hoạt động tương tác được gửi đến ứng dụng Chat.

configCompleteRedirectUri

string

Không bắt buộc. URL mà ứng dụng Chat sẽ chuyển hướng người dùng đến sau khi họ hoàn tất quy trình uỷ quyền hoặc định cấu hình bên ngoài Google Chat. Để biết thêm thông tin, hãy xem bài viết Kết nối ứng dụng Chat với các dịch vụ và công cụ khác.

RemovedFromSpacePayload

Người dùng xoá ứng dụng Chat khỏi không gian.

Biểu diễn dưới dạng JSON
{
  "space": {
    object (Space)
  }
}
Trường
space

object (Space)

Bắt buộc. Phòng Chat nơi đối tượng sự kiện xảy ra.

ButtonClickedPayload

Người dùng tương tác với một thành phần tương tác của thẻ hoặc hộp thoại từ một Tiện ích bổ sung cho Chat, kích hoạt lệnh gọi lại Action. Mặc dù có tên như vậy, nhưng tải trọng này được điền sẵn cho tất cả lệnh gọi lại Action của thẻ và hộp thoại, bao gồm cả lượt nhấp vào nút, trình kích hoạt onChangeAction, hành động onClick, lượt nhấp CardAction và việc gửi hoặc huỷ hộp thoại (SUBMIT_DIALOG và CANCEL_DIALOG).

Nếu người dùng tương tác với một hộp thoại, thì trường isDialogEvent của ButtonClickedPayload sẽ được đặt thành true và bao gồm DialogEventType. Trọng tải này liên kết với các loại sự kiện SUBMIT_FORM và CARD_CLICKED cho các ứng dụng Chat không phải là tiện ích bổ sung.

Trọng tải hoàn chỉnh cũng bao gồm CommonEventObject.form_inputs và CommonEventObject.parameters.

Biểu diễn dưới dạng JSON
{
  "space": {
    object (Space)
  },
  "message": {
    object (Message)
  },
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType)
}
Trường
space

object (Space)

Bắt buộc. Phòng Chat nơi đối tượng sự kiện xảy ra.

message

object (Message)

Thông báo kích hoạt đối tượng sự kiện.

isDialogEvent

boolean

Đối với đối tượng sự kiện ButtonClicked và Message, cho biết người dùng có đang tương tác hoặc sắp tương tác với một hộp thoại hay không.

dialogEventType

enum (DialogEventType)

Loại đối tượng sự kiện hộp thoại nhận được.

DialogEventType

Đối với các đối tượng sự kiện chứa tải trọng sự kiện ButtonClicked hoặc AppCommand, đây là các loại hoạt động tương tác với hộp thoại.

Để tìm hiểu thêm về đối tượng sự kiện của ứng dụng Google Chat, hãy xem bài viết Nhận và phản hồi các hoạt động tương tác với ứng dụng Google Chat.

Enum
DIALOG_EVENT_TYPE_UNSPECIFIED Giá trị mặc định. Không xác định.
REQUEST_DIALOG Người dùng mở một hộp thoại.
SUBMIT_DIALOG Người dùng nhấp vào một thành phần tương tác của hộp thoại. Ví dụ: người dùng điền thông tin vào hộp thoại rồi nhấp vào một nút để gửi thông tin.
CANCEL_DIALOG Người dùng đóng hộp thoại mà không gửi thông tin hoặc hộp thoại bị huỷ.

WidgetUpdatedPayload

Người dùng cập nhật một tiện ích trong thẻ hoặc hộp thoại trong luồng.

Trọng tải hoàn chỉnh cũng bao gồm CommonEventObject.parameters['autocomplete_widget_query'].

Biểu diễn dưới dạng JSON
{
  "space": {
    object (Space)
  }
}
Trường
space

object (Space)

Bắt buộc. Phòng Chat nơi đối tượng sự kiện xảy ra.

AppCommandPayload

Người dùng gọi một lệnh ứng dụng.

Biểu diễn dưới dạng JSON
{
  "appCommandMetadata": {
    object (AppCommandMetadata)
  },
  "space": {
    object (Space)
  },
  "thread": {
    object (Thread)
  },
  "message": {
    object (Message)
  },
  "configCompleteRedirectUri": string,
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType)
}
Trường
appCommandMetadata

object (AppCommandMetadata)

Được điền sẵn cho các lệnh trong ứng dụng, bao gồm cả lệnh dấu gạch chéo và lệnh nhanh.

space

object (Space)

Không bắt buộc. Phòng Chat nơi đối tượng sự kiện xảy ra.

thread

object (Thread)

Không bắt buộc. Chuỗi tin nhắn nơi đối tượng sự kiện xảy ra, nếu có. Trường này được điền sẵn nếu đối tượng sự kiện được liên kết với một thư hoặc chuỗi thư cụ thể.

message

object (Message)

Không bắt buộc. Tin nhắn kích hoạt đối tượng sự kiện (nếu có). Trường này chỉ được điền sẵn cho lệnh dấu gạch chéo.

configCompleteRedirectUri

string

Không bắt buộc. URL mà người dùng sẽ được chuyển hướng đến sau khi hoàn tất quy trình uỷ quyền hoặc định cấu hình bên ngoài Google Chat. Để biết thêm thông tin, hãy xem bài viết Kết nối ứng dụng Chat với các dịch vụ và công cụ khác.

isDialogEvent

boolean

Không bắt buộc. Liệu người dùng có đang tương tác hoặc sắp tương tác với một hộp thoại hay không.

dialogEventType

enum (DialogEventType)

Không bắt buộc. Loại đối tượng sự kiện hộp thoại nhận được. Trường này chỉ áp dụng nếu isDialogEvent là true.

AppCommandMetadata

Siêu dữ liệu về lệnh của ứng dụng Chat.

Biểu diễn dưới dạng JSON
{
  "appCommandId": integer,
  "appCommandType": enum (AppCommandType)
}
Trường
appCommandId

integer

Mã nhận dạng của lệnh được chỉ định trong cấu hình API Chat.

appCommandType

enum (AppCommandType)

Loại lệnh của ứng dụng Chat.

AppCommandType

Loại lệnh của ứng dụng Chat. Để biết thông tin chi tiết, hãy xem bài viết Các loại lệnh của ứng dụng Chat.

Enum
APP_COMMAND_TYPE_UNSPECIFIED Giá trị mặc định. Không xác định.
SLASH_COMMAND Lệnh dấu gạch chéo. Người dùng gửi lệnh trong tin nhắn trò chuyện.
QUICK_COMMAND Một lệnh nhanh. Người dùng chọn lệnh trong trình đơn Chat ở khu vực trả lời tin nhắn.
MESSAGE_ACTION Thao tác đối với tin nhắn. Người dùng chọn lệnh trong trình đơn theo bối cảnh của tin nhắn trong Chat.

SystemCommandPayload

Người dùng gọi một lệnh hệ thống.

Biểu diễn dưới dạng JSON
{
  "systemCommandMetadata": {
    object (SystemCommandMetadata)
  },
  "space": string,
  "thread": {
    object (Thread)
  }
}
Trường
systemCommandMetadata

object (SystemCommandMetadata)

Siêu dữ liệu về lệnh hệ thống đã được gọi.

space

string

Không bắt buộc. Phòng Chat nơi đối tượng sự kiện xảy ra.

thread

object (Thread)

Không bắt buộc. Chuỗi tin nhắn nơi đối tượng sự kiện xảy ra, nếu có. Trường này được điền sẵn nếu đối tượng sự kiện được liên kết với một thư hoặc chuỗi thư cụ thể.

SystemCommandMetadata

Siêu dữ liệu về lệnh hệ thống do người dùng kích hoạt.

Biểu diễn dưới dạng 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.
}
Trường
Lệnh hệ thống được gọi. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
cancelStream

object (CancelStream)

Lệnh huỷ tin nhắn trong luồng đang hoạt động.

Kết thúc các trường loại trừ lẫn nhau.

CancelStream

Lệnh huỷ một tin nhắn trong luồng đang hoạt động.

Biểu diễn dưới dạng JSON
{
  "streamMessage": string
}
Trường
streamMessage

string

Bắt buộc. Tên tài nguyên của thông báo luồng mà lệnh huỷ được thực hiện.

Định dạng spaces/{space}/streamMessages/{streamMessage}

WorkflowEventObject

LINT.IfChange Đối tượng sự kiện được truyền đến tiện ích bổ sung của Quy trình công việc.

Biểu diễn dưới dạng 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.
}
Trường
executionMetadata

object (ExecutionMetadata)

Siêu dữ liệu về việc thực thi quy trình công việc.

triggerEventSource

enum (TriggerEventSource)

Nguồn của sự kiện kích hoạt.

Loại tải trọng sự kiện của quy trình công việc. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
actionInvocation

object (ActionInvocation)

Gọi một hành động trong quy trình công việc.

triggerCreation

object (TriggerCreation)

Tạo điều kiện kích hoạt quy trình công việc.

triggerDeletion

object (TriggerDeletion)

Xoá điều kiện kích hoạt quy trình công việc.

resourceRetrieval

object (ResourceRetrieval)

Truy xuất tài nguyên (dùng để tăng cường biến).

elementConfiguration

object (ElementConfiguration)

Cấu hình của một phần tử quy trình công việc.

resourceFieldsDefinitionRetrieval

object (ResourceFieldsDefinitionRetrieval)

Việc truy xuất các định nghĩa trường được một tài nguyên hỗ trợ.

elementUiAutocomplete

object (ElementUiAutocomplete)

Đề xuất tự động hoàn thành cho thẻ hiện được hiển thị.

Kết thúc các trường loại trừ lẫn nhau.

ActionInvocation

Gọi một hành động trong quy trình công việc.

Biểu diễn dưới dạng JSON
{
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "triggerId": string,
  "flowLevelContext": {
    object (FlowLevelContext)
  }
}
Trường
inputs

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

Bản đồ của các biến đầu vào được khoá theo tên biến đầu vào.

Một đối tượng chứa danh sách các cặp "key": value. Ví dụ: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

triggerId

string

Mã điều kiện kích hoạt để sử dụng cho các phản hồi hành động không đồng bộ.

flowLevelContext

object (FlowLevelContext)

Không bắt buộc. Bối cảnh ở cấp quy trình từ các bước trước.

VariableData

Biểu thị dữ liệu biến, có thể chứa nhiều giá trị thuộc nhiều loại.

Biểu diễn dưới dạng JSON
{
  "booleanValues": [
    boolean
  ],
  "integerValues": [
    string
  ],
  "floatValues": [
    number
  ],
  "stringValues": [
    string
  ],
  "timestampValues": [
    string
  ],
  "resourceReferences": [
    {
      object (ResourceReference)
    }
  ],
  "emailAddressValues": [
    string
  ],
  "googleUserValues": [
    string
  ],
  "textFormatValues": [
    {
      object (WorkflowTextFormat)
    }
  ]
}
Trường
booleanValues[]

boolean

Giá trị boolean.

integerValues[]

string (int64 format)

Giá trị số nguyên.

floatValues[]

number

Giá trị số thực.

stringValues[]

string

Các giá trị chuỗi.

timestampValues[]

string (Timestamp format)

Giá trị dấu thời gian.

Hãy dùng RFC 3339, trong đó dữ liệu đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các khoảng lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".

resourceReferences[]

object (ResourceReference)

Mã tham chiếu tài nguyên (mã nhận dạng).

emailAddressValues[]

string

Giá trị địa chỉ email.

googleUserValues[]

string

Giá trị người dùng của Google ở định dạng users/{user}.

textFormatValues[]

object (WorkflowTextFormat)

Giá trị Định dạng văn bản của quy trình công việc.

ResourceReference

Giá trị mã nhận dạng của tài nguyên dành riêng cho ứng dụng.

Biểu diễn dưới dạng JSON
{
  "resourceType": {
    object (ResourceType)
  },
  "resourceId": string
}
Trường
resourceType

object (ResourceType)

Loại tài nguyên mà mã nhận dạng này trỏ đến.

resourceId

string

Mã nhận dạng của tài nguyên.

ResourceType

Tên của loại tài nguyên tuỳ chỉnh.

Biểu diễn dưới dạng JSON
{
  "workflowBundleId": string,
  "workflowResourceDefinitionId": string
}
Trường
workflowBundleId

string

Mã nhận dạng của gói quy trình công việc sở hữu loại tài nguyên này. Đây là thuộc tính không bắt buộc và nếu để trống, thì thuộc tính này được coi là cùng một gói đang được sử dụng.

workflowResourceDefinitionId

string

Giá trị nhận dạng riêng biệt của tài nguyên. Mã này chỉ cần là duy nhất trong cùng một gói.

WorkflowTextFormat

Một khối văn bản có các lựa chọn định dạng đa dạng, bao gồm kiểu, siêu liên kết và các thành phần tương tác.

Biểu diễn dưới dạng JSON
{
  "textFormatElements": [
    {
      object (TextFormatElement)
    }
  ]
}
Trường
textFormatElements[]

object (TextFormatElement)

Tập hợp các phần tử định dạng văn bản.

TextFormatElement

Một phần tử duy nhất trong thông báo WorkflowTextFormat, có thể là khối, văn bản được định kiểu, siêu liên kết hoặc vùng chứa danh sách.

Biểu diễn dưới dạng 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.
}
Trường
Phần tử đại diện cho một trong số các phần tử định dạng văn bản có thể có. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
text

string

Văn bản ở định dạng văn bản.

chip

object (Chip)

Khối có thể nhấp ở định dạng văn bản.

styledText

object (StyledText)

Văn bản được tạo kiểu ở định dạng văn bản.

listContainer

object (ListContainer)

Vùng chứa danh sách ở định dạng văn bản.

Kết thúc các trường loại trừ lẫn nhau.

Khối

Một khối có thể nhấp ở định dạng văn bản.

Biểu diễn dưới dạng JSON
{
  "icon": {
    object (Icon)
  },
  "label": string,
  "url": string
}
Trường
icon

object (Icon)

Biểu tượng xuất hiện trong khối.

label

string

Văn bản xuất hiện trong khối.

url

string

URL để chuyển đến khi người dùng nhấp vào khối.

Biểu tượng

Biểu tượng trong khối.

Biểu diễn dưới dạng 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.
}
Trường
Biểu tượng xuất hiện trong khối. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
iconUrl

string

Hiển thị biểu tượng tuỳ chỉnh được lưu trữ tại một URL loại HTTPS.

Ví dụ:

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

Các loại tệp được hỗ trợ bao gồm .png và .jpg.

materialIconName

string

Tên biểu tượng được xác định trong Biểu tượng Material của Google, ví dụ: check_box. Mọi tên không hợp lệ đều bị bỏ qua và thay thế bằng chuỗi trống, dẫn đến việc biểu tượng không hiển thị được.

Kết thúc các trường loại trừ lẫn nhau.

StyledText

Phần tử văn bản có các kiểu như in đậm, in nghiêng và màu sắc.

Biểu diễn dưới dạng JSON
{
  "text": string,
  "styles": [
    enum (Style)
  ],
  "fontWeight": enum (FontWeight),
  "color": {
    object (Color)
  },
  "wrapStyle": enum (WrapStyle)
}
Trường
text

string

Nội dung chính của văn bản.

styles[]

enum (Style)

Một tập hợp các kiểu được áp dụng cho văn bản.

fontWeight

enum (FontWeight)

Độ đậm phông chữ của văn bản.

color

object (Color)

Màu sắc của văn bản.

wrapStyle

enum (WrapStyle)

Kiểu xuống dòng của văn bản.

Kiểu

Enum cho các kiểu văn bản khác nhau như in nghiêng, gạch chân, v.v.

Enum
STYLE_UNSPECIFIED Chưa áp dụng kiểu nào. DO NOT USE.
ITALIC Kiểu Nghiêng.
UNDERLINE Kiểu gạch dưới.
STRIKETHROUGH Kiểu gạch ngang chữ.
LINE_BREAK Ngắt dòng.
UPPERCASE Kiểu Chữ hoa.
CODE Mã.
CODE_BLOCK Khối mã.

FontWeight

Enum cho các độ đậm phông chữ khác nhau.

Enum
FONT_WEIGHT_UNSPECIFIED Trọng lượng tiêu chuẩn với độ dày bình thường. DO NOT USE.
LIGHT Nhẹ hơn và mỏng hơn.
MEDIUM Độ đậm trung gian giữa sáng và đậm.
BOLD Nặng hơn và dày hơn.

WrapStyle

Enum cho các kiểu xuống dòng khác nhau.

Enum
WRAP_STYLE_UNSPECIFIED Chưa chỉ định kiểu xuống dòng.
NO_WRAP Không có kiểu xuống dòng.

ListContainer

Vùng chứa cho các mục trong danh sách, trong đó mỗi mục trong danh sách có thể chứa nhiều TextFormatElement.

Biểu diễn dưới dạng JSON
{
  "listNestLevel": string,
  "listType": enum (ListType),
  "listItems": [
    {
      object (ListItem)
    }
  ]
}
Trường
listNestLevel

string (int64 format)

Cấp lồng ghép của danh sách. Bắt đầu từ 0 cho cấp cao nhất và tăng thêm 1 cho mỗi danh sách lồng nhau.

listType

enum (ListType)

Loại danh sách.

listItems[]

object (ListItem)

Một tập hợp các mục trong danh sách.

ListType

Enum cho các loại danh sách khác nhau.

Enum
LIST_TYPE_UNSPECIFIED Chưa chỉ định loại danh sách. DO NOT USE.
ORDERED Danh sách theo thứ tự.
UNORDERED Danh sách không theo thứ tự.
BLOCKQUOTE Đại diện cho danh sách trích dẫn khối.

ListItem

Một mục trong danh sách.

Biểu diễn dưới dạng JSON
{
  "textFormatElements": [
    {
      object (TextFormatElement)
    }
  ]
}
Trường
textFormatElements[]

object (TextFormatElement)

Tập hợp các phần tử định dạng văn bản.

FlowLevelContext

Bối cảnh ở cấp quy trình chứa kết quả đầu ra từ các bước trước.

Biểu diễn dưới dạng JSON
{
  "stepContexts": [
    {
      object (StepContext)
    }
  ]
}
Trường
stepContexts[]

object (StepContext)

Không bắt buộc. Danh sách các bước trước đó. Thứ tự rất quan trọng, vì vậy, hãy đảm bảo thứ tự thực thi được duy trì trong danh sách này.

StepContext

Siêu dữ liệu và kết quả đầu ra của bối cảnh bước cho bối cảnh cấp luồng.

Biểu diễn dưới dạng JSON
{
  "stepId": string,
  "outputs": {
    string: {
      object (VariableData)
    },
    ...
  }
}
Trường
stepId

string

Không bắt buộc. Mã nhận dạng duy nhất của bước trong biểu đồ quy trình công việc.

outputs

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

Không bắt buộc. Bản đồ các biến đầu ra do bước này tạo ra, được khoá theo tên biến.

Một đối tượng chứa danh sách các cặp "key": value. Ví dụ: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

TriggerCreation

Tạo điều kiện kích hoạt quy trình công việc.

Biểu diễn dưới dạng JSON
{
  "triggerId": string,
  "triggerType": enum (TriggerType),
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "notifyUri": string
}
Trường
triggerId

string

Giá trị nhận dạng riêng biệt của điều kiện kích hoạt được cung cấp trong quá trình tạo.

triggerType

enum (TriggerType)

Loại điều kiện kích hoạt.

inputs

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

Bản đồ của các biến đầu vào được khoá theo tên biến đầu vào.

Một đối tượng chứa danh sách các cặp "key": value. Ví dụ: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

notifyUri

string

Điểm cuối sẽ được gọi khi điều kiện kích hoạt được kích hoạt.

TriggerType

Loại điều kiện kích hoạt.

Enum
TRIGGER_TYPE_UNDEFINED Giá trị mặc định. DO NOT USE.
REPEATING Trình kích hoạt sẽ kích hoạt mỗi khi các điều kiện đầu vào được đáp ứng.

TriggerDeletion

Xoá điều kiện kích hoạt quy trình công việc.

Biểu diễn dưới dạng JSON
{
  "triggerId": string
}
Trường
triggerId

string

Giá trị nhận dạng riêng biệt của điều kiện kích hoạt được cung cấp trong quá trình tạo.

ResourceRetrieval

Truy xuất tài nguyên.

Biểu diễn dưới dạng JSON
{
  "resourceReference": {
    object (ResourceReference)
  }
}
Trường
resourceReference

object (ResourceReference)

Loại và mã nhận dạng của tài nguyên cần truy xuất.

ElementConfiguration

Lệnh gọi khi định cấu hình một phần tử quy trình công việc.

Biểu diễn dưới dạng JSON
{
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "displayDestination": enum (DisplayDestination),
  "nodeId": string,
  "workflowId": string,
  "availableVariables": [
    {
      object (VariableReference)
    }
  ]
}
Trường
inputs

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

Bản đồ của các biến đầu vào được khoá theo tên biến đầu vào. Bản đồ này có thể trống. Được dùng khi định cấu hình một phần tử quy trình công việc (điều kiện kích hoạt hoặc hành động) trong trang chủ quy trình công việc.

Một đối tượng chứa danh sách các cặp "key": value. Ví dụ: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

displayDestination

enum (DisplayDestination)

Đích đến của thẻ cấu hình phần tử. Các phần tử có thể sử dụng trường này để trả về các bố cục thẻ cấu hình khác nhau dựa trên đích đến.

nodeId

string

Mã nút của cấu hình gốc đang được hiển thị.

workflowId

string

Mã quy trình công việc của cấu hình gốc đang được hiển thị.

availableVariables[]

object (VariableReference)

Các biến có sẵn được sắp xếp theo vị trí nút.

DisplayDestination

Cho biết vị trí hiển thị thẻ cấu hình phần tử trả về.

Enum
DISPLAY_DESTINATION_UNSPECIFIED Giá trị mặc định. DO NOT USE.
DISPLAY_DESTINATION_SIDE_PANEL Thẻ cấu hình sẽ xuất hiện trong Bảng điều khiển bên.
DISPLAY_DESTINATION_FULL_SCREEN Thẻ cấu hình sẽ xuất hiện trong ứng dụng Toàn màn hình.

VariableReference

Tham chiếu biến đến một biến trong quy trình công việc.

Biểu diễn dưới dạng JSON
{
  "parentElementId": string,
  "nodeId": string,
  "path": string,
  "dataType": {
    object (DataType)
  },
  "iconUrl": string,
  "stepNumber": integer,
  "descriptionText": string,
  "displayText": string
}
Trường
parentElementId

string

Mã gốc của phần tử tạo ra biến. Chúng ta có thể mở rộng mã này thành WorkflowElement hoặc một proto siêu dữ liệu chi tiết hơn nếu cần.

nodeId

string

Mã tham chiếu nút

path

string

Chữ ký đường dẫn của bộ chọn biến

dataType

object (DataType)

Kiểu dữ liệu của biến

iconUrl

string

URL biểu tượng của thành phần gốc tạo ra biến này.

stepNumber

integer

Số bước của dữ liệu gốc tạo ra biến này.

descriptionText

string

Nội dung mô tả biến.

displayText

string

Văn bản hiển thị của khối chứa biến.

DataType

Loại biến.

Biểu diễn dưới dạng 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.
}
Trường
valueMetadata

object (ValueMetadata)

Siêu dữ liệu về các giá trị tiềm năng của một biến.

Loại dữ liệu. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
basicType

enum (BasicType)

Loại dữ liệu cơ bản.

resourceType

object (ResourceType)

Loại mã nhận dạng tài nguyên của ứng dụng.

Kết thúc các trường loại trừ lẫn nhau.

BasicType

Kiểu dữ liệu chung cơ bản.

Enum
BASIC_TYPE_UNSPECIFIED Giá trị mặc định. DO NOT USE.
STRING Một chuỗi ký tự.
INTEGER Một số nguyên.
FLOAT Số có dấu phẩy động.
TIMESTAMP Dấu thời gian ở định dạng ISO 8601.
BOOLEAN Một giá trị có thể là đúng hoặc sai.
EMAIL_ADDRESS Địa chỉ email, là một chuỗi có định dạng của địa chỉ email.
GOOGLE_USER Người dùng các dịch vụ của Google, theo định dạng users/{user}.
FILE Tệp đối chiếu.
FORMATTED_TEXT Văn bản có định dạng đa dạng thức.

ValueMetadata

Thông tin về các giá trị có thể có của một biến.

Biểu diễn dưới dạng JSON
{
  "enumValues": [
    string
  ],
  "dynamicTypes": [
    enum (BasicType)
  ],
  "semanticDescriptors": [
    {
      object (SemanticDescriptor)
    }
  ],
  "dynamicSchema": {
    object (DynamicSchema)
  },
  "defaultValue": string
}
Trường
enumValues[]

string

Không bắt buộc. Chỉ định các giá trị được phép cho một chuỗi. Bạn chỉ có thể đặt giá trị này nếu DataType là STRING.

dynamicTypes[]

enum (BasicType)

Không bắt buộc. Chỉ định các loại được phép có thể truyền động cho một biến. Bạn chỉ có thể đặt giá trị này nếu DataType là Chuỗi và biến là kết quả đầu ra.

semanticDescriptors[]

object (SemanticDescriptor)

Không bắt buộc. Giúp mô tả ý nghĩa ngữ nghĩa của một biến.

dynamicSchema

object (DynamicSchema)

Không bắt buộc. Cấu hình để phân giải giản đồ của biến này một cách linh động.

defaultValue

string

Không bắt buộc. Chuỗi chỉ định giá trị mặc định cho biến này. Ví dụ: đối với boolean, defaultValue có thể được đặt thành true hoặc false.

SemanticDescriptor

Siêu dữ liệu về ý nghĩa ngữ nghĩa của một biến.

Biểu diễn dưới dạng JSON
{
  "resourceAttribute": string,
  "disallowedResourceAttributes": [
    string
  ]
}
Trường
resourceAttribute

string

Cho biết biến tương ứng với một thuộc tính cụ thể của tài nguyên. Điều này đặc biệt hữu ích cho các biến đại diện cho giá trị nhận dạng của một tài nguyên (mã nhận dạng, URL, khoá, v.v.).

Định dạng nên dùng là: – "{brand}/{appName}/{resource}:{attribute}" {brand} là không bắt buộc và nên bỏ qua nếu giống với {appName}.

Ví dụ: – "google/drive/file:id" – "google/drive/folder:id" – "google/docs/document:id" – "google/sheets/spreadsheet:id" – "jira/issue:key" – "slack/channel:id", v.v.

Ứng dụng khách sẽ sử dụng thông tin này để gợi ý cho người dùng về những biến đầu ra tương thích với một dữ liệu đầu vào nhất định.

disallowedResourceAttributes[]

string

Không bắt buộc. Chỉ áp dụng cho dữ liệu đầu vào và bị bỏ qua đối với dữ liệu đầu ra. Các thuộc tính không được phép tương ứng với chỉ báo ngữ nghĩa này. Ứng dụng sẽ ngăn chặn rõ ràng việc lựa chọn biến cho các kết quả đầu ra tương ứng với bất kỳ thuộc tính tài nguyên nào không được phép.

DynamicSchema

Cấu hình để phân giải động giản đồ của biến này trong thời gian chạy.

Biểu diễn dưới dạng JSON
{
  "requiredInputIds": [
    string
  ],
  "strictEnum": boolean
}
Trường
requiredInputIds[]

string

Mã nhận dạng của các biến đầu vào đồng cấp phải được cung cấp trước khi giản đồ của biến này có thể được phân giải linh động.

strictEnum

boolean

Khi đúng, giá trị của biến phải khớp với một trong các giá trị enum được phân giải động. Khi giá trị là false, các giá trị được phân giải linh động sẽ được coi là đề xuất không nghiêm ngặt.

ResourceFieldsDefinitionRetrieval

Truy xuất định nghĩa của các trường mà một tài nguyên hỗ trợ.

Biểu diễn dưới dạng JSON
{
  "elementId": string,
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  }
}
Trường
elementId

string

Chỉ định mã nhận dạng của phần tử có giản đồ tài nguyên động cần tìm nạp.

inputs

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

Thông tin này bao gồm dữ liệu đầu vào của trường của nút cung cấp biến. Bản đồ của các biến đầu vào được khoá theo tên biến đầu vào.

Một đối tượng chứa danh sách các cặp "key": value. Ví dụ: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

ElementUiAutocomplete

Đề xuất tự động hoàn thành cho thẻ hiện được hiển thị.

Biểu diễn dưới dạng JSON
{
  "query": string,
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "invokedFunction": string,
  "resourceId": string,
  "operationId": string
}
Trường
query

string

Cụm từ tìm kiếm cần tự động hoàn thành.

inputs

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

Bản đồ của các biến đầu vào được khoá theo tên biến đầu vào.

Một đối tượng chứa danh sách các cặp "key": value. Ví dụ: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

invokedFunction

string

Hàm được gọi liên kết với tiện ích.

resourceId

string

Mã tài nguyên cần được tự động hoàn thành. Đây là trường tuỳ chọn và có thể không được đặt.

operationId

string

Mã nhận dạng của thao tác cung cấp tài nguyên cần tự động hoàn thành. Đây là trường tuỳ chọn và có thể không được đặt.

ExecutionMetadata

Siêu dữ liệu về việc thực thi quy trình công việc.

Biểu diễn dưới dạng JSON
{
  "versionId": integer,
  "timeZone": string,
  "stepNumber": integer
}
Trường
versionId

integer

Phiên bản của phần tử quy trình công việc đang được gọi.

timeZone

string

Múi giờ của quy trình công việc đang được lưu, ví dụ: "America/Los_Angeles".

stepNumber

integer

Biểu thị số bước của dữ liệu gốc đang được gọi.

TriggerEventSource

Nguồn của sự kiện kích hoạt đã kích hoạt lần thực thi này.

Enum
TRIGGER_EVENT_SOURCE_UNSPECIFIED Giá trị mặc định. DO NOT USE.
TRIGGER_EVENT_SOURCE_AUTOMATED Quá trình thực thi được kích hoạt tự động theo sự kiện.
TRIGGER_EVENT_SOURCE_TEST_RUN Quá trình thực thi được kích hoạt thông qua lượt chạy thử nghiệm.