イベント オブジェクト

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

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

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

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

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

  • コンテキスト トリガー。各ホステッド アプリケーションは、ユーザーが特定のコンテキストに入ったときに配信する、異なるコンテキスト トリガーのセットを提供します。

    コンテキスト トリガーが起動すると、ホスト アプリケーションは、アドオン マニフェストに記載されている対応する 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 アドオン フィールド」にあり、commonEventObject の一部ではありません。

元の Gmail のアドオン フィールドは非推奨になりました。Google Workspace アドオンを開発または移行する場合は、代わりに新しいイベント オブジェクト構造を使用してください。これらのフィールドは、今後のアップデートで削除される可能性があります。

イベント オブジェクト
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 ドキュメントの場合にのみ存在します。ドキュメント情報を含むオブジェクト。
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
非推奨となり、デフォルトで無効になっています。ユーザーのタイムゾーンの タイムゾーン識別子。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
ユーザーのタイムゾーンの タイムゾーン識別子。例: 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 用アプリのやり取りに関する情報を保持する、イベント オブジェクト全体の一部です。これは、アドオンが Google Chat を拡張する場合にのみ、イベント オブジェクトに存在します。

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

string (Timestamp format)

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

共用体フィールド payload。App Home トリガー（ユーザーが [Home] タブを開いたとき）の場合、payload は設定されず、chat には chat.user と chat.eventTime が含まれます。

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

object (MessagePayload)

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

object (AddedToSpacePayload)

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

object (RemovedFromSpacePayload)

Chat 用アプリが Removed from space トリガーから受け取るペイロード。
chat.buttonClickedPayload

object (ButtonClickedPayload)

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

object (WidgetUpdatedPayload)

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

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

object (AppCommandPayload)

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

ペイロード

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

メッセージ ペイロード
MessagePayload
chat.messagePayload.message object (Message)
イベントをトリガーしたチャット メッセージ。
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.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 API Event リソース フィールドに直接マッピングされます。フィールドの説明が異なる場合は、次の表の情報が正しいです。

カレンダーの予定オブジェクト
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。

参加者

Attendee オブジェクトには、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 Meet などの Google の会議ソリューションや、サードパーティの会議ソリューションを使用できます。この情報は、データがカレンダーの予定に存在し、アドオンが 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: スキーマが必要です。

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

ドライブ イベント オブジェクトは、ユーザーの 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 メソッドで使用すると、ユーザーが現在開いている 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 に設定します。

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

ドキュメント イベント オブジェクトは、ユーザーのドキュメントとそのコンテンツに関する情報を保持するイベント オブジェクト全体の一部です。アドオンが 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 の場合、アドオンは、ドキュメント 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"
  }
}

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

スプレッドシートのイベント オブジェクトは、ユーザーのドキュメントとそのコンテンツに関する情報を保持する、イベント オブジェクト全体の一部です。アドオンが 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"
  }
}