EventObject

EventObject

ホストアプリ内のアドオンに対するユーザーの操作に関するデータを含む Google アドオン操作イベント。

イベント オブジェクトは、ユーザーがホストアプリ内でアドオンを操作したときに、アドオンのコールバック関数またはトリガー(AppsScript の場合)、または https エンドポイント(HTTP の場合)に JSON として渡されます。イベント オブジェクトには、各ホストアプリによって定義されたホストアプリ イベント オブジェクトと、イベントに関連するいくつかの共通フィールドを含む共通イベント オブジェクトが格納されます。

詳細については、イベント オブジェクトをご覧ください。

JSON 表現
{
  "commonEventObject": {
    object (CommonEventObject)
  },
  "authorizationEventObject": {
    object (AuthorizationEventObject)
  },

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

object (CommonEventObject)

ホステッド アプリケーションに関係なく、すべてのイベント オブジェクトに共通する情報を含むオブジェクト。

authorizationEventObject

object (AuthorizationEventObject)

HTTP エンドポイントへのリクエストにのみ設定されます。

相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
calendar

object (CalendarEventObject)

呼び出し元のホストが Google カレンダーの場合にのみ存在します。カレンダーと予定の情報を含むオブジェクト。

drive

object (DriveEventObject)

呼び出し元のホストが Google ドライブの場合にのみ表示されます。ドライブ情報を含むオブジェクト。

gmail

object (GmailEventObject)

呼び出し元のホストが Gmail の場合にのみ表示されます。Gmail の情報を含むオブジェクト。

sheets

object (SheetsEventObject)

呼び出し元のホストが Google スプレッドシートの場合にのみ表示されます。スプレッドシートの情報を含むオブジェクト。

slides

object (SlidesEventObject)

呼び出し元のホストが Google スライドの場合にのみ存在します。スライドの情報を含むオブジェクト。

docs

object (DocsEventObject)

呼び出し元のホストが Google ドキュメントの場合にのみ存在します。ドキュメント情報を含むオブジェクト。

chat

object (ChatEventObject)

呼び出し元のホストが Google Chat の場合にのみ表示されます。Chat の情報を含むオブジェクト。

workflow

object (WorkflowEventObject)

呼び出し元のホストが Google Workspace Studio の場合にのみ存在します。ワークフロー情報を含むオブジェクト。

相互に排他的なフィールドの終了。

CommonEventObject

共通イベント オブジェクトは、ユーザーのクライアントからアドオンに、ホストに依存しない一般的な情報を伝達する、全体的なイベント オブジェクトの一部です。この情報には、ユーザーの言語 / 地域、ホストアプリ、プラットフォームなどの詳細が含まれます。

ホームページ トリガーとコンテキスト トリガーに加えて、アドオンは、ユーザーがウィジェットを操作したときにイベント オブジェクトを作成してアクション コールバック関数に渡します。アドオンのコールバック関数は、共通イベント オブジェクトをクエリして、ユーザーのクライアントで開いているウィジェットの内容を判断できます。たとえば、アドオンは、ユーザーが eventObject.commentEventObject.formInputs オブジェクトの TextInput ウィジェットに入力したテキストを特定できます。

Chat アプリの場合、ユーザーがウィジェットを操作したときに呼び出した関数の名前。

JSON 表現
{
  "userLocale": string,
  "hostApp": enum (HostApp),
  "platform": enum (Platform),
  "timeZone": {
    object (TimeZone)
  },
  "formInputs": {
    string: {
      object (Inputs)
    },
    ...
  },
  "parameters": {
    string: string,
    ...
  },
  "invokedFunction": string
}
フィールド
userLocale

string

デフォルトでは無効にされています。ユーザーの言語と国 / 地域の識別子。ISO 639 言語コード - ISO 3166 国 / 地域コードの形式で指定します。例: en-US

このフィールドを有効にするには、アドオンのマニフェストで addOns.common.useLocaleFromApp を true に設定する必要があります。アドオンのスコープリストには https://www.googleapis.com/auth/script.locale も含める必要があります。詳細については、ユーザーの言語 / 地域とタイムゾーンへのアクセスをご覧ください。

hostApp

enum (HostApp)

イベント オブジェクトが生成されたときにアドオンがアクティブになっているホストアプリを示します。有効な値は次のとおりです。

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

enum (Platform)

イベントの発生元プラットフォームを示すプラットフォーム列挙型(WEB、IOS、ANDROID)。Chat 用アプリではサポートされていません。

timeZone

object (TimeZone)

デフォルトでは無効にされています。タイムゾーン ID と協定世界時(UTC)からのオフセット。このフィールドを有効にするには、アドオンのマニフェストで addOns.common.useLocaleFromApp を true に設定する必要があります。アドオンのスコープリストには https://www.googleapis.com/auth/script.locale も含める必要があります。詳細については、ユーザーの言語 / 地域とタイムゾーンへのアクセスをご覧ください。

イベントタイプ CARD_CLICKED と SUBMIT_DIALOG でのみサポートされています。

formInputs

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

表示されたカード内のウィジェットの現在の値を含むマップ。マップキーは、各入力ウィジェット(TextInput.name、SelectionInput.name、DateTimePicker.name、DecoratedText.SwitchControl.name など)に割り当てられた文字列 name 値です。

マップ値オブジェクトの構造は、ウィジェット タイプによって異なります。

注: 以下の例は、Apps Script の V8 ランタイム用にフォーマットされています。Rhino ランタイムを使用している場合は、値の後に [""] を追加する必要があります。たとえば、e.commonEventObject.formInputs.employeeName.stringInputs.value[0] ではなく、イベント オブジェクトを e.commonEventObject.formInputs.employeeName[""].stringInputs.value[0] の形式にします。Apps Script のランタイムの詳細については、V8 ランタイムの概要をご覧ください。

  • 単一値ウィジェット(TextInput ウィジェット、DROPDOWN 型または RADIO_BUTTON 型の SelectionInput ウィジェットなど): 単一要素リスト(選択されていない場合は空のリスト)を含む StringInputs オブジェクト。

例: name が employeeName のテキスト入力ウィジェットの場合、e.commonEventObject.formInputs.employeeName.stringInputs.value[0] を使用してテキスト入力値にアクセスします。

  • 複数値ウィジェット(CHECK_BOX、SWITCH、MULTI_SELECT タイプの SelectionInput ウィジェットなど): 選択したアイテムの value 文字列のリストを含む StringInputs オブジェクト。

例: name が participants のマルチ値ウィジェットの場合、e.commonEventObject.formInputs.participants.stringInputs.value を使用して値配列にアクセスします。

  • DecoratedText.SwitchControl ウィジェット: StringInputs オブジェクト。selected が true の場合、stringInputs.value にはスイッチの value フィールド(value が指定されていない場合は ""。複数のスイッチが同じ name を共有している場合は、選択された各スイッチの value がリストに含まれます)が含まれます。selected が false の場合、スイッチの value は stringInputs.value から省略されます。

  • 日時選択ツール(DateTimePickerType.DATE_AND_TIME): DateTimeInput object。

例: name が myDTPicker の選択ツールの場合は、e.commonEventObject.formInputs.myDTPicker.dateTimeInput を使用して DateTimeInput オブジェクトにアクセスします。

  • 日付のみの選択ツール(DateTimePickerType.DATE_ONLY): DateInput object。

例: name が myDatePicker の選択ツールの場合は、e.commonEventObject.formInputs.myDatePicker.dateInput を使用して DateInput オブジェクトにアクセスします。

  • 時刻のみの選択ツール(DateTimePickerType.TIME_ONLY): TimeInput object。

例: name が myTimePicker の選択ツールの場合は、e.commonEventObject.formInputs.myTimePicker.timeInput を使用して TimeInput オブジェクトにアクセスします。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

parameters

map (key: string, value: string)

actionParameters または Action.setParameters() を使用してアクションに指定する追加のパラメータ。

デベロッパー プレビュー: Google Chat を拡張するアドオンで、ユーザーが複数選択メニューに入力した内容に基づいて項目を提案するには、"autocomplete_widget_query" キー(event.commonEventObject.parameters["autocomplete_widget_query"])の値を使用します。この値を使用してデータベースにクエリを実行し、ユーザーが入力した内容に基づいて選択可能な項目を提案できます。詳しくは、Google Chat ユーザーから情報を収集して処理するをご覧ください。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

invokedFunction

string

呼び出す関数の名前。

このフィールドは、Google Chat を拡張する Google Workspace アドオンには入力されません。代わりに、識別子などの関数データを受信するには、Chat を拡張するアドオンで parameters フィールドを使用する必要があります。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

string

IANA TZ タイムゾーン データベース コード(「America/Toronto」など)。

offset

integer

ユーザーのタイムゾーンの協定世界時(UTC)からのオフセット(ミリ秒単位)。

入力

ユーザーがカードまたはダイアログに入力できるデータの種類。入力タイプは、ウィジェットが受け入れる値のタイプによって異なります。

JSON 表現
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "stringInputs": {
    object (StringInputs)
  },
  "dateTimeInput": {
    object (DateTimeInput)
  },
  "dateInput": {
    object (DateInput)
  },
  "timeInput": {
    object (TimeInput)
  }
  // End of mutually exclusive fields.
}
フィールド
相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
stringInputs

