イベント オブジェクト

このページでは、Google Workspace アドオンのイベント オブジェクトの構造について概説します。

イベント オブジェクトは JSON 構造で、ユーザーがアドオンを操作すると自動的に作成され、トリガー関数またはコールバック関数にパラメータとして渡されます。イベント オブジェクトは、ホストアプリと現在のコンテキストに関するクライアントサイド情報をアドオンのサーバーサイド コールバック関数に渡します。

Google Workspace アドオンでは、イベント オブジェクトが次の場所で使用されます。

  • ホームページ トリガー。ホームページ トリガー関数がトリガーされると、定義したすべての homepageTrigger 関数にイベント オブジェクトが自動的に渡されます。このオブジェクトは、ホームページ トリガー関数で使用して、アクティブなホストアプリ、クライアントのプラットフォーム、ユーザーの言語 / 地域などの情報を特定できます。

    ホームページのトリガーが実行されたときに作成されるイベント オブジェクトには、他の 2 つのケースに含まれるすべてのフィールドが含まれているわけではありません。ウィジェットとコンテキスト情報に関連するフィールドは省略されます。

  • コンテキスト トリガー。各ホスト アプリケーションは、ユーザーが特定のコンテキストに入ったときにトリガーされる一連のコンテキスト トリガーを提供します。次に例を示します。

    コンテキスト トリガーがトリガーされると、ホスト アプリケーションはアドオン マニフェストにリストされている対応する runFunction を呼び出し、イベント オブジェクトをパラメータとして渡します。コンテキスト トリガーがトリガーされたときに作成されるイベント オブジェクトには、ホームページ トリガーのイベント オブジェクトに含まれるすべてのフィールドに加え、コンテキスト情報が含まれるフィールドが含まれています。

  • ウィジェットのアクション。イベント オブジェクトは、Gmail アドオンで使用されているのと同じアクション モデルを使用して、ウィジェットのインタラクティビティを提供するためにも使用されます。Google Workspace アドオンは、同じウィジェット ハンドラ関数、Action オブジェクト、アクション レスポンスをすべて使用します。ただし、Google Workspace アドオンのアクション イベント オブジェクトには、コールバック関数が処理できるさらに多くの情報が含まれています。

    ウィジェット アクションの結果として作成されるイベント オブジェクトには、コンテキスト トリガー イベント オブジェクトに含まれるすべてのフィールドと、ウィジェット情報を含むフィールドが含まれます。

  • プレビュー リンク トリガー。Google ドキュメント、スプレッドシート、スライドでは、特定の URL パターンに基づいてサードパーティ サービスのリンク プレビューを設定できます。ユーザーがパターンに一致するリンクを操作すると、linkPreviewTriggers がトリガーされ、リンクを含むイベント オブジェクトがトリガーのコールバック関数に渡されます。アドオンはこのイベント オブジェクトを使用して、ホスト アプリケーション内のリンクに関する情報を表示するスマートチップとカードを作成できます。ウィジェット アクションを作成して、ユーザーがプレビュー カードとそのコンテンツを操作できるようにすることもできます。

  • Google Chat アプリのトリガー（デベロッパー プレビュー）。Google Chat では、アドオンは Chat アプリとしてユーザーに表示されます。ユーザーは、スペースへの追加、メッセージの送信、スラッシュ コマンドの使用など、アドオンを操作できます。インタラクティブな機能を構築するには、さまざまな Chat アプリ トリガーを設定して使用します。各トリガーは、各タイプのインタラクションを処理または応答するために役立つ異なるイベント オブジェクト ペイロードを送信します。

イベント オブジェクトの構造

次の表に、Google Workspace アドオンのイベント オブジェクトの最上位構造を示します。イベント オブジェクトの構造には、ホストに依存しない情報の commonEventObject 最上位フィールドが含まれています。各イベント オブジェクトには、アクティブなホストアプリによって決まる、ホスト固有のトップレベル フィールド（gmailEventObject、calendarEventObject、driveEventObject）を 1 つ含めることもできます。

下位互換性を確保するため、Google Workspace アドオンのイベント オブジェクトには、Gmail アドオン アクション イベント オブジェクトで使用されていた元のフィールドもすべて含まれています。これらのフィールドは、以下の表の「元の Gmail アドオン フィールド」に記載されています。これらのフィールドの情報は、新しいオブジェクト構造で再現されます。

