- EventObject
- CommonEventObject
- HostApp
- 플랫폼
- TimeZone
- 입력
- StringInputs
- DateTimeInput
- DateInput
- TimeInput
- AuthorizationEventObject
- CalendarEventObject
- 주최자
- 참석자
- ConferenceData
- ConferenceSolution
- 키
- EntryPoint
- 매개변수
- AddOnParameters
- 기능
- DriveEventObject
- DriveItemMetadata
- GmailEventObject
- SheetsEventObject
- MatchedUrl
- SlidesEventObject
- DocsEventObject
- ChatEventObject
- EventType
- MessagePayload
- AddedToSpacePayload
- RemovedFromSpacePayload
- ButtonClickedPayload
- DialogEventType
- WidgetUpdatedPayload
- AppCommandPayload
- AppCommandMetadata
- AppCommandType
- SystemCommandPayload
- SystemCommandMetadata
- CancelStream
- WorkflowEventObject
- ActionInvocation
- VariableData
- ResourceReference
- ResourceType
- WorkflowTextFormat
- TextFormatElement
- 칩
- 아이콘
- StyledText
- 스타일
- FontWeight
- WrapStyle
- Hyperlink
- ListContainer
- ListType
- ListItem
- FlowLevelContext
- StepContext
- TriggerCreation
- TriggerType
- TriggerDeletion
- ResourceRetrieval
- ElementConfiguration
- DisplayDestination
- VariableReference
- DataType
- BasicType
- ValueMetadata
- SemanticDescriptor
- DynamicSchema
- ResourceFieldsDefinitionRetrieval
- ElementUiAutocomplete
- ExecutionMetadata
- TriggerEventSource
EventObject
호스트 앱 내에서 사용자가 부가기능과 상호작용한 데이터가 포함된 Google 부가기능 상호작용 이벤트입니다.
이벤트 객체는 사용자가 호스트 앱 내에서 부가기능과 상호작용할 때 부가기능의 콜백 함수 또는 트리거(Apps Script의 경우) 또는 https 엔드포인트(HTTP의 경우)에 JSON으로 전달됩니다. 이벤트 객체는 각 호스트 앱에서 정의한 호스트 앱 이벤트 객체와 이벤트와 관련된 몇 가지 공통 필드가 포함된 공통 이벤트 객체를 저장합니다.
자세한 내용은 이벤트 객체를 참고하세요.
| JSON 표현 |
|---|
{ "commonEventObject": { object ( |
| 필드 | |
|---|---|
commonEventObject |
호스트 애플리케이션과 관계없이 모든 이벤트 객체에 공통적인 정보가 포함된 객체입니다. |
authorizationEventObject |
HTTP 엔드포인트에 대한 요청에만 설정됩니다. |
| 다음은 상호 배타적인 필드 목록입니다. 응답에서 최대 하나의 필드가 설정됩니다. | |
calendar |
호출 호스트가 Google Calendar인 경우에만 표시됩니다. 캘린더 및 일정 정보가 포함된 객체입니다. |
drive |
호출 호스트가 Google Drive인 경우에만 표시됩니다. Drive 정보가 포함된 객체입니다. |
gmail |
호출 호스트가 Gmail인 경우에만 표시됩니다. Gmail 정보가 포함된 객체입니다. |
sheets |
호출 호스트가 Google Sheets인 경우에만 표시됩니다. 시트 정보가 포함된 객체입니다. |
slides |
호출 호스트가 Google Slides인 경우에만 표시됩니다. 슬라이드 정보가 포함된 객체입니다. |
docs |
호출 호스트가 Google Docs인 경우에만 표시됩니다. Docs 정보가 포함된 객체입니다. |
chat |
호출 호스트가 Google Chat인 경우에만 표시됩니다. 채팅 정보가 포함된 객체입니다. |
workflow |
호출 호스트가 Google Workspace Studio인 경우에만 표시됩니다. 워크플로 정보가 포함된 객체입니다. |
| 상호 배타적 필드의 끝입니다. | |
CommonEventObject
공통 이벤트 객체는 사용자의 클라이언트에서 부가기능으로 호스트와 무관한 일반 정보를 전달하는 전체 이벤트 객체의 일부입니다. 이 정보에는 사용자의 언어, 호스트 앱, 플랫폼과 같은 세부정보가 포함됩니다.
홈페이지 및 문맥 트리거 외에도 부가기능은 사용자가 위젯과 상호작용할 때 이벤트 객체를 구성하고 작업 콜백 함수에 전달합니다. 부가기능의 콜백 함수는 공통 이벤트 객체를 쿼리하여 사용자 클라이언트에서 열린 위젯의 콘텐츠를 확인할 수 있습니다. 예를 들어 부가기능은 사용자가 eventObject.commentEventObject.formInputs 객체의 TextInput 위젯에 입력한 텍스트를 찾을 수 있습니다.
Chat 앱의 경우 사용자가 위젯과 상호작용할 때 호출한 함수의 이름입니다.
| JSON 표현 |
|---|
{ "userLocale": string, "hostApp": enum ( |
| 필드 | |
|---|---|
userLocale |
기본적으로 사용 중지되어 있습니다. ISO 639 언어 코드-ISO 3166 국가/지역 코드 형식의 사용자 언어 및 국가/지역 식별자입니다. 예를 들면 이 필드를 사용 설정하려면 부가기능의 매니페스트에서 |
hostApp |
이벤트 객체가 생성될 때 부가기능이 활성화된 호스트 앱을 나타냅니다. 가능한 값은 다음과 같습니다.
|
platform |
이벤트가 발생한 플랫폼을 나타내는 플랫폼 enum입니다( |
timeZone |
기본적으로 사용 중지되어 있습니다. 시간대 ID 및 협정 세계시(UTC) 기준 오프셋입니다. 이 필드를 사용 설정하려면 부가기능의 매니페스트에서 이벤트 유형 |
formInputs |
표시된 카드의 위젯 현재 값이 포함된 맵입니다. 맵 키는 각 입력 위젯(예: 지도 값 객체의 구조는 위젯 유형에 따라 다릅니다. 참고: 다음 예시는 Apps Script의 V8 런타임에 맞게 형식이 지정되어 있습니다. Rhino 런타임을 사용하는 경우 값 뒤에
예:
예:
예:
예:
예:
|
parameters |
개발자 프리뷰: Google Chat을 확장하는 부가기능의 경우 사용자가 다중 선택 메뉴에 입력하는 내용을 기반으로 항목을 추천하려면
|
invokedFunction |
호출할 함수의 이름입니다. Google Chat을 확장하는 Google Workspace 부가기능에는 이 필드가 채워지지 않습니다. 대신 식별자와 같은 함수 데이터를 수신하려면 Chat을 확장하는 부가기능에서 |
HostApp
Google Workspace 부가기능 또는 Google Chat 앱의 Google Workspace 애플리케이션입니다.
부가기능의 경우 Google Workspace 부가기능이 실행되는 Workspace 애플리케이션입니다. 채팅 앱의 경우 호스트 앱은 항상 CHAT입니다.
| 열거형 | |
|---|---|
UNSPECIFIED_HOST_APP |
Google에서 호스트 앱을 식별할 수 없습니다. |
GMAIL |
부가기능이 Gmail에서 실행됩니다. |
CALENDAR |
부가기능은 Google Calendar에서 실행됩니다. |
DRIVE |
부가기능은 Google Drive에서 실행됩니다. |
DEMO |
사용되지 않음. |
DOCS |
부가기능이 Google Docs에서 실행됩니다. |
MEET |
부가기능은 Google Meet에서 실행됩니다. |
SHEETS |
부가기능은 Google Sheets에서 실행됩니다. |
SLIDES |
부가기능은 Google Slides에서 실행됩니다. |
DRAWINGS |
부가기능은 Google Drawings에서 실행됩니다. |
CHAT |
Google Chat 앱 |
플랫폼
이 통화가 시작된 플랫폼을 식별합니다.
| 열거형 | |
|---|---|
UNKNOWN_PLATFORM |
|
WEB |
|
IOS |
|
ANDROID |
|
TimeZone
시간대 ID 및 협정 세계시(UTC) 기준 오프셋입니다. 이벤트 유형 CARD_CLICKED 및 SUBMIT_DIALOG에만 지원됩니다.
| JSON 표현 |
|---|
{ "id": string, "offset": integer } |
| 필드 | |
|---|---|
id |
IANA TZ 시간대 데이터베이스 코드입니다(예: 'America/Toronto'). |
offset |
협정 세계시(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 |
날짜와 시간을 모두 허용하는 |
dateInput |
날짜 값만 허용하는 |
timeInput |
시간 값만 허용하는 |
| 상호 배타적 필드의 끝입니다. | |
StringInputs
일반 위젯의 입력 매개변수입니다. 단일 값 위젯의 경우 단일 값 목록입니다. 체크박스와 같은 다중 값 위젯의 경우 모든 값이 표시됩니다.
| JSON 표현 |
|---|
{ "value": [ string ] } |
| 필드 | |
|---|---|
value[] |
사용자가 입력한 문자열 목록입니다. |
DateTimeInput
날짜 및 시간 입력 값입니다.
| JSON 표현 |
|---|
{ "msSinceEpoch": string, "hasDate": boolean, "hasTime": boolean } |
| 필드 | |
|---|---|
msSinceEpoch |
에포크 시간 이후의 시간(밀리초)입니다. |
hasDate |
|
hasTime |
|
DateInput
날짜 입력 값입니다.
| JSON 표현 |
|---|
{ "msSinceEpoch": string } |
| 필드 | |
|---|---|
msSinceEpoch |
에포크 시간 이후의 시간(밀리초)입니다. |
TimeInput
시간 입력 값입니다.
| JSON 표현 |
|---|
{ "hours": integer, "minutes": integer } |
| 필드 | |
|---|---|
hours |
24시간 형식의 시간입니다. |
minutes |
매시간의 분입니다. 유효한 값은 0~59입니다. |
AuthorizationEventObject
부가기능 요청의 승인 정보를 캡슐화합니다.
| JSON 표현 |
|---|
{ "userOAuthToken": string, "userIdToken": string, "systemIdToken": string, "authorizedScopes": [ string ] } |
| 필드 | |
|---|---|
userOAuthToken |
요청된 범위로 승인된 최종 사용자 OAuth 액세스 토큰입니다. (OAuth 동의 분리 후 최종 사용자 승인 범위로 승인됨) |
userIdToken |
적절한 ID 범위가 요청된 경우 최종 사용자 ID 토큰 |
systemIdToken |
이 배포의 G Suite 부가기능 서비스 계정의 ID 토큰 |
authorizedScopes[] |
사용자가 승인한 OAuth 범위 목록입니다. |
CalendarEventObject
Calendar 일정 객체는 사용자의 캘린더 및 캘린더 일정에 관한 정보를 전달하는 전체 일정 객체의 일부입니다. 호스트 애플리케이션이 Google Calendar인 경우에만 이벤트 객체에 표시됩니다.
다음 표에는 이벤트 객체의 calendar 필드에 있는 필드가 나와 있습니다. 사용자 생성 데이터로 표시된 필드는 데이터가 캘린더 일정에 있고 부가기능이 addOns.calendar.currentEventAccess 매니페스트 필드를 READ 또는 READ_WRITE로 설정한 경우에만 이벤트 객체에 표시됩니다.
| JSON 표현 |
|---|
{ "id": string, "recurringEventId": string, "calendarId": string, "organizer": { object ( |
| 필드 | |
|---|---|
id |
이벤트 ID입니다. |
recurringEventId |
반복 일정의 ID입니다. |
calendarId |
캘린더 ID입니다. |
organizer |
일정 주최자를 나타내는 객체입니다. |
attendees[] |
사용자 제작 데이터. 캘린더 일정 참석자 목록입니다. |
conferenceData |
사용자 제작 데이터. Google Meet 회의 세부정보와 같이 이 일정과 연결된 모든 회의 데이터를 나타내는 객체입니다. |
capabilities |
사용자 제작 데이터. 일정 정보를 보거나 업데이트하는 부가기능의 기능을 설명하는 객체입니다. |
주최자
| JSON 표현 |
|---|
{ "email": string } |
| 필드 | |
|---|---|
email |
일정 주최자의 이메일 주소입니다. |
참석자
참석자 객체에는 Google Calendar 일정의 개별 참석자에 관한 정보가 포함됩니다. 이 정보는 캘린더 일정에 데이터가 있고 부가기능이 addOns.calendar.currentEventAccess 매니페스트 필드를 READ 또는 READ_WRITE로 설정한 경우에만 이벤트 객체에 표시됩니다.
| JSON 표현 |
|---|
{ "email": string, "displayName": string, "organizer": boolean, "self": boolean, "resource": boolean, "optional": boolean, "responseStatus": string, "comment": string, "additionalGuests": integer } |
| 필드 | |
|---|---|
email |
참석자 이메일 주소입니다. |
displayName |
참석자 표시 이름입니다. |
organizer |
참석자가 이 일정의 주최자인 경우 true입니다. |
self |
이 참석자가 이 일정이 표시되는 캘린더를 나타내는 경우 true, 그렇지 않으면 false입니다. |
resource |
참석자가 회의실이나 장비와 같은 리소스를 나타내는 경우 true이고, 그렇지 않으면 false입니다. |
optional |
이 참석자의 참석 여부가 선택사항으로 표시된 경우 true이고, 그렇지 않으면 false입니다. |
responseStatus |
참석자의 응답 상태입니다. 가능한 값은 다음과 같습니다.
|
comment |
참석자의 응답 댓글입니다(있는 경우). |
additionalGuests |
참석자가 동반하겠다고 표시한 추가 참석자 수입니다. 기본값은 0입니다. |
ConferenceData
회의 데이터 객체에는 Google Calendar 일정에 연결된 회의에 관한 정보가 포함됩니다. Google 회의 솔루션(예: Google Meet) 또는 서드 파티 회의가 될 수 있습니다. 이 정보는 캘린더 일정에 데이터가 있고 부가기능이 addOns.calendar.currentEventAccess 매니페스트 필드를 READ 또는 READ_WRITE로 설정한 경우에만 이벤트 객체에 표시됩니다.
| JSON 표현 |
|---|
{ "conferenceId": string, "conferenceSolution": { object ( |
| 필드 | |
|---|---|
conferenceId |
회의 ID입니다. 이 ID는 애플리케이션이 회의를 추적할 수 있도록 하기 위한 것으로, 사용자에게 표시해서는 안 됩니다. |
conferenceSolution |
행아웃 또는 Google Meet과 같은 회의 솔루션을 나타내는 객체입니다. |
entryPoints[] |
URL 또는 전화번호와 같은 회의 진입점 목록입니다. |
notes |
사용자에게 표시할 회의에 관한 추가 메모(예: 도메인 관리자의 안내 또는 법적 고지)입니다. HTML을 포함할 수 있습니다. 최대 길이는 2,048자(영문 기준)입니다. |
parameters |
부가기능에서 사용할 정의된 매개변수 데이터의 맵이 포함된 객체입니다. |
ConferenceSolution
| JSON 표현 |
|---|
{
"iconUri": string,
"key": {
object ( |
| 필드 | |
|---|---|
iconUri |
이 회의 솔루션을 나타내는 사용자에게 표시되는 아이콘의 URI입니다. |
key |
이 일정의 회의 솔루션을 고유하게 식별하는 키입니다. |
name |
이 회의 솔루션의 사용자에게 표시되는 이름입니다(현지화되지 않음). |
키
| JSON 표현 |
|---|
{ "type": string } |
| 필드 | |
|---|---|
type |
회의 솔루션 유형입니다. 가능한 값은 다음과 같습니다.
|
EntryPoint
진입점 객체는 전화 또는 동영상과 같이 특정 회의에 액세스하는 설정된 수단에 관한 정보를 전달합니다. 이 정보는 캘린더 일정에 데이터가 있고 부가기능이 addOns.calendar.currentEventAccess 매니페스트 필드를 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 |
회의에 액세스하는 데 사용되는 액세스 코드입니다. 최대 길이는 128자(영문 기준)입니다. 회의 제공업체는 일반적으로 {accessCode, meetingCode, passcode, password, pin}의 하위 집합만 사용하여 회의에 대한 액세스 권한을 제공합니다. 회의 제공업체에서 사용하는 필드만 일치시키고 표시합니다. |
entryPointType |
진입점 유형입니다. 가능한 값은 다음과 같습니다.
|
label |
진입점 URI의 사용자에게 표시되는 라벨입니다(현지화되지 않음). |
meetingCode |
회의에 액세스하는 데 사용되는 회의 코드입니다. 최대 길이는 128자(영문 기준)입니다. 회의 제공업체는 일반적으로 {accessCode, meetingCode, passcode, password, pin}의 하위 집합만 사용하여 회의에 대한 액세스 권한을 제공합니다. 회의 제공업체에서 사용하는 필드만 일치시키고 표시합니다. |
passcode |
회의에 액세스하는 데 사용되는 비밀번호입니다. 최대 길이는 128자(영문 기준)입니다. 회의 제공업체는 일반적으로 {accessCode, meetingCode, passcode, password, pin}의 하위 집합만 사용하여 회의에 대한 액세스 권한을 제공합니다. 회의 제공업체에서 사용하는 필드만 일치시키고 표시합니다. |
password |
회의에 액세스하는 데 사용되는 비밀번호입니다. 최대 길이는 128자(영문 기준)입니다. 회의 제공업체는 일반적으로 {accessCode, meetingCode, passcode, password, pin}의 하위 집합만 사용하여 회의에 대한 액세스 권한을 제공합니다. 회의 제공업체에서 사용하는 필드만 일치시키고 표시합니다. |
pin |
회의에 액세스하는 데 사용되는 PIN입니다. 최대 길이는 128자(영문 기준)입니다. 회의 제공업체는 일반적으로 {accessCode, meetingCode, passcode, password, pin}의 하위 집합만 사용하여 회의에 대한 액세스 권한을 제공합니다. 회의 제공업체에서 사용하는 필드만 일치시키고 표시합니다. |
uri |
진입점의 URI입니다. 최대 길이는 1,300자(영문 기준)입니다. 형식은 진입점 유형에 따라 다릅니다.
|
regionCode |
전화번호의 지역 코드입니다. URI에 국가 코드가 포함되지 않은 경우 사용자에게 필요합니다. 값은 공개된 CLDR 지역 코드 목록을 기반으로 합니다. |
entryPointFeatures[] |
진입점의 기능입니다. 현재 이러한 기능은 전화 진입점에만 적용됩니다.
|
매개변수
| JSON 표현 |
|---|
{
"addOnParameters": {
object ( |
| 필드 | |
|---|---|
addOnParameters |
매개변수 문자열 키와 값의 맵입니다. 이러한 키와 값은 부가기능 개발자가 부가기능 사용을 위해 특정 회의에 정보를 연결하기 위해 정의합니다. |
AddOnParameters
| JSON 표현 |
|---|
{ "parameters": { string: string, ... } } |
| 필드 | |
|---|---|
parameters |
|
기능
| JSON 표현 |
|---|
{ "canSeeAttendees": boolean, "canAddAttendees": boolean, "canSeeConferenceData": boolean, "canSetConferenceData": boolean, "canAddAttachments": boolean } |
| 필드 | |
|---|---|
canSeeAttendees |
사용자 생성 데이터. 부가기능이 일정 참석자 목록을 읽을 수 있으면 true이고, 그렇지 않으면 false입니다. |
canAddAttendees |
사용자 생성 데이터. 부가기능이 이벤트 참석자 목록에 새 참석자를 추가할 수 있는 경우 true이고, 그렇지 않으면 false입니다. |
canSeeConferenceData |
사용자 생성 데이터. 부가기능이 일정 회의 데이터를 읽을 수 있으면 true이고, 그렇지 않으면 false입니다. |
canSetConferenceData |
사용자 생성 데이터. 부가기능이 일정 회의 데이터를 업데이트할 수 있으면 true이고, 그렇지 않으면 false입니다. |
canAddAttachments |
사용자 생성 데이터. 부가기능이 일정에 새 첨부파일을 추가할 수 있으면 true이고, 그렇지 않으면 false입니다. |
DriveEventObject
Drive 이벤트 객체는 사용자의 Google Drive 및 해당 콘텐츠에 관한 정보를 전달하는 전체 이벤트 객체의 일부입니다. 호스트 애플리케이션이 Google Drive인 경우에만 이벤트 객체에 표시됩니다.
| JSON 표현 |
|---|
{ "selectedItems": [ { object ( |
| 필드 | |
|---|---|
selectedItems[] |
Drive에서 선택한 항목(파일 또는 폴더) 목록입니다. |
activeCursorItem |
현재 활성 상태인 Drive 항목입니다. |
DriveItemMetadata
Drive 항목 객체에는 파일이나 폴더와 같은 특정 Drive 항목에 관한 정보가 포함됩니다.
| JSON 표현 |
|---|
{ "id": string, "iconUrl": string, "mimeType": string, "title": string, "addonHasFileScopePermission": boolean } |
| 필드 | |
|---|---|
id |
선택한 상품의 ID입니다. |
iconUrl |
선택한 항목을 나타내는 아이콘의 URL입니다. |
mimeType |
선택한 항목의 MIME 유형입니다. |
title |
선택한 항목의 제목입니다. |
addonHasFileScopePermission |
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 |
현재 열려 있는 Gmail 메일의 ID입니다. |
threadId |
현재 열려 있는 Gmail 대화목록 ID입니다. |
accessToken |
Gmail 관련 액세스 토큰입니다. 이 토큰을 |
toRecipients[] |
기본적으로 사용 중지되어 있습니다. 부가기능에서 작성 중인 초안에 현재 포함된 '받는사람:' 수신자 이메일 주소 목록입니다. 이 필드를 사용 설정하려면 매니페스트의 |
ccRecipients[] |
기본적으로 사용 중지되어 있습니다. 부가기능에서 작성 중인 초안에 현재 포함된 '참조:' 수신자 이메일 주소 목록입니다. 이 필드를 사용 설정하려면 매니페스트의 |
bccRecipients[] |
기본적으로 사용 중지되어 있습니다. 부가기능에서 작성 중인 초안에 현재 포함된 '숨은참조:' 수신자 이메일 주소 목록입니다. 이 필드를 사용 설정하려면 매니페스트의 |
SheetsEventObject
Sheets 이벤트 객체는 사용자의 문서 및 콘텐츠에 관한 정보를 전달하는 전체 이벤트 객체의 일부입니다. 부가기능이 Google Sheets를 확장하는 경우에만 이벤트 객체에 표시됩니다.
| JSON 표현 |
|---|
{
"id": string,
"title": string,
"addonHasFileScopePermission": boolean,
"matchedUrl": {
object ( |
| 필드 | |
|---|---|
id |
사용자가 |
title |
사용자가 |
addonHasFileScopePermission |
|
matchedUrl |
다음 조건이 충족되는 경우에만 표시됩니다.
Google Sheets에서 미리보기를 생성하는 링크의 URL입니다. 이 필드를 사용하려면 부가기능의 매니페스트에서 사용자가 |
MatchedUrl
링크 미리보기 요청과 함께 반환되는 이벤트 객체입니다.
| JSON 표현 |
|---|
{ "url": string } |
| 필드 | |
|---|---|
url |
일치하는 URL입니다. |
SlidesEventObject
Slides 이벤트 객체는 사용자의 문서 및 콘텐츠에 관한 정보를 전달하는 전체 이벤트 객체의 일부입니다. 부가기능이 Google 슬라이드를 확장하는 경우에만 이벤트 객체에 표시됩니다.
| JSON 표현 |
|---|
{
"id": string,
"title": string,
"addonHasFileScopePermission": boolean,
"matchedUrl": {
object ( |
| 필드 | |
|---|---|
id |
사용자가 |
title |
사용자가 |
addonHasFileScopePermission |
|
matchedUrl |
다음 조건이 충족되는 경우에만 표시됩니다.
Google Slides에서 미리보기를 생성하는 링크의 URL입니다. 이 필드를 사용하려면 부가기능의 매니페스트에서 사용자가 |
DocsEventObject
Docs 이벤트 객체는 사용자의 문서 및 콘텐츠에 관한 정보를 전달하는 전체 이벤트 객체의 일부입니다. 부가기능이 Google Docs를 확장하는 경우에만 이벤트 객체에 표시됩니다.
| JSON 표현 |
|---|
{
"id": string,
"title": string,
"addonHasFileScopePermission": boolean,
"matchedUrl": {
object ( |
| 필드 | |
|---|---|
id |
사용자가 |
title |
사용자가 |
addonHasFileScopePermission |
|
matchedUrl |
다음 조건이 충족되는 경우에만 표시됩니다.
Google Docs에서 미리보기를 생성하는 링크의 URL입니다. 이 필드를 사용하려면 부가기능의 매니페스트에서 사용자가 |
ChatEventObject
Google 서버에서 부가기능으로 전송되는 Google Chat 앱 이벤트 객체 페이로드입니다. 페이로드를 사용하여 이벤트 유형을 식별할 수 있습니다.
| JSON 표현 |
|---|
{ "type": enum ( |
| 필드 | |
|---|---|
type |
이벤트 유형으로, 부가기능이 아닌 Chat 앱의 앱 홈 이벤트에만 채워집니다. |
user |
Chat 앱과 상호작용하는 사용자입니다. |
space |
이벤트가 발생한 스페이스로, 부가기능이 아닌 Chat 앱의 앱 홈 이벤트에만 채워집니다. |
eventTime |
이벤트 객체가 발생하는 시점을 나타내는 타임스탬프입니다. 생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 |
| 이벤트 객체의 페이로드입니다. 페이로드는 이벤트 객체 유형에 따라 다릅니다. 다음은 상호 배타적인 필드 목록입니다. 응답에서 최대 하나의 필드가 설정됩니다. | |
messagePayload |
사용자가 Chat 앱에 메시지를 보내거나 스페이스에서 Chat 앱을 @멘션합니다. 앱 명령어 호출(예: 슬래시 명령어 및 빠른 명령어)은 대신 |
addedToSpacePayload |
사용자가 Chat 스페이스에 Chat 앱을 추가하거나 Google Workspace 관리자가 조직 내 사용자를 위해 채팅 메시지 스페이스에 Chat 앱을 설치합니다. |
removedFromSpacePayload |
사용자가 스페이스에서 Chat 앱을 삭제합니다. |
buttonClickedPayload |
사용자가 사용자가 대화상자와 상호작용하면 ButtonClickedPayload의 전체 페이로드에는 |
widgetUpdatedPayload |
사용자가 인스트림 카드 또는 대화상자에서 위젯을 업데이트합니다. 전체 페이로드에는 |
appCommandPayload |
사용자가 앱 명령어를 호출합니다. |
systemCommandPayload |
사용자가 시스템 명령어를 호출합니다. |
| 상호 배타적 필드의 끝입니다. | |
EventType
이벤트 유형으로, 부가기능이 아닌 Chat 앱의 앱 홈 이벤트에만 채워집니다.
| 열거형 | |
|---|---|
EVENT_TYPE_UNSPECIFIED |
enum의 기본값입니다. 사용하지 않습니다. |
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 |
필수 항목입니다. 이벤트 객체가 발생하는 Chat 스페이스입니다. |
message |
이벤트 객체를 트리거하는 메시지입니다. |
configCompleteRedirectUri |
선택사항입니다. 사용자가 Google Chat 외부에서 승인 또는 구성 흐름을 완료한 후 Chat 앱이 사용자를 리디렉션해야 하는 URL입니다. 자세한 내용은 Chat 앱을 다른 서비스 및 도구와 연결하기를 참고하세요. |
AddedToSpacePayload
사용자가 스페이스에 Chat 앱을 추가하거나 앱과 사용자 간에 채팅 메시지가 생성됩니다.
| JSON 표현 |
|---|
{
"space": {
object ( |
| 필드 | |
|---|---|
space |
필수 항목입니다. 이벤트 객체가 발생하는 Chat 스페이스입니다. |
interactionAdd |
사용자 상호작용을 통해 앱이 스페이스에 추가되었는지 여부입니다(예: Chat 앱을 @ 멘션하거나 슬래시 명령어로 호출). true로 설정하면 상호작용 자체와 연결된 별도의 이벤트 객체가 Chat 앱에 전달됩니다. |
configCompleteRedirectUri |
선택사항입니다. 사용자가 Google Chat 외부에서 승인 또는 구성 흐름을 완료한 후 Chat 앱이 사용자를 리디렉션해야 하는 URL입니다. 자세한 내용은 Chat 앱을 다른 서비스 및 도구와 연결하기를 참고하세요. |
RemovedFromSpacePayload
사용자가 스페이스에서 Chat 앱을 삭제합니다.
| JSON 표현 |
|---|
{
"space": {
object ( |
| 필드 | |
|---|---|
space |
필수 항목입니다. 이벤트 객체가 발생하는 Chat 스페이스입니다. |
ButtonClickedPayload
사용자가 Action 콜백을 트리거하는 Chat 부가기능의 카드 또는 대화상자의 상호작용 요소와 상호작용합니다. 이름과 달리 이 페이로드는 버튼 클릭, onChangeAction 트리거, onClick 작업, CardAction 클릭, 대화 제출 또는 취소(SUBMIT_DIALOG 및 CANCEL_DIALOG)를 비롯한 모든 카드 및 대화 Action 콜백에 채워집니다.
사용자가 대화상자와 상호작용하면 ButtonClickedPayload의 isDialogEvent 필드가 true로 설정되고 DialogEventType가 포함됩니다. 이 페이로드는 부가기능이 아닌 Chat 앱의 SUBMIT_FORM 및 CARD_CLICKED 이벤트 유형에 매핑됩니다.
전체 페이로드에는 CommonEventObject.form_inputs 및 CommonEventObject.parameters도 포함됩니다.
| JSON 표현 |
|---|
{ "space": { object ( |
| 필드 | |
|---|---|
space |
필수 항목입니다. 이벤트 객체가 발생하는 Chat 스페이스입니다. |
message |
이벤트 객체를 트리거하는 메시지입니다. |
isDialogEvent |
|
dialogEventType |
수신된 대화 이벤트 객체의 유형입니다. |
DialogEventType
ButtonClicked 또는 AppCommand 이벤트 페이로드가 포함된 이벤트 객체의 경우 대화상자와의 상호작용 유형입니다.
Google Chat 앱 이벤트 객체에 관한 자세한 내용은 Google Chat 앱과의 상호작용 수신 및 응답을 참고하세요.
| 열거형 | |
|---|---|
DIALOG_EVENT_TYPE_UNSPECIFIED |
기본값 지정되지 않음. |
REQUEST_DIALOG |
사용자가 대화상자를 엽니다. |
SUBMIT_DIALOG |
사용자가 대화의 상호작용 요소를 클릭합니다. 예를 들어 사용자가 대화상자에 정보를 입력하고 버튼을 클릭하여 정보를 제출합니다. |
CANCEL_DIALOG |
사용자가 정보를 제출하지 않고 대화상자를 닫거나 대화상자가 취소됩니다. |
WidgetUpdatedPayload
사용자가 인스트림 카드 또는 대화상자에서 위젯을 업데이트합니다.
전체 페이로드에는 CommonEventObject.parameters['autocomplete_widget_query']도 포함됩니다.
| JSON 표현 |
|---|
{
"space": {
object ( |
| 필드 | |
|---|---|
space |
필수 항목입니다. 이벤트 객체가 발생하는 Chat 스페이스입니다. |
AppCommandPayload
사용자가 앱 명령어를 호출합니다.
| JSON 표현 |
|---|
{ "appCommandMetadata": { object ( |
| 필드 | |
|---|---|
appCommandMetadata |
슬래시 명령어 및 빠른 명령어를 포함한 앱 명령어에 채워집니다. |
space |
선택사항입니다. 이벤트 객체가 발생하는 Chat 스페이스입니다. |
thread |
선택사항입니다. 이벤트 객체가 발생하는 스레드입니다(해당하는 경우). 이벤트 객체가 특정 메일 또는 대화목록과 연결된 경우 이 필드가 채워집니다. |
message |
선택사항입니다. 이벤트 객체를 트리거하는 메시지입니다(해당하는 경우). 이 필드는 슬래시 명령어에만 채워집니다. |
configCompleteRedirectUri |
선택사항입니다. 사용자가 Google Chat 외부에서 승인 또는 구성 흐름을 완료한 후 리디렉션되어야 하는 URL입니다. 자세한 내용은 Chat 앱을 다른 서비스 및 도구와 연결하기를 참고하세요. |
isDialogEvent |
선택사항입니다. 사용자가 대화상자와 상호작용하고 있는지 또는 상호작용하려고 하는지 여부 |
dialogEventType |
선택사항입니다. 수신된 대화 이벤트 객체의 유형입니다. 이 필드는 |
AppCommandMetadata
Chat 앱 명령어에 관한 메타데이터입니다.
| JSON 표현 |
|---|
{
"appCommandId": integer,
"appCommandType": enum ( |
| 필드 | |
|---|---|
appCommandId |
Chat API 구성에 지정된 명령어의 ID입니다. |
appCommandType |
Chat 앱 명령어의 유형입니다. |
AppCommandType
Chat 앱 명령어의 유형입니다. 자세한 내용은 Chat 앱 명령어 유형을 참고하세요.
| 열거형 | |
|---|---|
APP_COMMAND_TYPE_UNSPECIFIED |
기본값 지정되지 않음. |
SLASH_COMMAND |
슬래시 명령어 사용자가 채팅 메시지로 명령어를 보냅니다. |
QUICK_COMMAND |
빠른 명령어입니다. 사용자가 메시지 답장 영역의 Chat 메뉴에서 명령어를 선택합니다. |
MESSAGE_ACTION |
메시지 작업입니다. 사용자가 Chat의 메시지 컨텍스트 메뉴에서 명령어를 선택합니다. |
SystemCommandPayload
사용자가 시스템 명령어를 호출합니다.
| JSON 표현 |
|---|
{ "systemCommandMetadata": { object ( |
| 필드 | |
|---|---|
systemCommandMetadata |
호출된 시스템 명령어에 대한 메타데이터입니다. |
space |
선택사항입니다. 이벤트 객체가 발생하는 Chat 스페이스입니다. |
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 |
활성 스트림 메시지를 취소하는 명령어입니다. |
| 상호 배타적 필드의 끝입니다. | |
CancelStream
활성 스트림 메시지를 취소하는 명령어입니다.
| JSON 표현 |
|---|
{ "streamMessage": string } |
| 필드 | |
|---|---|
streamMessage |
필수 항목입니다. 취소 명령어가 수행된 스트림 메시지의 리소스 이름입니다. 형식: |
WorkflowEventObject
LINT.IfChange 워크플로 부가기능에 전달되는 이벤트 객체입니다.
| JSON 표현 |
|---|
{ "executionMetadata": { object ( |
| 필드 | |
|---|---|
executionMetadata |
워크플로 실행에 대한 메타데이터입니다. |
triggerEventSource |
트리거 이벤트의 소스입니다. |
| 워크플로 이벤트 페이로드의 유형입니다. 다음은 상호 배타적인 필드 목록입니다. 응답에서 최대 하나의 필드가 설정됩니다. | |
actionInvocation |
워크플로 작업 호출 |
triggerCreation |
워크플로 트리거 생성 |
triggerDeletion |
워크플로 트리거 삭제 |
resourceRetrieval |
리소스 검색(변수 인플레이션에 사용됨) |
elementConfiguration |
워크플로 요소의 구성입니다. |
resourceFieldsDefinitionRetrieval |
리소스에서 지원하는 필드 정의 검색입니다. |
elementUiAutocomplete |
현재 렌더링된 카드의 자동 완성 추천 용어입니다. |
| 상호 배타적 필드의 끝입니다. | |
ActionInvocation
워크플로 작업 호출
| JSON 표현 |
|---|
{ "inputs": { string: { object ( |
| 필드 | |
|---|---|
inputs |
입력 변수 이름으로 키가 지정된 입력 변수의 맵입니다.
|
triggerId |
비동기 작업 응답에 사용할 트리거 ID입니다. |
flowLevelContext |
선택사항입니다. 이전 단계의 흐름 수준 컨텍스트입니다. |
VariableData
다양한 유형의 여러 값을 보유할 수 있는 변수 데이터를 나타냅니다.
| JSON 표현 |
|---|
{ "booleanValues": [ boolean ], "integerValues": [ string ], "floatValues": [ number ], "stringValues": [ string ], "timestampValues": [ string ], "resourceReferences": [ { object ( |
| 필드 | |
|---|---|
booleanValues[] |
불리언 값입니다. |
integerValues[] |
정수 값입니다. |
floatValues[] |
부동 소수점 수 값입니다. |
stringValues[] |
문자열 값입니다. |
timestampValues[] |
타임스탬프 값입니다. 생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 |
resourceReferences[] |
리소스 참조(ID) |
emailAddressValues[] |
이메일 주소 값입니다. |
googleUserValues[] |
|
textFormatValues[] |
워크플로 텍스트 형식 값입니다. |
ResourceReference
애플리케이션별 리소스의 ID 값입니다.
| JSON 표현 |
|---|
{
"resourceType": {
object ( |
| 필드 | |
|---|---|
resourceType |
이 ID가 가리키는 리소스의 유형입니다. |
resourceId |
리소스의 ID입니다. |
ResourceType
커스텀 리소스 유형의 이름입니다.
| JSON 표현 |
|---|
{ "workflowBundleId": string, "workflowResourceDefinitionId": string } |
| 필드 | |
|---|---|
workflowBundleId |
이 리소스 유형을 소유하는 워크플로 번들의 ID입니다. 이 필드는 선택사항이며 비어 있으면 사용 중인 번들과 동일한 번들로 간주됩니다. |
workflowResourceDefinitionId |
리소스의 고유 식별자입니다. 이 ID는 동일한 번들 내에서만 고유하면 됩니다. |
WorkflowTextFormat
스타일, 하이퍼링크, 상호작용 요소 등 다양한 서식 옵션이 있는 텍스트 블록입니다.
| JSON 표현 |
|---|
{
"textFormatElements": [
{
object ( |
| 필드 | |
|---|---|
textFormatElements[] |
텍스트 형식 요소의 컬렉션입니다. |
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 ( |
| 필드 | |
|---|---|
| 여러 가능한 텍스트 형식 요소 중 하나를 나타내는 요소입니다. 다음은 상호 배타적인 필드 목록입니다. 응답에서 최대 하나의 필드가 설정됩니다. | |
text |
텍스트 형식의 텍스트입니다. |
chip |
텍스트 형식의 클릭 가능한 칩입니다. |
styledText |
텍스트 형식의 스타일이 지정된 텍스트입니다. |
hyperlink |
텍스트 형식의 하이퍼링크입니다. |
listContainer |
텍스트 형식의 목록 컨테이너입니다. |
| 상호 배타적 필드의 끝입니다. | |
칩
텍스트 형식의 클릭 가능한 칩입니다.
| JSON 표현 |
|---|
{
"icon": {
object ( |
| 필드 | |
|---|---|
icon |
칩에 표시되는 아이콘입니다. |
label |
칩에 표시되는 텍스트입니다. |
url |
칩을 클릭할 때 이동할 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. } |
| 필드 | |
|---|---|
| 칩에 표시되는 아이콘입니다. 다음은 상호 배타적인 필드 목록입니다. 응답에서 최대 하나의 필드가 설정됩니다. | |
iconUrl |
HTTPS URL에서 호스팅되는 맞춤 아이콘을 표시합니다. 예를 들면 다음과 같습니다. 지원되는 파일 형식에는 |
materialIconName |
Google 머티리얼 아이콘에 정의된 아이콘 이름입니다(예: |
| 상호 배타적 필드의 끝입니다. | |
StyledText
굵게, 기울임꼴, 색상과 같은 스타일이 있는 텍스트 요소입니다.
| JSON 표현 |
|---|
{ "text": string, "styles": [ enum ( |
| 필드 | |
|---|---|
text |
텍스트의 기본 콘텐츠입니다. |
styles[] |
텍스트에 적용된 스타일 모음입니다. |
fontWeight |
텍스트의 글꼴 두께입니다. |
color |
텍스트의 색상입니다. |
wrapStyle |
텍스트의 줄바꿈 스타일입니다. |
스타일
기울임꼴, 밑줄 등 다양한 텍스트 스타일의 Enum입니다.
| 열거형 | |
|---|---|
STYLE_UNSPECIFIED |
적용된 스타일이 없습니다. 사용하지 않습니다. |
ITALIC |
기울임꼴 스타일입니다. |
UNDERLINE |
밑줄 스타일입니다. |
STRIKETHROUGH |
취소선 스타일입니다. |
LINE_BREAK |
줄바꿈 |
UPPERCASE |
대문자 스타일입니다. |
CODE |
코드, |
CODE_BLOCK |
코드 블록 |
FontWeight
다양한 글꼴 두께의 enum입니다.
| 열거형 | |
|---|---|
FONT_WEIGHT_UNSPECIFIED |
일반적인 두께의 표준 중량입니다. 사용하지 않습니다. |
LIGHT |
더 얇고 가벼워진 디자인 |
MEDIUM |
Light와 Bold 사이의 중간 두께입니다. |
BOLD |
두께가 증가하여 무게가 더 무거워졌습니다. |
WrapStyle
다양한 줄바꿈 스타일의 Enum입니다.
| 열거형 | |
|---|---|
WRAP_STYLE_UNSPECIFIED |
줄바꿈 스타일이 지정되지 않았습니다. |
NO_WRAP |
줄바꿈 스타일이 없습니다. |
하이퍼링크
텍스트와 링크가 있는 하이퍼링크 요소입니다.
| JSON 표현 |
|---|
{ "link": string, "text": string } |
| 필드 | |
|---|---|
link |
하이퍼링크의 도착 URL입니다. |
text |
하이퍼링크의 텍스트입니다. |
ListContainer
목록 항목의 컨테이너입니다. 각 목록 항목에는 여러 TextFormatElement가 포함될 수 있습니다.
| JSON 표현 |
|---|
{ "listNestLevel": string, "listType": enum ( |
| 필드 | |
|---|---|
listNestLevel |
목록의 중첩 수준입니다. 최상위 수준은 0부터 시작하며 중첩된 목록마다 1씩 증가합니다. |
listType |
목록의 유형입니다. |
listItems[] |
목록 항목의 컬렉션입니다. |
ListType
다양한 목록 유형의 Enum입니다.
| 열거형 | |
|---|---|
LIST_TYPE_UNSPECIFIED |
목록 유형이 지정되지 않았습니다. 사용하지 않습니다. |
ORDERED |
순서가 지정된 목록 |
UNORDERED |
순서가 지정되지 않은 목록 |
BLOCKQUOTE |
인용구 목록을 나타냅니다. |
ListItem
목록 항목입니다.
| JSON 표현 |
|---|
{
"textFormatElements": [
{
object ( |
| 필드 | |
|---|---|
textFormatElements[] |
텍스트 형식 요소의 컬렉션입니다. |
FlowLevelContext
이전 단계의 출력이 포함된 흐름 수준 컨텍스트입니다.
| JSON 표현 |
|---|
{
"stepContexts": [
{
object ( |
| 필드 | |
|---|---|
stepContexts[] |
선택사항입니다. 이전 단계 목록입니다. 순서가 중요하므로 이 목록에서 실행 순서가 유지되는지 확인합니다. |
StepContext
흐름 수준 컨텍스트의 단계 컨텍스트 메타데이터 및 출력
| JSON 표현 |
|---|
{
"stepId": string,
"outputs": {
string: {
object ( |
| 필드 | |
|---|---|
stepId |
선택사항입니다. 워크플로 그래프에 있는 단계의 고유 ID입니다. |
outputs |
선택사항입니다. 이 단계에서 생성된 출력 변수의 맵으로, 변수 이름으로 키가 지정됩니다.
|
TriggerCreation
워크플로 트리거 생성
| JSON 표현 |
|---|
{ "triggerId": string, "triggerType": enum ( |
| 필드 | |
|---|---|
triggerId |
생성 중에 제공된 트리거의 고유 식별자입니다. |
triggerType |
트리거 유형입니다. |
inputs |
입력 변수 이름으로 키가 지정된 입력 변수의 맵입니다.
|
notifyUri |
트리거가 실행될 때 호출되는 엔드포인트입니다. |
TriggerType
트리거 유형입니다.
| 열거형 | |
|---|---|
TRIGGER_TYPE_UNDEFINED |
기본값 사용하지 않습니다. |
REPEATING |
입력 조건이 충족될 때마다 트리거가 실행됩니다. |
TriggerDeletion
워크플로 트리거 삭제
| JSON 표현 |
|---|
{ "triggerId": string } |
| 필드 | |
|---|---|
triggerId |
생성 중에 제공된 트리거의 고유 식별자입니다. |
ResourceRetrieval
리소스 검색
| JSON 표현 |
|---|
{
"resourceReference": {
object ( |
| 필드 | |
|---|---|
resourceReference |
검색할 리소스의 유형 및 ID입니다. |
ElementConfiguration
워크플로 요소를 구성할 때 호출됩니다.
| JSON 표현 |
|---|
{ "inputs": { string: { object ( |
| 필드 | |
|---|---|
inputs |
입력 변수 이름으로 키가 지정된 입력 변수의 맵입니다. 이 맵은 비어 있을 수 있습니다. 워크플로 홈에서 단일 워크플로 요소(트리거 또는 작업)를 구성할 때 사용됩니다.
|
displayDestination |
요소 구성 카드의 대상입니다. 엘리먼트는 이 필드를 사용하여 도착 페이지에 따라 다른 구성 카드 레이아웃을 반환할 수 있습니다. |
nodeId |
렌더링 중인 기본 구성의 노드 ID입니다. |
workflowId |
렌더링되는 프리미티브 구성의 워크플로 ID입니다. |
availableVariables[] |
노드 위치별로 정렬된 사용 가능한 변수입니다. |
DisplayDestination
반환 요소 구성 카드가 표시될 위치를 나타냅니다.
| 열거형 | |
|---|---|
DISPLAY_DESTINATION_UNSPECIFIED |
기본값 사용하지 않습니다. |
DISPLAY_DESTINATION_SIDE_PANEL |
구성 카드가 측면 패널에 표시됩니다. |
DISPLAY_DESTINATION_FULL_SCREEN |
구성 카드가 전체 화면 앱에 표시됩니다. |
VariableReference
워크플로의 변수에 대한 변수 참조입니다.
| JSON 표현 |
|---|
{
"parentElementId": string,
"nodeId": string,
"path": string,
"dataType": {
object ( |
| 필드 | |
|---|---|
parentElementId |
변수를 생성하는 요소의 기본 ID입니다. 필요한 경우 이를 WorkflowElement 또는 더 자세한 메타데이터 프로토로 확장할 수 있습니다. |
nodeId |
노드 참조 ID |
path |
변수 선택기 경로 서명 |
dataType |
변수 데이터 유형 |
iconUrl |
이 변수를 생성하는 프리미티브의 아이콘 URL입니다. |
stepNumber |
이 변수를 생성하는 프리미티브의 단계 번호입니다. |
descriptionText |
변수에 대한 설명입니다. |
displayText |
변수 칩의 표시 텍스트입니다. |
DataType
변수 유형입니다.
| JSON 표현 |
|---|
{ "valueMetadata": { object ( |
| 필드 | |
|---|---|
valueMetadata |
변수의 잠재적 값에 관한 메타데이터입니다. |
| 데이터 유형입니다. 다음은 상호 배타적인 필드 목록입니다. 응답에서 최대 하나의 필드가 설정됩니다. | |
basicType |
기본 데이터 유형입니다. |
resourceType |
애플리케이션 리소스 ID 유형입니다. |
| 상호 배타적 필드의 끝입니다. | |
BasicType
기본 일반 데이터 유형입니다.
| 열거형 | |
|---|---|
BASIC_TYPE_UNSPECIFIED |
기본값 사용하지 않습니다. |
STRING |
문자열입니다. |
INTEGER |
정수입니다. |
FLOAT |
부동 소수점 숫자입니다. |
TIMESTAMP |
ISO 8601 형식의 타임스탬프입니다. |
BOOLEAN |
참 또는 거짓일 수 있는 값입니다. |
EMAIL_ADDRESS |
이메일 주소 형식의 문자열인 이메일 주소입니다. |
GOOGLE_USER |
Google 서비스 사용자(users/{user} 형식) |
FILE |
파일 참조입니다. |
FORMATTED_TEXT |
서식 있는 텍스트입니다. |
ValueMetadata
변수의 잠재적 값에 대한 정보입니다.
| JSON 표현 |
|---|
{ "enumValues": [ string ], "dynamicTypes": [ enum ( |
| 필드 | |
|---|---|
enumValues[] |
선택사항입니다. 문자열에 허용되는 값을 지정합니다. |
dynamicTypes[] |
선택사항입니다. 변수에 동적으로 변환할 수 있는 허용되는 유형을 지정합니다. DataType이 문자열이고 변수가 출력인 경우에만 설정할 수 있습니다. |
semanticDescriptors[] |
선택사항입니다. 변수의 시맨틱 의미를 설명하는 데 도움이 됩니다. |
dynamicSchema |
선택사항입니다. 이 변수의 스키마를 동적으로 확인하기 위한 구성입니다. |
defaultValue |
선택사항입니다. 이 변수의 기본값을 지정하는 문자열입니다. 예를 들어 불리언의 경우 |
SemanticDescriptor
변수의 시맨틱 의미에 관한 메타데이터입니다.
| JSON 표현 |
|---|
{ "resourceAttribute": string, "disallowedResourceAttributes": [ string ] } |
| 필드 | |
|---|---|
resourceAttribute |
변수가 리소스의 특정 속성에 해당함을 나타냅니다. 이는 리소스의 식별자(ID, URL, 키 등)를 나타내는 변수에 특히 유용합니다. 권장 형식은 다음과 같습니다. - 예: - 클라이언트는 이 정보를 사용하여 특정 입력과 호환되는 결과물 변수를 사용자에게 알려줍니다. |
disallowedResourceAttributes[] |
선택사항입니다. 입력에만 적용되며 출력에서는 무시됩니다. 이 시맨틱 설명자에 해당하는 허용되지 않는 속성입니다. 클라이언트는 허용되지 않는 리소스 속성에 해당하는 출력에 대한 변수 선택을 명시적으로 방지합니다. |
DynamicSchema
런타임에 이 변수의 스키마를 동적으로 확인하기 위한 구성입니다.
| JSON 표현 |
|---|
{ "requiredInputIds": [ string ], "strictEnum": boolean } |
| 필드 | |
|---|---|
requiredInputIds[] |
이 변수의 스키마를 동적으로 확인하기 전에 제공해야 하는 동위 입력 변수의 ID입니다. |
strictEnum |
true인 경우 변수 값이 동적으로 확인된 enum 값 중 하나와 일치해야 합니다. false인 경우 동적으로 확인된 값은 엄격하지 않은 추천으로 처리됩니다. |
ResourceFieldsDefinitionRetrieval
리소스에서 지원하는 필드의 정의를 가져옵니다.
| JSON 표현 |
|---|
{
"elementId": string,
"inputs": {
string: {
object ( |
| 필드 | |
|---|---|
elementId |
동적 리소스 스키마를 가져올 요소의 ID를 지정합니다. |
inputs |
이는 변수를 제공하는 노드의 필드 입력으로 구성됩니다. 입력 변수 이름으로 키가 지정된 입력 변수의 맵입니다.
|
ElementUiAutocomplete
현재 렌더링된 카드의 자동 완성 추천 용어입니다.
| JSON 표현 |
|---|
{
"query": string,
"inputs": {
string: {
object ( |
| 필드 | |
|---|---|
query |
자동 완성할 쿼리입니다. |
inputs |
입력 변수 이름으로 키가 지정된 입력 변수의 맵입니다.
|
invokedFunction |
위젯과 연결된 호출된 함수입니다. |
resourceId |
자동 완성할 리소스 ID입니다. 이 필드는 선택사항이며 설정되지 않을 수 있습니다. |
operationId |
자동 완성할 리소스를 제공한 작업의 ID입니다. 이 필드는 선택사항이며 설정되지 않을 수 있습니다. |
ExecutionMetadata
워크플로 실행에 대한 메타데이터입니다.
| JSON 표현 |
|---|
{ "versionId": integer, "timeZone": string, "stepNumber": integer } |
| 필드 | |
|---|---|
versionId |
호출되는 워크플로 요소의 버전입니다. |
timeZone |
저장 중인 워크플로의 시간대입니다(예: 'America/Los_Angeles'). |
stepNumber |
호출되는 프리미티브의 단계 번호를 나타냅니다. |
TriggerEventSource
이 실행을 트리거한 트리거 이벤트의 소스입니다.
| 열거형 | |
|---|---|
TRIGGER_EVENT_SOURCE_UNSPECIFIED |
기본값 사용하지 않습니다. |
TRIGGER_EVENT_SOURCE_AUTOMATED |
실행은 이벤트에 의해 자동으로 트리거됩니다. |
TRIGGER_EVENT_SOURCE_TEST_RUN |
실행은 테스트 실행을 통해 트리거됩니다. |