object (StringInputs)

ユーザーがウィジェットに入力した値を表す文字列のリスト。

ウィジェットが 1 つの値のみを受け入れる場合(TextInput ウィジェットなど)、リストには 1 つの文字列オブジェクトが含まれます。ウィジェットが複数の値を受け入れる場合(チェックボックスの SelectionInput ウィジェットなど)、リストには、ユーザーが入力または選択した値ごとに文字列オブジェクトが含まれます。

dateTimeInput

object (DateTimeInput)

日付と時刻の両方を受け入れる DateTimePicker ウィジェットからの日付と時刻の入力値。

dateInput

object (DateInput)

日付値のみを受け入れる DateTimePicker ウィジェットからの日付入力値。

timeInput

object (TimeInput)

時間値のみを受け入れる DateTimePicker ウィジェットからの時間入力値。

相互に排他的なフィールドの終了。

StringInputs

通常のウィジェットの入力パラメータ。単一値ウィジェットの場合は、単一値リストです。チェックボックスなどの複数値ウィジェットの場合、すべての値が表示されます。

JSON 表現
{
  "value": [
    string
  ]
}
フィールド
value[]

string

ユーザーが入力した文字列のリスト。

DateTimeInput

日付と時刻の入力値。

JSON 表現
{
  "msSinceEpoch": string,
  "hasDate": boolean,
  "hasTime": boolean
}
フィールド
msSinceEpoch

string (int64 format)

エポックからの時間(ミリ秒単位)。

hasDate

boolean

datetime 入力にカレンダーの日付が含まれているかどうか。

hasTime

boolean

datetime 入力にタイムスタンプが含まれているかどうか。

DateInput

日付の入力値。

JSON 表現
{
  "msSinceEpoch": string
}
フィールド
msSinceEpoch

string (int64 format)

エポックからの時間(ミリ秒単位)。

TimeInput

時間入力値。

JSON 表現
{
  "hours": integer,
  "minutes": integer
}
フィールド
hours

integer

24 時間形式の時刻。

minutes

integer

1 時間あたりの分数。有効な値は 0 ~ 59 です。

AuthorizationEventObject

アドオン リクエストの認可情報をカプセル化します。

JSON 表現
{
  "userOAuthToken": string,
  "userIdToken": string,
  "systemIdToken": string,
  "authorizedScopes": [
    string
  ]
}
フィールド
userOAuthToken

string

リクエストされたスコープで認可されたエンドユーザーの OAuth アクセス トークン。(OAuth 同意のアンバンドル後は、エンドユーザーが承認したスコープで承認されます)

userIdToken

string

エンドユーザー ID トークン(適切な ID スコープがリクエストされている場合)

systemIdToken

string

このデプロイの G Suite アドオン サービス アカウントの ID トークン

authorizedScopes[]

string

ユーザーが承認した OAuth スコープのリスト。

CalendarEventObject

カレンダー イベント オブジェクトは、ユーザーのカレンダーとカレンダーの予定に関する情報を保持する、全体的なイベント オブジェクトの一部です。ホスト アプリケーションが Google カレンダーの場合にのみ、イベント オブジェクトに存在します。

次の表に、イベント オブジェクトの calendar フィールドに存在するフィールドを示します。ユーザー作成データとしてマークされたフィールドは、データがカレンダーの予定に存在し、アドオンが addOns.calendar.currentEventAccess マニフェスト フィールドを READ または READ_WRITE に設定している場合にのみ、イベント オブジェクトに存在します。

JSON 表現
{
  "id": string,
  "recurringEventId": string,
  "calendarId": string,
  "organizer": {
    object (Organizer)
  },
  "attendees": [
    {
      object (Attendee)
    }
  ],
  "conferenceData": {
    object (ConferenceData)
  },
  "capabilities": {
    object (Capabilities)
  }
}
フィールド
id

string

イベント ID。

recurringEventId

string

定期的な予定の ID。

calendarId

string

カレンダー ID。

organizer

object (Organizer)

予定の主催者を表すオブジェクト。

attendees[]

object (Attendee)

ユーザー作成データ。カレンダーの予定の参加者のリスト。

conferenceData

object (ConferenceData)

ユーザー作成データ。この予定に関連付けられている会議データ(Google Meet の会議の詳細など)を表すオブジェクト。

capabilities

object (Capabilities)

ユーザー作成データ。予定情報の表示または更新を行うアドオンの機能を記述するオブジェクト。

管理者

JSON 表現
{
  "email": string
}
フィールド
email

string

予定の主催者のメールアドレス。

参加者

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

string

参加者のメールアドレス。

displayName

string

参加者の表示名。

organizer

boolean

参加者がこの予定の主催者である場合は true。

self

boolean