イベント オブジェクト
eventObject.commonEventObject Common fields object
ホスト アプリケーションに関係なく、すべてのイベント オブジェクトに共通する情報が含まれるオブジェクト。
eventObject.calendar Calendar event object
呼び出し元のホストが Google カレンダーの場合にのみ存在します。カレンダーと予定情報を含むオブジェクト。
eventObject.chat Chat event object
呼び出し元のホストが Google Chat の場合にのみ存在します。Chat 情報を含むオブジェクト。
eventObject.drive Drive event object
呼び出し元のホストが Google ドライブの場合にのみ存在します。ドライブ情報を含むオブジェクト。
eventObject.gmail Gmail event object
呼び出し元のホストが Gmail の場合にのみ存在します。Gmail に関する情報を含むオブジェクト。
eventObject.docs Docs event object
呼び出し元のホストが Google ドキュメントの場合にのみ存在します。Docs 情報を含むオブジェクト。
eventObject.sheets Sheets event object
呼び出し元のホストが Google スプレッドシートの場合にのみ存在します。スプレッドシートの情報を含むオブジェクト。
eventObject.slides Slides event object
呼び出し元のホストが Google スライドの場合のみ存在します。スライドの情報を含むオブジェクト。
元の Gmail アドオンのフィールド
eventObject.messageMetadata.accessToken string
非推奨。アクセス トークン。これを使用して、一時的な Gmail アドオン スコープを使用してユーザーデータへのアクセスを有効にできます。

Google Workspace アドオンの場合は、eventObject.gmail.accessToken フィールドで確認できます。
eventObject.messageMetadata.messageId string
非推奨。Gmail UI で開いているスレッドのメッセージ ID。

Google Workspace アドオンの場合は、eventObject.gmail.messageId フィールドで確認できます。
eventObject.clientPlatform string
非推奨。イベントの発生元（ウェブ、iOS、Android）を示します。

Google Workspace アドオンの場合は、eventObject.commonEventObject.platform フィールドで確認できます。
eventObject.formInput object
非推奨。カード内のすべてのフォーム ウィジェットの現在の値のマップ。ウィジェットごとに 1 つの値に制限されます。キーはウィジェットに関連付けられた文字列 ID で、値は文字列です。イベント オブジェクトには、テキスト入力やスイッチなど、単一の値が想定される複数のウィジェットからデータを読み取る必要がある場合に便利な formInput が用意されています。チェックボックスなどの複数値ウィジェットの場合は、代わりに formInputs から各値を読み取ることができます。

Google Workspace アドオンの場合は、eventObject.commonEventObject.formInputs フィールドでこの情報を確認します。単一の値を持つウィジェットは、単一要素の配列として表されます。
eventObject.formInputs object
非推奨。カード内のウィジェットの現在の値のマップ。文字列のリストとして表示されます。キーは、ウィジェットに関連付けられた文字列 ID です。単一値のウィジェットの場合、値は単一要素の配列で表されます。チェックボックス グループなどの複数値ウィジェットの場合、すべての値がリストに表示されます。

Google Workspace アドオンの場合は、eventObject.commonEventObject.formInputs フィールドで確認できます。
eventObject.parameters object
非推奨。 Action.setParameters() を使用して Action に指定する追加パラメータのマップ。マップのキーと値は文字列です。

Google Workspace アドオンの場合は、eventObject.commonEventObject.parameters フィールドで確認できます。
eventObject.userCountry string
非推奨で、デフォルトで無効。ユーザーの国または地域を示す 2 文字のコード。数値の UN M49 国コードにすることもできます。

Google Workspace アドオンの場合は、eventObject.commonEventObject.userLocale フィールドで確認できます。
eventObject.userLocale string
非推奨で、デフォルトで無効。ユーザーの言語を示す 2 文字の ISO 639 コード。詳しくは、ユーザーの言語 / 地域とタイムゾーンへのアクセスをご覧ください。

Google Workspace アドオンの場合は、eventObject.commonEventObject.userLocale フィールドで確認できます。
eventObject.userTimezone.id string
非推奨で、デフォルトで無効。ユーザーのタイムゾーンの タイムゾーン ID。例: America/New_York、Europe/Vienna、Asia/Seoul などです。詳しくは、 ユーザーの言語 / 地域とタイムゾーンへのアクセスをご覧ください。

