- EventObject
- CommonEventObject
- HostApp
- Platform
- 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 アドオン操作イベント。
イベント オブジェクトは、ユーザーがホストアプリ内でアドオンを操作したときに、アドオンのコールバック関数またはトリガー(AppsScript の場合)、または https エンドポイント(HTTP の場合)に JSON として渡されます。イベント オブジェクトには、各ホストアプリによって定義されたホストアプリ イベント オブジェクトと、イベントに関連するいくつかの共通フィールドを含む共通イベント オブジェクトが格納されます。
詳細については、イベント オブジェクトをご覧ください。
| JSON 表現 |
|---|
{ "commonEventObject": { object ( |
| フィールド | |
|---|---|
commonEventObject |
ホステッド アプリケーションに関係なく、すべてのイベント オブジェクトに共通する情報を含むオブジェクト。 |
authorizationEventObject |
HTTP エンドポイントへのリクエストにのみ設定されます。 |
| 相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。 | |
calendar |
呼び出し元のホストが Google カレンダーの場合にのみ存在します。カレンダーと予定の情報を含むオブジェクト。 |
drive |
呼び出し元のホストが Google ドライブの場合にのみ表示されます。ドライブ情報を含むオブジェクト。 |
gmail |
呼び出し元のホストが Gmail の場合にのみ表示されます。Gmail の情報を含むオブジェクト。 |
sheets |
呼び出し元のホストが Google スプレッドシートの場合にのみ表示されます。スプレッドシートの情報を含むオブジェクト。 |
slides |
呼び出し元のホストが Google スライドの場合にのみ存在します。スライドの情報を含むオブジェクト。 |
docs |
呼び出し元のホストが Google ドキュメントの場合にのみ存在します。ドキュメント情報を含むオブジェクト。 |
chat |
呼び出し元のホストが Google Chat の場合にのみ表示されます。Chat の情報を含むオブジェクト。 |
workflow |
呼び出し元のホストが Google Workspace Studio の場合にのみ存在します。ワークフロー情報を含むオブジェクト。 |
| 相互に排他的なフィールドの終了。 | |
CommonEventObject
共通イベント オブジェクトは、ユーザーのクライアントからアドオンに、ホストに依存しない一般的な情報を伝達する、全体的なイベント オブジェクトの一部です。この情報には、ユーザーの言語 / 地域、ホストアプリ、プラットフォームなどの詳細が含まれます。
ホームページ トリガーとコンテキスト トリガーに加えて、アドオンは、ユーザーがウィジェットを操作したときにイベント オブジェクトを作成してアクション コールバック関数に渡します。アドオンのコールバック関数は、共通イベント オブジェクトをクエリして、ユーザーのクライアントで開いているウィジェットの内容を判断できます。たとえば、アドオンは、ユーザーが eventObject.commentEventObject.formInputs オブジェクトの TextInput ウィジェットに入力したテキストを特定できます。
Chat アプリの場合、ユーザーがウィジェットを操作したときに呼び出した関数の名前。
| JSON 表現 |
|---|
{ "userLocale": string, "hostApp": enum ( |
| フィールド | |
|---|---|
userLocale |
デフォルトでは無効にされています。ユーザーの言語と国 / 地域の識別子。ISO 639 言語コード - ISO 3166 国 / 地域コードの形式で指定します。例: このフィールドを有効にするには、アドオンのマニフェストで |
hostApp |
イベント オブジェクトが生成されたときにアドオンがアクティブになっているホストアプリを示します。有効な値は次のとおりです。
|
platform |
イベントの発生元プラットフォームを示すプラットフォーム列挙型( |
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 アプリの場合、ホストアプリは常に CHAT です。
| 列挙型 | |
|---|---|
UNSPECIFIED_HOST_APP |
Google がホストアプリを識別できない。 |
GMAIL |
アドオンが Gmail から起動します。 |
CALENDAR |
アドオンが Google カレンダーから起動します。 |
DRIVE |
アドオンは Google ドライブから起動します。 |
DEMO |
使用されません。 |
DOCS |
アドオンが Google ドキュメントから起動します。 |
MEET |
アドオンが Google Meet から起動します。 |
SHEETS |
アドオンは Google スプレッドシートから起動します。 |
SLIDES |
アドオンは Google スライドから起動します。 |
DRAWINGS |
アドオンが Google 図形描画から起動します。 |
CHAT |
Google Chat 用アプリ。 |
プラットフォーム
この呼び出しの発信元プラットフォームを識別します。
| 列挙型 | |
|---|---|
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 ( |
| フィールド | |
|---|---|
| 相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。 | |
stringInputs |
ユーザーがウィジェットに入力した値を表す文字列のリスト。 ウィジェットが 1 つの値のみを受け入れる場合( |
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 |
1 時間あたりの分数。有効な値は 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
カレンダー イベント オブジェクトは、ユーザーのカレンダーとカレンダーの予定に関する情報を保持する、全体的なイベント オブジェクトの一部です。ホスト アプリケーションが Google カレンダーの場合にのみ、イベント オブジェクトに存在します。
次の表に、イベント オブジェクトの 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 |
予定の主催者のメールアドレス。 |
参加者
Attendee オブジェクトには、Google カレンダーの予定の個々の参加者に関する情報が含まれます。この情報は、データがカレンダーの予定に存在し、アドオンが 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 カレンダーの予定に添付された会議に関する情報が含まれます。これには、Google Meet などの Google の会議ソリューションや、サードパーティの会議ソリューションを使用できます。この情報は、データがカレンダーの予定に存在し、アドオンが addOns.calendar.currentEventAccess マニフェスト フィールドを READ または READ_WRITE に設定している場合にのみ、イベント オブジェクトに存在します。
| JSON 表現 |
|---|
{ "conferenceId": string, "conferenceSolution": { object ( |
| フィールド | |
|---|---|
conferenceId |
会議の ID。この 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
ドライブ イベント オブジェクトは、ユーザーの Google ドライブとそのコンテンツに関する情報を保持する、イベント オブジェクト全体の一部です。ホステッド アプリケーションが Google ドライブの場合にのみ、イベント オブジェクトに存在します。
| JSON 表現 |
|---|
{ "selectedItems": [ { object ( |
| フィールド | |
|---|---|
selectedItems[] |
ドライブで選択されたアイテム(ファイルまたはフォルダ)のリスト。 |
activeCursorItem |
現在アクティブなドライブ アイテム。 |
DriveItemMetadata
ドライブ アイテム オブジェクトには、ファイルやフォルダなど、特定のドライブ アイテムに関する情報が含まれます。
| 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[] |
デフォルトでは無効にされています。アドオンが作成中の下書きに現在含まれている「CC:」受信者のメールアドレスのリスト。このフィールドを有効にするには、マニフェストの |
bccRecipients[] |
デフォルトでは無効にされています。アドオンが作成中の下書きに現在含まれている「BCC:」受信者のメールアドレスのリスト。このフィールドを有効にするには、マニフェストの |
SheetsEventObject
スプレッドシートのイベント オブジェクトは、ユーザーのドキュメントとそのコンテンツに関する情報を保持する、イベント オブジェクト全体の一部です。アドオンが Google スプレッドシートを拡張する場合にのみ、イベント オブジェクトに存在します。
| JSON 表現 |
|---|
{
"id": string,
"title": string,
"addonHasFileScopePermission": boolean,
"matchedUrl": {
object ( |
| フィールド | |
|---|---|
id |
|
title |
|
addonHasFileScopePermission |
|
matchedUrl |
次の条件が満たされている場合にのみ表示されます。
Google スプレッドシートでプレビューを生成するリンクの URL。このフィールドを使用するには、アドオンのマニフェストで ユーザーがリンク |
MatchedUrl
リンク プレビュー リクエストで返されるイベント オブジェクト。
| JSON 表現 |
|---|
{ "url": string } |
| フィールド | |
|---|---|
url |
一致した URL。 |
SlidesEventObject
スライドのイベント オブジェクトは、ユーザーのドキュメントとそのコンテンツに関する情報を保持する、イベント オブジェクト全体の一部です。アドオンが Google スライドを拡張する場合にのみ、イベント オブジェクトに存在します。
| JSON 表現 |
|---|
{
"id": string,
"title": string,
"addonHasFileScopePermission": boolean,
"matchedUrl": {
object ( |
| フィールド | |
|---|---|
id |
|
title |
|
addonHasFileScopePermission |
|
matchedUrl |
次の条件が満たされている場合にのみ表示されます。
Google スライドでプレビューを生成するリンクの URL。このフィールドを使用するには、アドオンのマニフェストで ユーザーがリンク |
DocsEventObject
Google ドキュメントのイベント オブジェクトは、ユーザーのドキュメントとそのコンテンツに関する情報を保持する、イベント オブジェクト全体の一部です。アドオンが Google ドキュメントを拡張する場合にのみ、イベント オブジェクトに存在します。
| JSON 表現 |
|---|
{
"id": string,
"title": string,
"addonHasFileScopePermission": boolean,
"matchedUrl": {
object ( |
| フィールド | |
|---|---|
id |
|
title |
|
addonHasFileScopePermission |
|
matchedUrl |
次の条件が満たされている場合にのみ表示されます。
Google ドキュメントでプレビューを生成するリンクの URL。このフィールドを使用するには、アドオンのマニフェストで ユーザーがリンク |
ChatEventObject
Google サーバーからアドオンに送信される Google Chat アプリのイベント オブジェクト ペイロード。ペイロードを使用して、イベントのタイプを識別できます。
| JSON 表現 |
|---|
{ "type": enum ( |
| フィールド | |
|---|---|
type |
イベントのタイプ。アドオンではない Chat アプリのアプリホーム イベントの場合のみ入力されます。 |
user |
Chat 用アプリを操作するユーザー。 |
space |
イベントが発生したスペース。アドオンではない Chat アプリの App Home イベントの場合にのみ入力されます。 |
eventTime |
イベント オブジェクトが発生した日時を示すタイムスタンプ。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: |
| イベント オブジェクトのペイロード。ペイロードはイベント オブジェクト タイプによって異なります。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。 | |
messagePayload |
ユーザーが Chat 用アプリにメッセージを送信するか、スペースで Chat 用アプリに @メンションを付けます。アプリコマンドの呼び出し(スラッシュ コマンドやクイック コマンドなど)は、代わりに |
addedToSpacePayload |
ユーザーが Chat スペースに Chat アプリを追加するか、Google Workspace 管理者が組織内のユーザーのダイレクト メッセージ スペースに Chat アプリをインストールします。 |
removedFromSpacePayload |
ユーザーがスペースから Chat アプリを削除した。 |
buttonClickedPayload |
ユーザーが ユーザーがダイアログを操作すると、ButtonClickedPayload の 完全なペイロードには |
widgetUpdatedPayload |
ユーザーがインストリーム カードまたはダイアログでウィジェットを更新する。 完全なペイロードには |
appCommandPayload |
ユーザーがアプリコマンドを呼び出します。 |
systemCommandPayload |
ユーザーがシステム コマンドを呼び出す。 |
| 相互に排他的なフィールドの終了。 | |
EventType
イベントのタイプ。アドオンではない Chat アプリのアプリホーム イベントの場合のみ入力されます。
| 列挙型 | |
|---|---|
EVENT_TYPE_UNSPECIFIED |
列挙型のデフォルト値。使用しないでください。 |
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 アプリをスペースに追加するか、アプリとユーザーの間の DM が作成されます。
| JSON 表現 |
|---|
{
"space": {
object ( |
| フィールド | |
|---|---|
space |
必須。イベント オブジェクトが発生する Chat スペース。 |
interactionAdd |
ユーザーの操作(Chat 用アプリに名前リンクを付ける、スラッシュ コマンドで呼び出すなど)によってアプリがスペースに追加されたかどうか。これを true に設定すると、インタラクション自体に関連付けられた個別のイベント オブジェクトが Chat 用アプリにディスパッチされます。 |
configCompleteRedirectUri |
省略可。Google Chat の外部で承認フローまたは設定フローを完了した後に、Chat 用アプリがユーザーをリダイレクトする URL。詳しくは、Chat 用アプリを他のサービスやツールに接続するをご覧ください。 |
RemovedFromSpacePayload
ユーザーがスペースから Chat アプリを削除した。
| JSON 表現 |
|---|
{
"space": {
object ( |
| フィールド | |
|---|---|
space |
必須。イベント オブジェクトが発生する Chat スペース。 |
ButtonClickedPayload
ユーザーが Chat アドオンのカードまたはダイアログのインタラクティブ要素を操作すると、Action コールバックがトリガーされます。このペイロードは、ボタンクリック、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 |
省略可。受信した dialog イベント オブジェクトのタイプ。このフィールドは、 |
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 ( |
| フィールド | |
|---|---|
| 呼び出されたシステム コマンド。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。 | |
cancelStream |
アクティブなストリーム メッセージをキャンセルするコマンド。 |
| 相互に排他的なフィールドの終了。 | |
CancelStream
アクティブなストリーム メッセージをキャンセルするコマンド。
| JSON 表現 |
|---|
{ "streamMessage": string } |
| フィールド | |
|---|---|
streamMessage |
必須。キャンセル コマンドが実行されたストリーム メッセージのリソース名。 形式: |
WorkflowEventObject
LINT.IfChange ワークフロー アドオンに渡されるイベント オブジェクト。
| JSON 表現 |
|---|
{ "executionMetadata": { object ( |
| フィールド | |
|---|---|
executionMetadata |
ワークフローの実行に関するメタデータ。 |
triggerEventSource |
トリガー イベントのソース。 |
| ワークフロー イベント ペイロードのタイプ。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。 | |
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[] |
タイムスタンプ値。 RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: |
resourceReferences[] |
リソース参照(ID)。 |
emailAddressValues[] |
メールアドレスの値。 |
googleUserValues[] |
Google ユーザーの値( |
textFormatValues[] |
ワークフローのテキスト形式の値。 |
ResourceReference
アプリケーション固有のリソースの ID 値。
| JSON 表現 |
|---|
{
"resourceType": {
object ( |
| フィールド | |
|---|---|
resourceType |
この ID が指すリソースのタイプ。 |
resourceId |
リソースの ID。 |
ResourceType
カスタム リソースタイプの名前。
| JSON 表現 |
|---|
{ "workflowBundleId": string, "workflowResourceDefinitionId": string } |
| フィールド | |
|---|---|
workflowBundleId |
このリソースタイプを所有するワークフロー バンドルの ID。これは省略可能です。空の場合、使用されているバンドルと同じバンドルと見なされます。 |
workflowResourceDefinitionId |
リソースの固有識別子。これは、同じバンドル内で一意である必要があります。 |
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 ( |
| フィールド | |
|---|---|
| 複数のテキスト形式要素のいずれかを表す要素。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。 | |
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. } |
| フィールド | |
|---|---|
| チップに表示されるアイコン。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。 | |
iconUrl |
HTTPS URL でホストされているカスタム アイコンを表示する。 次に例を示します。 サポートされているファイル形式は |
materialIconName |
Google マテリアル アイコンで定義されているアイコン名(例: |
| 相互に排他的なフィールドの終了。 | |
StyledText
太字、斜体、色などのスタイルが設定されたテキスト要素。
| JSON 表現 |
|---|
{ "text": string, "styles": [ enum ( |
| フィールド | |
|---|---|
text |
テキストのメイン コンテンツ。 |
styles[] |
テキストに適用されるスタイルのコレクション。 |
fontWeight |
テキストのフォントの太さ。 |
color |
テキストの色。 |
wrapStyle |
テキストの折り返しスタイル。 |
スタイル
斜体、下線など、さまざまなテキスト スタイルの列挙型。
| 列挙型 | |
|---|---|
STYLE_UNSPECIFIED |
スタイルが適用されていません。使用しないでください。 |
ITALIC |
斜体スタイル。 |
UNDERLINE |
下線のスタイル。 |
STRIKETHROUGH |
取り消し線スタイル。 |
LINE_BREAK |
改行。 |
UPPERCASE |
大文字スタイル。 |
CODE |
Code. |
CODE_BLOCK |
コードブロック。 |
FontWeight
さまざまなフォントの太さの列挙型。
| 列挙型 | |
|---|---|
FONT_WEIGHT_UNSPECIFIED |
標準的な厚さの標準的な用紙。使用しないでください。 |
LIGHT |
薄型化により軽量化を実現。 |
MEDIUM |
ライトとボールドの中間の太さ。 |
BOLD |
厚みが増し、重量が増加。 |
WrapStyle
さまざまなラップスタイルの列挙型。
| 列挙型 | |
|---|---|
WRAP_STYLE_UNSPECIFIED |
折り返しスタイルが指定されていません。 |
NO_WRAP |
折り返しスタイルなし。 |
Hyperlink
テキストとリンクを含むハイパーリンク要素。
| JSON 表現 |
|---|
{ "link": string, "text": string } |
| フィールド | |
|---|---|
link |
ハイパーリンクのリンク先 URL。 |
text |
ハイパーリンクのテキスト。 |
ListContainer
リストアイテムのコンテナ。各リストアイテムには複数の TextFormatElement を含めることができます。
| JSON 表現 |
|---|
{ "listNestLevel": string, "listType": enum ( |
| フィールド | |
|---|---|
listNestLevel |
リストのネストレベル。最上位レベルは 0 から始まり、ネストされたリストごとに 1 ずつ増加します。 |
listType |
リストのタイプ。 |
listItems[] |
リストアイテムのコレクション。 |
ListType
さまざまなリストタイプの列挙型。
| 列挙型 | |
|---|---|
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 またはより詳細なメタデータ proto に拡張できます。 |
nodeId |
ノード参照 ID |
path |
変数セレクタのパスのシグネチャ |
dataType |
変数のデータ型 |
iconUrl |
この変数を生成するプリミティブのアイコン URL。 |
stepNumber |
この変数を生成するプリミティブのステップ番号。 |
descriptionText |
変数の説明。 |
displayText |
変数チップの表示テキスト。 |
DataType
変数の型。
| JSON 表現 |
|---|
{ "valueMetadata": { object ( |
| フィールド | |
|---|---|
valueMetadata |
変数の潜在的な値に関するメタデータ。 |
| データの種類。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。 | |
basicType |
基本データ型。 |
resourceType |
アプリケーション リソース ID のタイプ。 |
| 相互に排他的なフィールドの終了。 | |
BasicType
基本的な汎用データ型。
| 列挙型 | |
|---|---|
BASIC_TYPE_UNSPECIFIED |
デフォルト値。使用しないでください。 |
STRING |
文字列。 |
INTEGER |
整数。 |
FLOAT |
浮動小数点数。 |
TIMESTAMP |
ISO 8601 形式のタイムスタンプ。 |
BOOLEAN |
true または false の値。 |
EMAIL_ADDRESS |
メールアドレス。メールアドレスの形式の文字列です。 |
GOOGLE_USER |
Google サービスのユーザー(users/{user} 形式)。 |
FILE |
ファイル参照。 |
FORMATTED_TEXT |
リッチ形式のテキスト。 |
ValueMetadata
変数の潜在的な値に関する情報。
| JSON 表現 |
|---|
{ "enumValues": [ string ], "dynamicTypes": [ enum ( |
| フィールド | |
|---|---|
enumValues[] |
省略可。文字列に許可される値を指定します。これは、 |
dynamicTypes[] |
省略可。変数に動的にキャストできる許可された型を指定します。これは、DataType が String で、変数が出力の場合にのみ設定できます。 |
semanticDescriptors[] |
省略可。変数の意味を説明するのに役立ちます。 |
dynamicSchema |
省略可。この変数のスキーマを動的に解決するための構成。 |
defaultValue |
省略可。この変数のデフォルト値を指定する文字列。たとえば、ブール値の場合、 |
SemanticDescriptor
変数の意味に関するメタデータ。
| JSON 表現 |
|---|
{ "resourceAttribute": string, "disallowedResourceAttributes": [ string ] } |
| フィールド | |
|---|---|
resourceAttribute |
変数がリソースの特定の属性に対応していることを示します。これは、リソースの識別子(ID、URL、キーなど)を表す変数に特に役立ちます。 推奨される形式は次のとおりです。- 例: - クライアントは、この情報を使用して、特定の入力と互換性のある出力変数をユーザーにヒントとして提供します。 |
disallowedResourceAttributes[] |
省略可。入力にのみ適用され、出力では無視されます。このセマンティック記述子に対応する、許可されていない属性。クライアントは、これらの許可されていないリソース属性に対応する出力の変数選択を明示的に防止します。 |
DynamicSchema
実行時にこの変数のスキーマを動的に解決するための構成。
| JSON 表現 |
|---|
{ "requiredInputIds": [ string ], "strictEnum": boolean } |
| フィールド | |
|---|---|
requiredInputIds[] |
この変数のスキーマを動的に解決する前に指定する必要がある、兄弟入力変数の ID。 |
strictEnum |
true の場合、変数の値は、動的に解決された列挙値のいずれかと一致する必要があります。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 |
実行はテスト実行によってトリガーされます。 |