この参加者が、この予定が表示されるカレンダーを表す場合は true、それ以外の場合は false。

resource

boolean

参加者が会議室や機器などのリソースを表す場合は true、それ以外の場合は false。

optional

boolean

この参加者の出席が任意としてマークされている場合は true、そうでない場合は false。

responseStatus

string

参加者の返信ステータス。有効な値は次のとおりです。

  • accepted: 参加者が予定への招待を承諾しました。
  • declined: 参加者が予定への招待を辞退しました。
  • needsAction: 参加者は予定の招待状に返信していません。
  • tentative: 参加者は予定への招待を仮承諾しています。
comment

string

参加者の返信コメント(ある場合)。

additionalGuests

integer

参加者が同伴すると回答した追加のゲストの数。デフォルトは 0 です。

ConferenceData

会議データ オブジェクトには、Google カレンダーの予定に添付された会議に関する情報が含まれます。これには、Google Meet などの Google の会議ソリューションや、サードパーティの会議ソリューションを使用できます。この情報は、データがカレンダーの予定に存在し、アドオンが addOns.calendar.currentEventAccess マニフェスト フィールドを READ または READ_WRITE に設定している場合にのみ、イベント オブジェクトに存在します。

JSON 表現
{
  "conferenceId": string,
  "conferenceSolution": {
    object (ConferenceSolution)
  },
  "entryPoints": [
    {
      object (EntryPoint)
    }
  ],
  "notes": string,
  "parameters": {
    object (Parameters)
  }
}
フィールド
conferenceId

string

会議の ID。この ID は、アプリケーションが会議を追跡できるようにするためのものです。この ID をユーザーに表示しないでください。

conferenceSolution

object (ConferenceSolution)

会議ソリューション(ハングアウトや Google Meet など)を表すオブジェクト。

entryPoints[]

object (EntryPoint)

会議のエントリ ポイント(URL や電話番号など)のリスト。

notes

string

会議に関する追加のメモ(ドメイン管理者からの指示や法的通知など)をユーザーに表示します。HTML を含めることができます。最大長は 2,048 文字です。

parameters

object (Parameters)

アドオンで使用する定義済みパラメータ データのマップを含むオブジェクト。

ConferenceSolution

JSON 表現
{
  "iconUri": string,
  "key": {
    object (Key)
  },
  "name": string
}
フィールド
iconUri

string

この会議ソリューションを表す、ユーザーに表示されるアイコンの URI。

key

object (Key)

この予定の会議ソリューションを一意に識別するキー。

name

string

この会議ソリューションのユーザーに表示される名前(ローカライズされていない)。

キー

JSON 表現
{
  "type": string
}
フィールド
type

string

会議ソリューションのタイプ。有効な値は次のとおりです。

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

string

会議へのアクセスに使用されるアクセスコード。最大長は 128 文字です。通常、会議プロバイダは、会議へのアクセスを提供するために {accessCode, meetingCode, passcode, password, pin} のサブセットのみを使用します。会議プロバイダが使用するフィールドのみを一致させて表示します。

entryPointType

string

エントリ ポイントのタイプ。使用できる値は次のとおりです。

  • more: 会議に参加するための追加の手順(予備の電話番号など)。会議に設定できるその他のエントリ ポイントは 1 つのみです。設定する場合は、他の種類のエントリ ポイントも 1 つ以上必要です。
  • phone: 電話番号を使用して会議に参加します。会議には 0 個以上の電話エントリ ポイントを設定できます。Google カレンダーには、フォーマットしてアルファベット順に並べ替えた後、最初の 2 つの電話エントリ ポイントのみが表示されます。
  • sip: SIP 経由で会議に参加します。会議に設定できる sip エントリ ポイントは 1 つだけです。
  • video: HTTP 経由で会議に参加します。会議に設定できる動画エントリ ポイントは 1 つだけです。
label

string

エントリ ポイント URI のユーザーに表示されるラベル(ローカライズされていない)。

meetingCode

string

会議へのアクセスに使用された会議コード。最大長は 128 文字です。通常、会議プロバイダは、会議へのアクセスを提供するために {accessCode, meetingCode, passcode, password, pin} のサブセットのみを使用します。会議プロバイダが使用するフィールドのみを一致させて表示します。

passcode

string

会議へのアクセスに使用するパスコード。最大長は 128 文字です。通常、会議プロバイダは、会議へのアクセスを提供するために {accessCode, meetingCode, passcode, password, pin} のサブセットのみを使用します。会議プロバイダが使用するフィールドのみを一致させて表示します。

password

string

会議へのアクセスに使用するパスワード。最大長は 128 文字です。通常、会議プロバイダは、会議へのアクセスを提供するために {accessCode, meetingCode, passcode, password, pin} のサブセットのみを使用します。会議プロバイダが使用するフィールドのみを一致させて表示します。

pin

string

会議へのアクセスに使用される PIN。最大長は 128 文字です。通常、会議プロバイダは、会議へのアクセスを提供するために {accessCode, meetingCode, passcode, password, pin} のサブセットのみを使用します。会議プロバイダが使用するフィールドのみを一致させて表示します。

uri

string

エントリ ポイントの URI。最大長は 1,300 文字です。形式はエントリ ポイントのタイプによって異なります。

  • 詳細: http: または https: スキーマが必要です。
  • phone: tel: スキーマが必要です。URI には、ダイヤル シーケンス全体を含める必要があります(例: 「tel:+12345678900,,,12345678;1234」)。
  • sip: sip: または sips: スキーマが必要です。例: 「sip:12345678@myprovider.com"」。
  • video: http: または https: スキーマが必要です。
regionCode

string

電話番号の地域コード。URI に国コードが含まれていない場合にユーザーが必要とします。値は、公開されている CLDR の地域コードのリストに基づいています。

entryPointFeatures[]

string

エントリ ポイントの機能。現在、これらの機能は電話のエントリ ポイントにのみ適用されます。

  • toll: エントリ ポイントは有料の電話です。
  • toll_free: エントリ ポイントはフリーダイヤルです。

パラメータ

JSON 表現
{
  "addOnParameters": {
    object (AddOnParameters)
  }
}
フィールド
addOnParameters

object (AddOnParameters)

パラメータの文字列キーと値のマップ。これらのキーと値は、アドオンで使用するために特定の会議に情報を添付する目的で、アドオン デベロッパーによって定義されます。

AddOnParameters

JSON 表現
{
  "parameters": {
    string: string,
    ...
  }
}
フィールド
parameters

map (key: string, value: string)

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

機能

JSON 表現
{
  "canSeeAttendees": boolean,
  "canAddAttendees": boolean,
  "canSeeConferenceData": boolean,
  "canSetConferenceData": boolean,
  "canAddAttachments": boolean
}
フィールド
canSeeAttendees

boolean

ユーザーが生成したデータ。アドオンが予定の参加者リストを読み取ることができる場合は true、それ以外の場合は false。

canAddAttendees

boolean

ユーザーが生成したデータ。アドオンが予定の参加者リストに新しい参加者を追加できる場合は true、それ以外の場合は false。