Google Workspace アドオンの場合は、eventObject.commonEventObject.timeZone.id フィールドで確認できます。
eventObject.userTimezone.offset string
非推奨で、デフォルトで無効。ユーザーのタイムゾーンの 協定世界時（UTC）からの時刻オフセット（ミリ秒単位）。詳しくは、 ユーザーの言語 / 地域とタイムゾーンへのアクセスをご覧ください。

Google Workspace アドオンの場合は、eventObject.commonEventObject.timeZone.offset フィールドで確認できます。

一般的なイベント オブジェクト

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

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

一般的なイベント オブジェクト フィールド
commonEventObject.platform string
イベントの発生元（「WEB」、「IOS」、「ANDROID」）を示します。
commonEventObject.formInputs object
表示されたカード内のウィジェットの現在の値を含むマップ。マップキーは、各ウィジェットに割り当てられた文字列 ID です。

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

  • 単一値のウィジェット（テキスト ボックスなど）: 文字列のリスト（要素は 1 つだけ）。

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

  • 複数値のウィジェット（チェックボックス グループなど）: 文字列のリスト。

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

  • A date-time picker: DateTimeInput object。

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

  • A date-only picker: DateInput object。

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

  • A time-only picker: TimeInput object。

    例: ID が myTimePicker の選択ツールの場合は、e.commonEventObject.formInputs.myTimePicker.timeInput を使用して TimeInput オブジェクトにアクセスします。
commonEventObject.hostApp string
イベント オブジェクトが生成されたときにアドオンがアクティブになっているホストアプリを示します。有効な値は次のとおりです。
  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
commonEventObject.parameters object
actionParameters または Action.setParameters() を使用してアクションに指定する追加のパラメータ。

デベロッパー プレビュー: Google Chat を拡張するアドオンで、ユーザーが複数選択メニューに入力した内容に基づいてアイテムを提案するには、"autocomplete_widget_query" キーの値（event.commonEventObject.parameters["autocomplete_widget_query"]）を使用します。この値を使用してデータベースをクエリし、ユーザーが入力する際に選択可能なアイテムを提案できます。詳しくは、Google Chat ユーザーからの情報の収集と処理をご覧ください。
commonEventObject.userLocale string
デフォルトで無効になっています。ユーザーの言語と国/地域の識別子（ISO 639 言語コード - ISO 3166 国/地域コードの形式）。例: en-US

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

commonEventObject.timeZone string
デフォルトで無効になっています。タイムゾーン ID とオフセット。このフィールドを有効にするには、アドオンのマニフェストで addOns.common.useLocaleFromApp を true に設定する必要があります。アドオンのスコープライストにも https://www.googleapis.com/auth/script.locale を含める必要があります。詳しくは、 ユーザーの言語 / 地域とタイムゾーンへのアクセスをご覧ください。
commonEventObject.timeZone.id string
ユーザーのタイムゾーンの タイムゾーン ID。例: America/New_York、Europe/Vienna、Asia/Seoul。このフィールドを有効にするには、アドオンのマニフェストで addOns.common.useLocaleFromApp を true に設定する必要があります。アドオンのスコープライストにも https://www.googleapis.com/auth/script.locale を含める必要があります。詳しくは、 ユーザーの言語 / 地域とタイムゾーンへのアクセスをご覧ください。
commonEventObject.timeZone.offset string
ユーザーのタイムゾーンの 協定世界時（UTC）からの時刻オフセット（ミリ秒単位）。詳しくは、 ユーザーの言語 / 地域とタイムゾーンへのアクセスをご覧ください。

日時選択ツールのフォーム入力

アクション コールバック関数は、commonEventObject.formInputs フィールドで現在のウィジェット値を受信できます。これには、日付または時刻選択ウィジェットでユーザーが選択した日付または時刻の値が含まれます。ただし、情報の構造は、ウィジェットが日時選択ツール、日付のみ選択ツール、時刻のみ選択ツールとして構成されているかどうかによって異なります。構造的な違いを次の表に示します。

DateTimeInput オブジェクト
dateTimeInput.hasDate boolean
true（入力日時に日付が含まれている場合）。false の場合は、時刻のみが含まれます。
dateTimeInput.hasTime boolean
true（入力日時に時刻が含まれている場合）。false の場合は日付のみが含まれます。
dateTimeInput.msSinceEpoch string
ユーザーが選択した時刻（エポック（1970 年 1 月 1 日 00:00:00 UTC）からのミリ秒数）。
DateInput オブジェクト
dateInput.msSinceEpoch string
ユーザーが選択した時刻（エポック（1970 年 1 月 1 日 00:00:00 UTC）からのミリ秒数）。
TimeInput オブジェクト
timeInput.hours number
ユーザーが選択した時刻。
timeInput.minutes number
ユーザーが選択した分数。

Chat イベント オブジェクト

Chat イベント オブジェクトは、Chat アプリでのユーザーの操作に関する情報を保持する、イベント オブジェクト全体の一部です。アドオンが Google Chat を拡張している場合のみ、イベント オブジェクトに存在します。

チャット
chat.user object (User)
Chat アプリを操作した Chat ユーザー。
chat.space object (Space)
ユーザーが Chat アプリを操作した Chat スペース。
chat.eventTime

string (Timestamp format)

インタラクションが発生した日時。

共用体フィールド payload。

payload は次のいずれかになります。
chat.messagePayload

object (MessagePayload)

Chat アプリが メッセージ トリガーから受信するペイロード。
chat.addedToSpacePayload

object (AddedToSpacePayload)

Chat アプリが Added to space トリガーから受け取るペイロード。
chat.removedFromSpacePayload

object (RemovedFromSpacePayload)

Chat アプリが スペースから削除トリガーから受け取るペイロード。
chat.buttonClickedPayload

object (ButtonClickedPayload)

ユーザーがメッセージまたはカードのボタンをクリックしたときに Chat アプリが受け取るペイロード。ユーザーがボタンをクリックして情報を送信すると、commonEventObject.formInputs オブジェクトにユーザーから収集された値が含まれます。詳しくは、 Google Chat ユーザーから情報を収集するをご覧ください。
chat.widgetUpdatedPayload

object (WidgetUpdatedPayload)

ユーザーが selectionInput ウィジェットのマルチ選択メニューにテキストを入力したときに Chat アプリが受信するペイロード。チャットアプリでは、このイベント オブジェクトを使用して、動的データソースから候補アイテムを入力できます。たとえば、外部データソースからサポートケースを入力するには、チャットアプリがユーザーがメニューに入力した内容に基づいてデータソースをクエリし、一致するサポートケースを選択可能なアイテムとして返します。

CommonEventObject.parameters['autocomplete_widget_query'] オブジェクトには、ユーザーがメニューに入力した文字列値が含まれます。
chat.appCommandPayload

object (AppCommandPayload)

ユーザーが Chat アプリのコマンドを使用するときに Chat アプリが受信するペイロード。

ペイロード

Chat アプリのインタラクションの種類に応じて、イベントには 1 つ以上の Chat API リソースを含むペイロードが含まれます。

メッセージ ペイロード
MessagePayload
chat.messagePayload.message object (Message)
イベントをトリガーした Chat メッセージ。
chat.messagePayload.space object (Space)
ユーザーが Chat アプリを呼び出すメッセージを送信した Chat スペース。
chat.messagePayload.configCompleteRedirectUri string
Google Chat の外部で認可フローまたは構成フローを完了したユーザーをリダイレクトする Chat アプリの URL。詳細については、Google Workspace アドオンをサードパーティ サービスに接続するをご覧ください。

スペース ペイロードに追加
AddedToSpacePayload
chat.addedToSpacePayload.space object (Space)
ユーザーが Chat アプリを追加またはインストールした Chat スペース。

管理者が Chat アプリをインストールすると、space.adminInstalled フィールドは true に設定されます。
chat.addedToSpacePayload.interactionAdd boolean
ユーザーがメッセージを使用して Chat アプリをスペースに追加するかどうか。たとえば、Chat アプリを @ メンションしたり、コマンドを使用したりします。true の場合、Chat は、メッセージに関する情報を含む messagePayload を含む別のイベント オブジェクトを送信します。
chat.addedToSpacePayload.configCompleteRedirectUri string
Google Chat の外部で認可フローまたは構成フローを完了したユーザーをリダイレクトする Chat アプリの URL。詳細については、Google Workspace アドオンをサードパーティ サービスに接続するをご覧ください。

スペース ペイロードから削除
RemovedFromSpacePayload
chat.removedFromSpacePayload.space object (Space)
ユーザーが Chat アプリを削除またはアンインストールした Chat スペース。