canSeeConferenceData

boolean

ユーザーが生成したデータ。アドオンが予定の会議データを読み取ることができる場合は true、それ以外の場合は false。

canSetConferenceData

boolean

ユーザーが生成したデータ。アドオンが予定の会議データを更新できる場合は true、それ以外の場合は false。

canAddAttachments

boolean

ユーザーが生成したデータ。アドオンが予定に新しい添付ファイルを追加できる場合は true、それ以外の場合は false。

DriveEventObject

ドライブ イベント オブジェクトは、ユーザーの Google ドライブとそのコンテンツに関する情報を保持する、イベント オブジェクト全体の一部です。ホステッド アプリケーションが Google ドライブの場合にのみ、イベント オブジェクトに存在します。

JSON 表現
{
  "selectedItems": [
    {
      object (DriveItemMetadata)
    }
  ],
  "activeCursorItem": {
    object (DriveItemMetadata)
  }
}
フィールド
selectedItems[]

object (DriveItemMetadata)

ドライブで選択されたアイテム(ファイルまたはフォルダ)のリスト。

activeCursorItem

object (DriveItemMetadata)

現在アクティブなドライブ アイテム。

DriveItemMetadata

ドライブ アイテム オブジェクトには、ファイルやフォルダなど、特定のドライブ アイテムに関する情報が含まれます。

JSON 表現
{
  "id": string,
  "iconUrl": string,
  "mimeType": string,
  "title": string,
  "addonHasFileScopePermission": boolean
}
フィールド
id

string

選択したアイテムの ID。

iconUrl

string

選択したアイテムを表すアイコンの URL。

mimeType

string

選択したアイテムの MIME タイプ。

title

string

選択したアイテムのタイトル。

addonHasFileScopePermission

boolean

true の場合、アドオンはこのアイテムの https://www.googleapis.com/auth/drive.file スコープ認可をリクエストして受け取っています。それ以外の場合、このフィールドは false です。

アドオンで https://www.googleapis.com/auth/drive や https://www.googleapis.com/auth/drive.readonly などのより制限の緩いスコープを使用している場合、このフィールドは関係ありません。ユーザー情報を保護するために、アドオンを設計する際は、可能な限り制限の厳しいスコープを使用してください。

GmailEventObject

Gmail イベント オブジェクトは、ユーザーの Gmail メッセージに関する情報を保持する、イベント オブジェクト全体の一部です。ホスト アプリケーションが Gmail の場合にのみ、イベント オブジェクトに存在します。

JSON 表現
{
  "messageId": string,
  "threadId": string,
  "accessToken": string,
  "toRecipients": [
    string
  ],
  "ccRecipients": [
    string
  ],
  "bccRecipients": [
    string
  ]
}
フィールド
messageId

string

現在開いている Gmail メッセージの ID。

threadId

string

現在開いている Gmail スレッドの ID。

accessToken

string

Gmail 固有のアクセス トークン。このトークンを GmailApp.setCurrentMessageAccessToken(accessToken) メソッドで使用すると、ユーザーが現在開いている Gmail メッセージへの一時的なアクセス権をアドオンに付与したり、アドオンで新しい下書きを作成したりできます。

toRecipients[]

string

デフォルトでは無効にされています。アドオンが作成中の下書きに現在含まれている「宛先」の受信者のメールアドレスのリスト。このフィールドを有効にするには、マニフェストの addOns.gmail.composeTrigger.draftAccess フィールドを METADATA に設定する必要があります。

ccRecipients[]

string

デフォルトでは無効にされています。アドオンが作成中の下書きに現在含まれている「CC:」受信者のメールアドレスのリスト。このフィールドを有効にするには、マニフェストの addOns.gmail.composeTrigger.draftAccess フィールドを METADATA に設定する必要があります。

bccRecipients[]

string

デフォルトでは無効にされています。アドオンが作成中の下書きに現在含まれている「BCC:」受信者のメールアドレスのリスト。このフィールドを有効にするには、マニフェストの addOns.gmail.composeTrigger.draftAccess フィールドを METADATA に設定する必要があります。

SheetsEventObject

スプレッドシートのイベント オブジェクトは、ユーザーのドキュメントとそのコンテンツに関する情報を保持する、イベント オブジェクト全体の一部です。アドオンが Google スプレッドシートを拡張する場合にのみ、イベント オブジェクトに存在します。

JSON 表現
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
フィールド
id

string

https://www.googleapis.com/auth/drive.file スコープがユーザーによって承認されている場合にのみ存在します。スプレッドシートの UI で開いているスプレッドシートの ID。

title

string

https://www.googleapis.com/auth/drive.file スコープがユーザーによって承認されている場合にのみ存在します。スプレッドシートの UI で開いているスプレッドシートのタイトル。

addonHasFileScopePermission

boolean

true の場合、アドオンは、スプレッドシートの UI で開いているスプレッドシートの https://www.googleapis.com/auth/drive.file スコープの承認をリクエストして受け取っています。それ以外の場合、このフィールドは false です。

matchedUrl

object (MatchedUrl)

次の条件が満たされている場合にのみ表示されます。

  • https://www.googleapis.com/auth/workspace.linkpreview はユーザーによって承認されています。
  • URL が LinkPreviewTriggers トリガーで指定されたホストパターンと一致する。

Google スプレッドシートでプレビューを生成するリンクの URL。このフィールドを使用するには、アドオンのマニフェストで LinkPreviewTriggers を構成する必要があります。詳しくは、スマートチップを使用してリンクをプレビューするをご覧ください。

ユーザーがリンク https://www.example.com/12345 をプレビューしたときのペイロードの例:

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

MatchedUrl

リンク プレビュー リクエストで返されるイベント オブジェクト。

JSON 表現
{
  "url": string
}
フィールド
url

string

一致した URL。

SlidesEventObject

スライドのイベント オブジェクトは、ユーザーのドキュメントとそのコンテンツに関する情報を保持する、イベント オブジェクト全体の一部です。アドオンが Google スライドを拡張する場合にのみ、イベント オブジェクトに存在します。

JSON 表現
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
フィールド
id

string

https://www.googleapis.com/auth/drive.file スコープがユーザーによって承認されている場合にのみ存在します。スライド UI で開いているプレゼンテーションの ID。

title

string

https://www.googleapis.com/auth/drive.file スコープがユーザーによって承認されている場合にのみ存在します。スライド UI で開いているプレゼンテーションのタイトル。

addonHasFileScopePermission

boolean

true の場合、アドオンは、スライド UI で開いているプレゼンテーションの https://www.googleapis.com/auth/drive.file スコープ認可をリクエストして受信しています。それ以外の場合、このフィールドは false です。

matchedUrl

object (MatchedUrl)

次の条件が満たされている場合にのみ表示されます。

  • https://www.googleapis.com/auth/workspace.linkpreview はユーザーによって承認されています。
  • URL が LinkPreviewTriggers トリガーで指定されたホストパターンと一致する。