管理者が Chat アプリをアンインストールすると、space.adminInstalled フィールドは false に設定されます。

ボタンクリック ペイロード
ButtonClickedPayload
chat.buttonClickedPayload.message object (Message)
ユーザーがクリックしたボタンを含む Chat メッセージ。
chat.buttonClickedPayload.space object (Space)
ユーザーが Chat アプリのメッセージからボタンをクリックした Chat スペース。
chat.buttonClickedPayload.isDialogEvent boolean
ユーザーがボタンをクリックしてダイアログを操作したかどうか。
chat.buttonClickedPayload.dialogEventType enum (DialogEventType)
isDialogEvent が true の場合、ダイアログ内のインタラクションのタイプ。

列挙型 DialogEventType。

dialogEventType の値は、次のいずれかの 1 つのみを指定できます。
TYPE_UNSPECIFIED デフォルト値。（指定なし）
REQUEST_DIALOG ユーザーがダイアログをリクエストします。たとえば、コマンドを使用するか、メッセージのボタンをクリックします。
SUBMIT_DIALOG ユーザーがダイアログ内のインタラクティブな要素をクリックします。たとえば、ユーザーがダイアログで情報を入力し、ボタンをクリックして情報を送信します。

ウィジェットの更新ペイロード
WidgetUpdatedPayload
chat.widgetUpdatedPayload.space object (Space)
インタラクションが発生した Chat スペース。

アプリ コマンド ペイロード
AppCommandPayload
chat.appCommandPayload.appCommandMetadata object (AppCommandMetadata)
ユーザーが使用したコマンドと、コマンドをトリガーした方法に関するメタデータ。
chat.appCommandPayload.space object (Space)
ユーザーがコマンドを使用した Chat スペース。
chat.appCommandPayload.thread object (Thread)
スレッド内でインタラクションが発生した場合は、ユーザーがコマンドを使用した Chat スレッド。
chat.appCommandPayload.message object (Message)
スラッシュ コマンドの場合、スラッシュ コマンドを含むメッセージ。
chat.appCommandPayload.configCompleteRedirectUri string
コマンドに認可または構成が必要な場合は、Google Chat の外部でプロセスを完了した後にユーザーをリダイレクトする URL。
chat.appCommandPayload.isDialogEvent boolean
コマンドでダイアログを開くかどうか。
chat.appCommandPayload.dialogEventType enum (DialogEventType)
ダイアログとのインタラクションのタイプ。

列挙型 DialogEventType。

dialogEventType の値は、次のいずれかの 1 つのみを指定できます。
TYPE_UNSPECIFIED デフォルト値。（指定なし）
REQUEST_DIALOG ユーザーがダイアログをリクエストします。たとえば、コマンドを使用するか、メッセージのボタンをクリックします。
SUBMIT_DIALOG ユーザーがダイアログ内のインタラクティブな要素をクリックします。たとえば、ユーザーがダイアログで情報を入力し、ボタンをクリックして情報を送信します。
アプリコマンド メタデータ
AppCommandMetadata
chat.appCommandPayload.appCommandMetadata.appCommandId

string (int64 format)

コマンド ID。
chat.appCommandPayload.appCommandMetadata.appCommandType enum (AppCommandType)
コマンドのタイプ。

列挙型 AppCommandType。

AppCommandType の値は、次のいずれかの 1 つのみを指定できます。
APP_COMMAND_TYPE_UNSPECIFIED デフォルト値。（指定なし）
SLASH_COMMAND ユーザーは、スラッシュ / で始まるメッセージを送信してコマンドを使用します。
QUICK_COMMAND ユーザーがメッセージの返信欄の Chat メニューからコマンドを選択します。

カレンダーの予定オブジェクト

カレンダーの予定オブジェクトは、ユーザーのカレンダーとカレンダーの予定に関する情報を保持する、イベント オブジェクト全体の一部です。アドオンが Google カレンダーを拡張している場合にのみ、イベント オブジェクトに存在します。

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