Google スライドでプレビューを生成するリンクの URL。このフィールドを使用するには、アドオンのマニフェストで LinkPreviewTriggers を構成する必要があります。詳しくは、スマートチップを使用してリンクをプレビューするをご覧ください。

ユーザーがリンク https://www.example.com/12345 をプレビューしたときのペイロードの例:

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

DocsEventObject

Google ドキュメントのイベント オブジェクトは、ユーザーのドキュメントとそのコンテンツに関する情報を保持する、イベント オブジェクト全体の一部です。アドオンが Google ドキュメントを拡張する場合にのみ、イベント オブジェクトに存在します。

JSON 表現
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
フィールド
id

string

https://www.googleapis.com/auth/drive.file スコープがユーザーによって承認されている場合にのみ存在します。ドキュメント UI で開いているドキュメントの ID。

title

string

https://www.googleapis.com/auth/drive.file スコープがユーザーによって承認されている場合にのみ存在します。ドキュメント UI で開いているドキュメントのタイトル。

addonHasFileScopePermission

boolean

true の場合、アドオンは、ドキュメント UI で開いているドキュメントの https://www.googleapis.com/auth/drive.file スコープ認可をリクエストして受け取っています。それ以外の場合、このフィールドは false です。

matchedUrl

object (MatchedUrl)

次の条件が満たされている場合にのみ表示されます。

  • https://www.googleapis.com/auth/workspace.linkpreview はユーザーによって承認されています。
  • URL が LinkPreviewTriggers トリガーで指定されたホストパターンと一致する。

Google ドキュメントでプレビューを生成するリンクの URL。このフィールドを使用するには、アドオンのマニフェストで LinkPreviewTriggers を構成する必要があります。詳しくは、スマートチップを使用してリンクをプレビューするをご覧ください。

ユーザーがリンク https://www.example.com/12345 をプレビューしたときのペイロードの例:

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

ChatEventObject

Google サーバーからアドオンに送信される Google Chat アプリのイベント オブジェクト ペイロード。ペイロードを使用して、イベントのタイプを識別できます。

JSON 表現
{
  "type": enum (EventType),
  "user": {
    object (User)
  },
  "space": {
    object (Space)
  },
  "eventTime": string,

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

enum (EventType)

イベントのタイプ。アドオンではない Chat アプリのアプリホーム イベントの場合のみ入力されます。

user

object (User)

Chat 用アプリを操作するユーザー。

space

object (Space)

イベントが発生したスペース。アドオンではない Chat アプリの App Home イベントの場合にのみ入力されます。

eventTime

string (Timestamp format)

イベント オブジェクトが発生した日時を示すタイムスタンプ。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。

イベント オブジェクトのペイロード。ペイロードはイベント オブジェクト タイプによって異なります。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
messagePayload

object (MessagePayload)

ユーザーが Chat 用アプリにメッセージを送信するか、スペースで Chat 用アプリに @メンションを付けます。アプリコマンドの呼び出し(スラッシュ コマンドやクイック コマンドなど)は、代わりに appCommandPayload で配信されます。

addedToSpacePayload

object (AddedToSpacePayload)

ユーザーが Chat スペースに Chat アプリを追加するか、Google Workspace 管理者が組織内のユーザーのダイレクト メッセージ スペースに Chat アプリをインストールします。

removedFromSpacePayload

object (RemovedFromSpacePayload)

ユーザーがスペースから Chat アプリを削除した。

buttonClickedPayload

object (ButtonClickedPayload)

ユーザーが Action コールバックをトリガーするカードまたはダイアログのインタラクティブ要素を操作したときのペイロード データを表します。このペイロードは、ボタンのクリックだけでなく、onChangeAction トリガー、onClick アクション、CardAction クリック、ダイアログの送信またはキャンセル(SUBMIT_DIALOG と CANCEL_DIALOG)など、すべてのカードとダイアログの Action コールバックに入力されます。

ユーザーがダイアログを操作すると、ButtonClickedPayload の isDialogEvent フィールドが true に設定され、DialogEventType が含まれます。

完全なペイロードには commonEventObject.formInputs と commonEventObject.parameters も含まれます。

widgetUpdatedPayload

object (WidgetUpdatedPayload)

ユーザーがインストリーム カードまたはダイアログでウィジェットを更新する。

完全なペイロードには CommonEventObject.parameters['autocomplete_widget_query'] も含まれます。

appCommandPayload

object (AppCommandPayload)

ユーザーがアプリコマンドを呼び出します。

systemCommandPayload

object (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)
  },
  "message": {
    object (Message)
  },
  "configCompleteRedirectUri": string
}
フィールド
space

object (Space)

必須。イベント オブジェクトが発生する Chat スペース。

message

object (Message)

イベント オブジェクトをトリガーするメッセージ。

configCompleteRedirectUri

string

省略可。Google Chat の外部で承認フローまたは設定フローを完了した後に、Chat 用アプリがユーザーをリダイレクトする URL。詳しくは、Chat 用アプリを他のサービスやツールに接続するをご覧ください。

AddedToSpacePayload

ユーザーが Chat アプリをスペースに追加するか、アプリとユーザーの間の DM が作成されます。

JSON 表現
{
  "space": {
    object (Space)
  },
  "interactionAdd": boolean,
  "configCompleteRedirectUri": string
}
フィールド
space

object (Space)

必須。イベント オブジェクトが発生する Chat スペース。

interactionAdd

boolean

ユーザーの操作(Chat 用アプリに名前リンクを付ける、スラッシュ コマンドで呼び出すなど)によってアプリがスペースに追加されたかどうか。これを true に設定すると、インタラクション自体に関連付けられた個別のイベント オブジェクトが Chat 用アプリにディスパッチされます。

configCompleteRedirectUri

string

省略可。Google Chat の外部で承認フローまたは設定フローを完了した後に、Chat 用アプリがユーザーをリダイレクトする URL。詳しくは、Chat 用アプリを他のサービスやツールに接続するをご覧ください。

RemovedFromSpacePayload

ユーザーがスペースから Chat アプリを削除した。

JSON 表現
{
  "space": {
    object (Space)
  }
}
フィールド
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)
  },
  "message": {
    object (Message)
  },
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType)
}
フィールド
space

object (Space)

必須。イベント オブジェクトが発生する Chat スペース。

message

object (Message)

イベント オブジェクトをトリガーするメッセージ。

isDialogEvent

boolean

ButtonClicked イベント オブジェクトと Message イベント オブジェクトの場合、ユーザーがダイアログを操作しているか、操作しようとしているかどうか。

dialogEventType

enum (DialogEventType)

受信したダイアログ イベント オブジェクトのタイプ。

DialogEventType

ButtonClicked または AppCommand イベント ペイロードを含むイベント オブジェクトの場合、ダイアログとのインタラクションのタイプ。

Google Chat アプリのイベント オブジェクトについて詳しくは、Google Chat アプリとのインタラクションを受信して応答するをご覧ください。