カレンダーの予定オブジェクト
calendar.attendees[] list of attendee objects
ユーザー作成データ。 カレンダーの予定の参加者のリスト。
calendar.calendarId string
カレンダー ID。
calendar.capabilities object
ユーザー作成データ。イベント情報を表示または更新するアドオンの機能を記述するオブジェクト。
calendar.capabilities.canAddAttendees boolean
ユーザー作成データ。true アドオンがイベントの参加者リストに新しい参加者を追加できる場合。それ以外の場合は false。
calendar.capabilities.canSeeAttendees boolean
ユーザー作成データ。アドオンがイベントの参加者リストを読み取れる場合は true、それ以外の場合は false。
calendar.capabilities.canSeeConferenceData boolean
ユーザー作成データ。アドオンがイベントの会議データを読み取れる場合は true、それ以外の場合は false。
calendar.capabilities.canSetConferenceData boolean
ユーザー作成データ。アドオンがイベントの会議データを更新できる場合は true。それ以外の場合は false。
calendar.capabilities.canAddAttachments boolean
ユーザー作成データ。true アドオンが予定に新しい添付ファイルを追加できる場合。 それ以外の場合は false。
calendar.conferenceData Conference data object
ユーザー作成データ。 このイベントに関連付けられている会議データ（Google Meet 会議の詳細など）を表すオブジェクト。
calendar.id string
イベント ID。
calendar.organizer object
イベントの主催者を表すオブジェクト。
calendar.organizer.email string
イベント主催者のメールアドレス。
calendar.recurringEventId string
定期的な予定の ID。

参加者

参加者オブジェクトには、Google カレンダーの予定の個々の参加者に関する情報が格納されます。この情報は、データがカレンダー イベントに存在し、アドオンがその addOns.calendar.currentEventAccess マニフェスト フィールドを READ または READ_WRITE に設定している場合にのみ、イベント オブジェクトに存在します。

参加者オブジェクト
attendee.additionalGuests number
参加者が同伴すると指定した追加のゲストの数。デフォルトは 0 です。
attendee.comment string
参加者の返信コメント（ある場合）。
attendee.displayName string
参加者の表示名。
attendee.email string
参加者のメールアドレス。
attendee.optional boolean
true（この参加者の出席が省略可としてマークされている場合）。それ以外の場合は false。
attendee.organizer boolean
true: 参加者がこのイベントの主催者である場合。
attendee.resource boolean
true: 参加者がリソース（部屋や機器など）を表す場合。それ以外の場合は false。
attendee.responseStatus string
参加者の返信ステータス。有効な値は次のとおりです。
  • accepted: 参加者がイベントの招待を承諾しました。
  • declined: 参加者がイベントの招待を辞退しました。
  • needsAction: 参加者がイベントの招待に返信していません。
  • tentative: 参加者がイベントの招待を仮承諾しました。
attendee.self boolean
この出席者がこのイベントが表示されるカレンダーを表す場合は true、そうでない場合は false。

会議データ

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

会議データ オブジェクト
conferenceData.conferenceId string
会議の ID。この ID は、アプリケーションが会議を追跡できるようにするためのものです。この ID をユーザーに表示しないでください。
conferenceData.conferenceSolution object
ハングアウトや Google Meet などの会議ソリューションを表すオブジェクト。
conferenceData.conferenceSolution.iconUri string
この会議ソリューションを表すユーザーに表示されるアイコンの URI。
conferenceData.conferenceSolution.key object
このイベントのコンファレンス ソリューションを一意に識別するキー。
conferenceData.conferenceSolution.key.type string
会議ソリューションのタイプ。有効な値は次のとおりです。
  • eventHangout: 一般向けハングアウト（http://hangouts.google.com）
  • eventNamedHangout: Google Workspace ユーザー向けの従来のハングアウト（http://hangouts.google.com）。
  • hangoutsMeet: Google Meet（http://meet.google.com）
conferenceData.conferenceSolution.name string
この会議ソリューションのユーザーに表示される名前（ローカライズなし）。
conferenceData.entryPoints[] list of entry point objects
会議のエントリ ポイントのリスト（URL や電話番号など）。
conferenceData.notes string
ユーザーに表示する会議に関する追加のメモ（ドメイン管理者からの指示や法的通知など）。HTML を含めることができます。最大長は 2,048 文字です。
conferenceData.parameters object
アドオンで使用される定義済みパラメータデータのマップを含むオブジェクト。
conferenceData.parameters.addOnParameters object
パラメータ文字列のキーと値のマップ。これらのキーと値は、アドオンのデベロッパーが定義し、アドオンの使用のために特定の会議に情報を関連付けます。

エントリ ポイント

エントリ ポイント オブジェクトには、電話やビデオなど、特定の会議にアクセスするための確立された手段に関する情報が含まれます。この情報は、データがカレンダー イベントに存在し、アドオンが addOns.calendar.currentEventAccess マニフェスト フィールドを READ または READ_WRITE に設定している場合にのみ、イベント オブジェクトに存在します。

エントリ ポイント オブジェクト
entryPoint.accessCode string
会議へのアクセスに使用されるアクセスコード。 最大長は 128 文字です。通常、会議プロバイダは {accessCode、meetingCode、passcode、password、pin} のサブセットのみを使用して会議へのアクセスを提供します。会議プロバイダが使用するフィールドのみを照合して表示します。
entryPoint.entryPointFeatures list
エントリ ポイントの機能。現在、これらの機能は phone エントリ ポイントにのみ適用されます。
  • toll: エントリ ポイントは有料電話です。
  • toll_free: エントリ ポイントはフリーダイヤル電話です。
entryPoint.entryPointType string
エントリ ポイントのタイプ。使用できる値は次のとおりです。
  • more: 予備の電話番号など、会議への参加に関する追加の手順。会議に設定できる more エントリ ポイントは 1 つだけです。存在する場合は、少なくとも 1 つの他のタイプのエントリ ポイントも必要です。
  • phone: 電話番号で会議に参加します。会議には 0 個以上の phone エントリ ポイントを含めることができます。Google カレンダーには、入力ポイントをフォーマットしてアルファベット順に並べ替えた後、最初の 2 つの電話番号のみが表示されます。
  • sip: SIP 経由で会議に参加します。会議に設定できる sip エントリ ポイントは 1 つだけです。
  • video: HTTP 経由で会議に参加します。会議に割り当てることができる video エントリ ポイントは 1 つだけです。
entryPoint.label string
エントリ ポイント URI のユーザーに表示されるラベル（ローカライズなし）。
entryPoint.meetingCode string
会議へのアクセスに使用される会議コード。 最大長は 128 文字です。通常、会議プロバイダは {accessCode、meetingCode、passcode、password、pin} のサブセットのみを使用して会議へのアクセスを提供します。会議プロバイダが使用するフィールドのみを照合して表示します。
entryPoint.passcode string
会議へのアクセスに使用するパスコード。最大長は 128 文字です。通常、会議プロバイダは {accessCode、meetingCode、passcode、password、pin} のサブセットのみを使用して会議へのアクセスを提供します。会議プロバイダが使用するフィールドのみを照合して表示します。
entryPoint.password string
会議へのアクセスに使用するパスワード。 最大長は 128 文字です。通常、会議プロバイダは {accessCode、meetingCode、passcode、password、pin} のサブセットのみを使用して会議へのアクセスを提供します。会議プロバイダが使用するフィールドのみを照合して表示します。
entryPoint.pin string
会議へのアクセスに使用される PIN。 最大長は 128 文字です。通常、会議プロバイダは {accessCode、meetingCode、passcode、password、pin} のサブセットのみを使用して会議へのアクセスを提供します。会議プロバイダが使用するフィールドのみを照合して表示します。
entryPoint.regionCode string
電話番号の地域コード。URI に国コードが含まれていない場合は、ユーザーが入力する必要があります。値は、公開されている CLDR の地域コードのリストに基づいています。
entryPoint.uri string
エントリ ポイントの URI。最大長は 1,300 文字です。フォーマットは、エントリ ポイントのタイプによって異なります。
  • more: http: または https: スキーマが必要です。
  • phone: tel: スキーマが必要です。URI には、ダイヤル シーケンス全体を含める必要があります（例: tel:+12345678900,,,12345678;1234）。
  • sip: sip: または sips: スキーマが必要です。例: 「sip:12345678@myprovider.com」。
  • video: http: または https: スキーマが必要です。

ドライブ イベント オブジェクト

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

ドライブ イベント オブジェクト
drive.activeCursorItem Drive item object
現在アクティブなドライブ アイテム。
drive.selectedItems[] list of Drive item objects
ドライブで選択したアイテム（ファイルまたはフォルダ）のリスト。

ドライブのアイテム

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

ドライブのアイテム オブジェクト
item.addonHasFileScopePermission boolean
true の場合、アドオンはこのアイテムの https://www.googleapis.com/auth/drive.file スコープの承認をリクエストして受信しています。それ以外の場合は、このフィールドは false です。
item.id string
選択したアイテムの ID。
item.iconUrl string
選択したアイテムを表すアイコンの URL。
item.mimeType string
選択したアイテムの MIME タイプ。
item.title string
選択したアイテムのタイトル。