列挙型
DIALOG_EVENT_TYPE_UNSPECIFIED デフォルト値。指定なし。
REQUEST_DIALOG ユーザーがダイアログを開く。
SUBMIT_DIALOG ユーザーがダイアログのインタラクティブ要素をクリックした。たとえば、ユーザーがダイアログに情報を入力し、ボタンをクリックして情報を送信します。
CANCEL_DIALOG ユーザーが情報を送信せずにダイアログを閉じたか、ダイアログがキャンセルされました。

WidgetUpdatedPayload

ユーザーがインストリーム カードまたはダイアログでウィジェットを更新する。

完全なペイロードには CommonEventObject.parameters['autocomplete_widget_query'] も含まれます。

JSON 表現
{
  "space": {
    object (Space)
  }
}
フィールド
space

object (Space)

必須。イベント オブジェクトが発生する Chat スペース。

AppCommandPayload

ユーザーがアプリコマンドを呼び出します。

JSON 表現
{
  "appCommandMetadata": {
    object (AppCommandMetadata)
  },
  "space": {
    object (Space)
  },
  "thread": {
    object (Thread)
  },
  "message": {
    object (Message)
  },
  "configCompleteRedirectUri": string,
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType)
}
フィールド
appCommandMetadata

object (AppCommandMetadata)

スラッシュ コマンドやクイック コマンドなどのアプリコマンドの場合に設定されます。

space

object (Space)

省略可。イベント オブジェクトが発生する Chat スペース。

thread

object (Thread)

省略可。イベント オブジェクトが発生するスレッド(該当する場合)。このフィールドは、イベント オブジェクトが特定のメッセージまたはスレッドに関連付けられている場合に入力されます。

message

object (Message)

省略可。イベント オブジェクトをトリガーするメッセージ(該当する場合)。このフィールドは、スラッシュ コマンドの場合にのみ入力されます。

configCompleteRedirectUri

string

省略可。Google Chat の外部で承認または構成フローを完了した後にユーザーがリダイレクトされる URL。詳しくは、Chat 用アプリを他のサービスやツールに接続するをご覧ください。

isDialogEvent

boolean

省略可。ユーザーがダイアログを操作しているか、操作しようとしているかどうか。

dialogEventType

enum (DialogEventType)

省略可。受信した dialog イベント オブジェクトのタイプ。このフィールドは、isDialogEvent が true の場合にのみ適用されます。

AppCommandMetadata

Chat アプリコマンドに関するメタデータ。

JSON 表現
{
  "appCommandId": integer,
  "appCommandType": enum (AppCommandType)
}
フィールド
appCommandId

integer

Chat API 構成で指定されたコマンドの ID。

appCommandType

enum (AppCommandType)

Chat アプリのコマンドのタイプ。

AppCommandType

Chat アプリのコマンドのタイプ。詳しくは、Chat 用アプリのコマンドの種類をご覧ください。

列挙型
APP_COMMAND_TYPE_UNSPECIFIED デフォルト値。指定なし。
SLASH_COMMAND スラッシュ コマンド。ユーザーがチャット メッセージでコマンドを送信します。
QUICK_COMMAND クイック コマンド。ユーザーがメッセージ返信エリアの Chat メニューからコマンドを選択する。
MESSAGE_ACTION メッセージ アクション。ユーザーが Chat のメッセージ コンテキスト メニューからコマンドを選択します。

SystemCommandPayload

ユーザーがシステム コマンドを呼び出す。

JSON 表現
{
  "systemCommandMetadata": {
    object (SystemCommandMetadata)
  },
  "space": string,
  "thread": {
    object (Thread)
  }
}
フィールド
systemCommandMetadata

object (SystemCommandMetadata)

呼び出されたシステムコマンドに関するメタデータ。

space

string

省略可。イベント オブジェクトが発生する Chat スペース。

thread

object (Thread)

省略可。イベント オブジェクトが発生するスレッド(該当する場合)。このフィールドは、イベント オブジェクトが特定のメッセージまたはスレッドに関連付けられている場合に入力されます。

SystemCommandMetadata

ユーザーによってトリガーされるシステム コマンドに関するメタデータ。

JSON 表現
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "cancelStream": {
    object (CancelStream)
  }
  // End of mutually exclusive fields.
}
フィールド
呼び出されたシステム コマンド。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
cancelStream

object (CancelStream)

アクティブなストリーム メッセージをキャンセルするコマンド。

相互に排他的なフィールドの終了。

CancelStream

アクティブなストリーム メッセージをキャンセルするコマンド。

JSON 表現
{
  "streamMessage": string
}
フィールド
streamMessage

string

必須。キャンセル コマンドが実行されたストリーム メッセージのリソース名。

形式: spaces/{space}/streamMessages/{streamMessage}

WorkflowEventObject

LINT.IfChange ワークフロー アドオンに渡されるイベント オブジェクト。

JSON 表現
{
  "executionMetadata": {
    object (ExecutionMetadata)
  },
  "triggerEventSource": enum (TriggerEventSource),

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

object (ExecutionMetadata)

ワークフローの実行に関するメタデータ。

triggerEventSource

enum (TriggerEventSource)

トリガー イベントのソース。

ワークフロー イベント ペイロードのタイプ。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
actionInvocation

object (ActionInvocation)

ワークフロー アクションの呼び出し。

triggerCreation

object (TriggerCreation)

ワークフロー トリガーの作成。

triggerDeletion

object (TriggerDeletion)

ワークフロー トリガーの削除。

resourceRetrieval

object (ResourceRetrieval)

リソースの取得(変数のインフレーションに使用)。

elementConfiguration

object (ElementConfiguration)

ワークフロー要素の構成。

resourceFieldsDefinitionRetrieval

object (ResourceFieldsDefinitionRetrieval)

リソースでサポートされているフィールド定義の取得。

elementUiAutocomplete

object (ElementUiAutocomplete)

現在レンダリングされているカードの予測入力の候補。

相互に排他的なフィールドの終了。

ActionInvocation

ワークフロー アクションの呼び出し。

JSON 表現
{
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "triggerId": string,
  "flowLevelContext": {
    object (FlowLevelContext)
  }
}
フィールド
inputs

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

入力変数名をキーとする入力変数のマップ。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

triggerId

string

非同期アクションのレスポンスに使用するトリガー ID。

flowLevelContext

object (FlowLevelContext)

省略可。前のステップからのフローレベルのコンテキスト。

VariableData

変数データを表します。変数データには、異なる型の複数の値を保持できます。

JSON 表現
{
  "booleanValues": [
    boolean
  ],
  "integerValues": [
    string
  ],
  "floatValues": [
    number
  ],
  "stringValues": [
    string
  ],
  "timestampValues": [
    string
  ],
  "resourceReferences": [
    {
      object (ResourceReference)
    }
  ],
  "emailAddressValues": [
    string
  ],
  "googleUserValues": [
    string
  ],
  "textFormatValues": [
    {
      object (WorkflowTextFormat)
    }
  ]
}
フィールド
booleanValues[]

boolean

ブール値。

integerValues[]

string (int64 format)

整数値。

floatValues[]

number

浮動小数点値。

stringValues[]

string

文字列値。

timestampValues[]

string (Timestamp format)

タイムスタンプ値。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。

resourceReferences[]

object (ResourceReference)

リソース参照(ID)。

emailAddressValues[]

string

メールアドレスの値。

googleUserValues[]

string

Google ユーザーの値(users/{user} 形式)。

textFormatValues[]

object (WorkflowTextFormat)

ワークフローのテキスト形式の値。

ResourceReference

アプリケーション固有のリソースの ID 値。

JSON 表現
{
  "resourceType": {
    object (ResourceType)
  },
  "resourceId": string
}
フィールド
resourceType

object (ResourceType)

この ID が指すリソースのタイプ。

resourceId

string

リソースの ID。

ResourceType

カスタム リソースタイプの名前。

JSON 表現
{
  "workflowBundleId": string,
  "workflowResourceDefinitionId": string
}
フィールド
workflowBundleId

string

このリソースタイプを所有するワークフロー バンドルの ID。これは省略可能です。空の場合、使用されているバンドルと同じバンドルと見なされます。

workflowResourceDefinitionId

string

リソースの固有識別子。これは、同じバンドル内で一意である必要があります。

WorkflowTextFormat

スタイル、ハイパーリンク、インタラクティブ要素などのリッチな書式設定オプションを含むテキスト ブロック。

JSON 表現
{
  "textFormatElements": [
    {
      object (TextFormatElement)
    }
  ]
}
フィールド
textFormatElements[]

object (TextFormatElement)

テキスト形式の要素のコレクション。

TextFormatElement

WorkflowTextFormat メッセージ内の単一の要素。チップ、スタイル付きテキスト、ハイパーリンク、リストコンテナなどがあります。

JSON 表現
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "text": string,
  "chip": {
    object (Chip)
  },
  "styledText": {
    object (StyledText)
  },
  "hyperlink": {
    object (Hyperlink)
  },
  "listContainer": {
    object (ListContainer)
  }
  // End of mutually exclusive fields.
}
フィールド
複数のテキスト形式要素のいずれかを表す要素。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
text