Gmail イベント オブジェクト

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

Gmail イベント オブジェクト
gmail.accessToken string
Gmail 固有のアクセス トークン。このトークンを GmailApp.setCurrentMessageAccessToken(accessToken) メソッドで使用すると、ユーザーが現在開いている Gmail メッセージへのアドオンの一時的なアクセスを許可したり、アドオンで新しい下書きを作成したりできます。
gmail.bccRecipients[] list of strings
デフォルトで無効になっています。アドオンが作成している下書きに現在含まれている「BCC:」受信者のメールアドレスのリスト。このフィールドを有効にするには、マニフェストの addOns.gmail.composeTrigger.draftAccess フィールドを METADATA に設定する必要があります。
gmail.ccRecipients[] list of strings
デフォルトで無効になっています。アドオンが作成している下書きに現在含まれている「CC:」受信者のメールアドレスのリスト。このフィールドを有効にするには、マニフェストの addOns.gmail.composeTrigger.draftAccess フィールドを METADATA に設定する必要があります。
gmail.messageId string
現在開いている Gmail メールの ID。
gmail.threadId string
現在開いている Gmail スレッド ID。
gmail.toRecipients[] list of strings
デフォルトで無効になっています。アドオンが作成している下書きに現在含まれている「宛先」受信者のメールアドレスのリスト。このフィールドを有効にするには、マニフェストの addOns.gmail.composeTrigger.draftAccess フィールドを METADATA に設定する必要があります。

ドキュメント イベント オブジェクト

Docs イベント オブジェクトは、ユーザーのドキュメントとその内容に関する情報を伝達する、イベント オブジェクト全体の一部です。アドオンが Google ドキュメントを拡張している場合にのみ、イベント オブジェクトに存在します。

ドキュメント イベント オブジェクト
docs.id string
https://www.googleapis.com/auth/drive.file スコープがユーザーによって承認されている場合にのみ存在します。
ドキュメント UI で開いているドキュメントの ID。
docs.title string
https://www.googleapis.com/auth/drive.file スコープがユーザーによって承認されている場合にのみ存在します。
ドキュメント UI で開いているドキュメントのタイトル。
docs.addonHasFileScopePermission boolean
true の場合、アドオンは Docs UI で開いているドキュメントの https://www.googleapis.com/auth/drive.file スコープの承認をリクエストして受信しています。それ以外の場合、このフィールドは false です。
docs.matchedUrl.url string
次の条件が満たされている場合にのみ存在します。
  • 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"
  }
}

スプレッドシート イベント オブジェクト

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

スプレッドシート イベント オブジェクト
sheets.id string
https://www.googleapis.com/auth/drive.file スコープがユーザーによって承認されている場合にのみ存在します。スプレッドシート UI で開いているスプレッドシートの ID。
sheets.title string
https://www.googleapis.com/auth/drive.file スコープがユーザーによって承認されている場合にのみ存在します。スプレッドシート UI で開いているスプレッドシートのタイトル。
sheets.addonHasFileScopePermission boolean
true の場合、アドオンはスプレッドシート UI で開いているスプレッドシートの https://www.googleapis.com/auth/drive.file スコープの承認をリクエストして受信しました。それ以外の場合、このフィールドは false です。
sheets.matchedUrl.url string
次の条件が満たされている場合にのみ存在します。
  • 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"
  }
}

スライドのイベント オブジェクト

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

スライドのイベント オブジェクト
slides.id string
https://www.googleapis.com/auth/drive.file スコープがユーザーによって承認されている場合にのみ存在します。スライド UI で開いているプレゼンテーションの ID。
slides.title string
https://www.googleapis.com/auth/drive.file スコープがユーザーによって承認されている場合にのみ存在します。スライド UI で開いているプレゼンテーションのタイトル。
slides.addonHasFileScopePermission boolean
true の場合、アドオンはスライド UI で開いているプレゼンテーションの https://www.googleapis.com/auth/drive.file スコープの承認をリクエストし、承認を受けています。それ以外の場合、このフィールドは false です。
slides.matchedUrl.url string
次の条件が満たされている場合にのみ存在します。
  • 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"
  }
}