string

テキスト形式のテキスト。

chip

object (Chip)

テキスト形式のクリック可能なチップ。

styledText

object (StyledText)

テキスト形式のスタイル付きテキスト。

listContainer

object (ListContainer)

テキスト形式のリストコンテナ。

相互に排他的なフィールドの終了。

チップ

テキスト形式のクリック可能なチップ。

JSON 表現
{
  "icon": {
    object (Icon)
  },
  "label": string,
  "url": string
}
フィールド
icon

object (Icon)

チップに表示されるアイコン。

label

string

チップに表示されるテキスト。

url

string

チップがクリックされたときに移動する URL。

アイコン

チップ内のアイコン。

JSON 表現
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "iconUrl": string,
  "materialIconName": string
  // End of mutually exclusive fields.
}
フィールド
チップに表示されるアイコン。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
iconUrl

string

HTTPS URL でホストされているカスタム アイコンを表示する。

次に例を示します。

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

サポートされているファイル形式は .png と .jpg です。

materialIconName

string

Google マテリアル アイコンで定義されているアイコン名(例: check_box)。無効な名前は破棄され、空の文字列に置き換えられます。その結果、アイコンはレンダリングされません。

相互に排他的なフィールドの終了。

StyledText

太字、斜体、色などのスタイルが設定されたテキスト要素。

JSON 表現
{
  "text": string,
  "styles": [
    enum (Style)
  ],
  "fontWeight": enum (FontWeight),
  "color": {
    object (Color)
  },
  "wrapStyle": enum (WrapStyle)
}
フィールド
text

string

テキストのメイン コンテンツ。

styles[]

enum (Style)

テキストに適用されるスタイルのコレクション。

fontWeight

enum (FontWeight)

テキストのフォントの太さ。

color

object (Color)

テキストの色。

wrapStyle

enum (WrapStyle)

テキストの折り返しスタイル。

スタイル

斜体、下線など、さまざまなテキスト スタイルの列挙型。

列挙型
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 折り返しスタイルなし。

ListContainer

リストアイテムのコンテナ。各リストアイテムには複数の TextFormatElement を含めることができます。

JSON 表現
{
  "listNestLevel": string,
  "listType": enum (ListType),
  "listItems": [
    {
      object (ListItem)
    }
  ]
}
フィールド
listNestLevel

string (int64 format)

リストのネストレベル。最上位レベルは 0 から始まり、ネストされたリストごとに 1 ずつ増加します。

listType

enum (ListType)

リストのタイプ。

listItems[]

object (ListItem)

リストアイテムのコレクション。

ListType

さまざまなリストタイプの列挙型。

列挙型
LIST_TYPE_UNSPECIFIED リストタイプが指定されていません。使用しないでください。
ORDERED 順序付きリスト。
UNORDERED 順序なしリスト。
BLOCKQUOTE 引用リストを表します。

ListItem

リストアイテム。

JSON 表現
{
  "textFormatElements": [
    {
      object (TextFormatElement)
    }
  ]
}
フィールド
textFormatElements[]

object (TextFormatElement)

テキスト形式の要素のコレクション。

FlowLevelContext

前のステップの出力を含むフローレベルのコンテキスト。

JSON 表現
{
  "stepContexts": [
    {
      object (StepContext)
    }
  ]
}
フィールド
stepContexts[]

object (StepContext)

省略可。前のステップのリスト。順序が重要であるため、このリストで実行順序が維持されていることを確認してください。

StepContext

フローレベルのコンテキストのステップ コンテキスト メタデータと出力。

JSON 表現
{
  "stepId": string,
  "outputs": {
    string: {
      object (VariableData)
    },
    ...
  }
}
フィールド
stepId

string

省略可。ワークフロー グラフ内のステップの一意の ID。

outputs

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

省略可。このステップで生成された出力変数のマップ。変数名をキーとして使用します。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

TriggerCreation

ワークフロー トリガーの作成。

JSON 表現
{
  "triggerId": string,
  "triggerType": enum (TriggerType),
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "notifyUri": string
}
フィールド
triggerId

string

作成時に指定されたトリガーの固有識別子。

triggerType

enum (TriggerType)

トリガーのタイプ。

inputs

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

入力変数名をキーとする入力変数のマップ。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

notifyUri

string

トリガーが起動したときに呼び出されるエンドポイント。

TriggerType

トリガーのタイプ。

列挙型
TRIGGER_TYPE_UNDEFINED デフォルト値。使用しないでください。
REPEATING トリガーは、入力条件が満たされるたびに起動します。

TriggerDeletion

ワークフロー トリガーの削除。

JSON 表現
{
  "triggerId": string
}
フィールド
triggerId

string

作成時に指定されたトリガーの固有識別子。

ResourceRetrieval

リソースの取得。

JSON 表現
{
  "resourceReference": {
    object (ResourceReference)
  }
}
フィールド
resourceReference

object (ResourceReference)

取得するリソースのタイプと ID。

ElementConfiguration

ワークフロー要素を構成する際の呼び出し。

JSON 表現
{
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "displayDestination": enum (DisplayDestination),
  "nodeId": string,
  "workflowId": string,
  "availableVariables": [
    {
      object (VariableReference)
    }
  ]
}
フィールド
inputs

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

入力変数名でキー設定された入力変数のマップ。このマップは空の場合があります。ワークフロー ホームで単一のワークフロー要素(トリガーまたはアクション)を構成するときに使用されます。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

displayDestination

enum (DisplayDestination)

要素構成カードの宛先。要素はこのフィールドを使用して、宛先に基づいて異なる構成カード レイアウトを返すことができます。

nodeId

string

レンダリングされるプリミティブ構成のノード ID。

workflowId

string

レンダリングされるプリミティブ構成のワークフロー ID。

availableVariables[]

object (VariableReference)

ノードの位置で並べ替えられた使用可能な変数。

DisplayDestination

返品要素構成カードが表示される場所を示します。

列挙型
DISPLAY_DESTINATION_UNSPECIFIED デフォルト値。使用しないでください。
DISPLAY_DESTINATION_SIDE_PANEL 設定カードはサイドパネルに表示されます。
DISPLAY_DESTINATION_FULL_SCREEN 設定カードは全画面表示アプリに表示されます。

VariableReference

ワークフロー内の変数への変数参照。

JSON 表現
{
  "parentElementId": string,
  "nodeId": string,
  "path": string,
  "dataType": {
    object (DataType)
  },
  "iconUrl": string,
  "stepNumber": integer,
  "descriptionText": string,
  "displayText": string
}
フィールド
parentElementId

string

変数を生成する要素のプリミティブ ID。必要に応じて、WorkflowElement またはより詳細なメタデータ proto に拡張できます。

nodeId

string

ノード参照 ID

path

string

変数セレクタのパスのシグネチャ

dataType

object (DataType)

変数のデータ型

iconUrl

string

この変数を生成するプリミティブのアイコン URL。

stepNumber

integer

この変数を生成するプリミティブのステップ番号。

descriptionText

string

変数の説明。

displayText

string

変数チップの表示テキスト。

DataType

変数の型。

JSON 表現
{
  "valueMetadata": {
    object (ValueMetadata)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "basicType": enum (BasicType),
  "resourceType": {
    object (ResourceType)
  }
  // End of mutually exclusive fields.
}
フィールド
valueMetadata

object (ValueMetadata)

変数の潜在的な値に関するメタデータ。

データの種類。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
basicType

enum (BasicType)

基本データ型。

resourceType

object (ResourceType)

アプリケーション リソース 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 (BasicType)
  ],
  "semanticDescriptors": [
    {
      object (SemanticDescriptor)
    }
  ],
  "dynamicSchema": {
    object (DynamicSchema)
  },
  "defaultValue": string
}
フィールド
enumValues[]

string

省略可。文字列に許可される値を指定します。これは、DataType が STRING の場合にのみ設定できます。

dynamicTypes[]

enum (BasicType)

省略可。変数に動的にキャストできる許可された型を指定します。これは、DataType が String で、変数が出力の場合にのみ設定できます。

semanticDescriptors[]

object (SemanticDescriptor)

省略可。変数の意味を説明するのに役立ちます。

dynamicSchema

object (DynamicSchema)

省略可。この変数のスキーマを動的に解決するための構成。

defaultValue

string

省略可。この変数のデフォルト値を指定する文字列。たとえば、ブール値の場合、defaultValue は true または false に設定できます。

SemanticDescriptor

変数の意味に関するメタデータ。

JSON 表現
{
  "resourceAttribute": string,
  "disallowedResourceAttributes": [
    string
  ]
}
フィールド
resourceAttribute

string

変数がリソースの特定の属性に対応していることを示します。これは、リソースの識別子(ID、URL、キーなど)を表す変数に特に役立ちます。

推奨される形式は次のとおりです。- "{brand}/{appName}/{resource}:{attribute}" {brand} は省略可能で、{appName} と同じ場合は省略する必要があります。

例: - "google/drive/file:id" - "google/drive/folder:id" - "google/docs/document:id" - "google/sheets/spreadsheet:id" - "jira/issue:key" - "slack/channel:id" など。

クライアントは、この情報を使用して、特定の入力と互換性のある出力変数をユーザーにヒントとして提供します。

disallowedResourceAttributes[]

string

省略可。入力にのみ適用され、出力では無視されます。このセマンティック記述子に対応する、許可されていない属性。クライアントは、これらの許可されていないリソース属性に対応する出力の変数選択を明示的に防止します。

DynamicSchema

実行時にこの変数のスキーマを動的に解決するための構成。

JSON 表現
{
  "requiredInputIds": [
    string
  ],
  "strictEnum": boolean
}
フィールド
requiredInputIds[]

string

この変数のスキーマを動的に解決する前に指定する必要がある、兄弟入力変数の ID。

strictEnum

boolean

true の場合、変数の値は、動的に解決された列挙値のいずれかと一致する必要があります。false の場合、動的に解決された値は厳密でない候補として扱われます。

ResourceFieldsDefinitionRetrieval

リソースでサポートされているフィールドの定義を取得します。

JSON 表現
{
  "elementId": string,
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  }
}
フィールド
elementId

string

動的リソース スキーマを取得する要素の ID を指定します。

inputs

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

これは、変数を提供するノードのフィールド入力で構成されます。入力変数名をキーとする入力変数のマップ。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

ElementUiAutocomplete

現在レンダリングされているカードの予測入力の候補。

JSON 表現
{
  "query": string,
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "invokedFunction": string,
  "resourceId": string,
  "operationId": string
}
フィールド
query

string

予測入力するクエリ。

inputs

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

入力変数名をキーとする入力変数のマップ。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

invokedFunction

string

ウィジェットに関連付けられた呼び出し関数。

resourceId

string

予測入力の対象となるリソース ID。これは省略可能なフィールドであり、設定されない場合があります。

operationId

string

予測入力するリソースを提供したオペレーションの ID。これは省略可能なフィールドであり、設定されない場合があります。

ExecutionMetadata

ワークフローの実行に関するメタデータ。

JSON 表現
{
  "versionId": integer,
  "timeZone": string,
  "stepNumber": integer
}
フィールド
versionId

integer

呼び出されるワークフロー要素のバージョン。

timeZone

string

保存されるワークフローのタイムゾーン(例: America/Los_Angeles)。

stepNumber

integer

呼び出されるプリミティブのステップ番号を表します。

TriggerEventSource

この実行をトリガーしたトリガー イベントのソース。

列挙型
TRIGGER_EVENT_SOURCE_UNSPECIFIED デフォルト値。使用しないでください。
TRIGGER_EVENT_SOURCE_AUTOMATED 実行はイベントによって自動的にトリガーされます。
TRIGGER_EVENT_SOURCE_TEST_RUN 実行はテスト実行によってトリガーされます。