イベント オブジェクト

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

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

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

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

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

  • コンテキスト トリガー。ホストアプリケーションは、ユーザーが特定のコンテキストを入力したときに起動される、異なるコンテキスト トリガーのセットを提供します。たとえば、Gmail では、ユーザーがメッセージを開いたときと、メッセージを作成したときに、コンテキスト トリガーが提供されます。Google カレンダーは、ユーザーが予定を開く際にコンテキスト トリガーを提供します。Google ドライブでは、ユーザーがドライブのファイルを選択したときに表示されるコンテキスト トリガーを利用できます。

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

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

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

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

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

次の表に、Google Workspace アドオン イベント オブジェクトの最上位の構造を示します。イベント オブジェクトの構造には、ホストに依存しない情報を格納する commonEventObject トップレベル フィールドが含まれます。各イベント オブジェクトには、ホスト固有のトップレベル フィールド(gmailEventObjectcalendarEventObjectdriveEventObject のいずれか)を使用することもできます。

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

イベント オブジェクト
eventObject.commonEventObject Common fields object
ホスト アプリケーションに関係なく、すべてのイベント オブジェクトに共通の情報を含むオブジェクト。
eventObject.calendar Calendar event object
発信側のホストが Google カレンダーの場合にのみ表示されますカレンダーとイベントの情報を含むオブジェクト。
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 で、値は文字列です。イベント オブジェクトは、テキスト入力やスイッチなど、想定される 1 つの値を持つ複数のウィジェットからデータを読み取る必要がある場合に便利です。formInputチェックボックスなどの多値ウィジェットの場合、代わりに formInputs からそれぞれの値を読み取れます。

Google Workspace アドオンの場合、この情報は eventObject.commonEventObject.formInputs フィールドで確認できます。値が 1 つのウィジェットは、1 つの要素を持つ配列として表されます。

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_YorkEurope/ViennaAsia/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
Action.setParameters() を使用して Action に提供する追加のパラメータ。
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_YorkEurope/ViennaAsia/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
ユーザーが選択した分数。

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

カレンダー イベント オブジェクトは、イベント オブジェクトの一部であり、ユーザーのカレンダー イベントとカレンダーの予定に関する情報を保持するものです。これは、ホスト アプリケーションが 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
参加者が指定しているゲストの数。デフォルトはゼロです。
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 です。この 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)。
  • Google Workspace ユーザーは、eventNamedHangout で従来のハングアウトをご利用いただけます(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 文字です。一般的に、カンファレンス プロバイダは、カンファレンスへのアクセスを提供する目的で {accessCodemeetingCodepasscodepasswordpin} のサブセットのみを使用します。カンファレンス プロバイダが使用するフィールドのみが一致し、表示されます。
entryPoint.entryPointFeatures list
エントリ ポイントの特徴。現在、これらの機能は phone エントリ ポイントにのみ適用されます。
  • toll: エントリ ポイントは有料通話です。
  • toll_free: エントリ ポイントはフリーダイヤルの通話です。
entryPoint.entryPointType string
エントリ ポイントのタイプ。使用できる値は次のとおりです。
  • more: 追加の会議参加手順(予備の電話番号など)。会議に追加できる more エントリ ポイントは 1 つだけです。また、他のエントリ ポイントを少なくとも 1 つ含める必要もあります。
  • phone: 電話番号を使用して会議に参加します。会議には 0 個以上の phone エントリ ポイントを設定できます。Google カレンダーでは、アルファベット順で書式設定と並べ替えを行った後で、最初の 2 つの電話エントリ ポイントのみが表示されます。
  • sip: SIP を使用して会議に参加します。1 つの会議に追加できる sip エントリ ポイントは 1 つだけです。
  • video: HTTP で会議に参加します。1 つの会議に含めることができる video エントリ ポイントは 1 つまでです。
entryPoint.label string
ユーザーが閲覧できるエントリ ポイント URI(ローカライズされていない)のラベル。
entryPoint.meetingCode string
会議へのアクセスに使用された会議コード。 最大長は 128 文字です。一般的に、カンファレンス プロバイダは、カンファレンスへのアクセスを提供する目的で {accessCodemeetingCodepasscodepasswordpin} のサブセットのみを使用します。カンファレンス プロバイダが使用するフィールドのみが一致し、表示されます。
entryPoint.passcode string
会議へのアクセスに使用されるパスコード。 最大長は 128 文字です。一般的に、カンファレンス プロバイダは、カンファレンスへのアクセスを提供する目的で {accessCodemeetingCodepasscodepasswordpin} のサブセットのみを使用します。カンファレンス プロバイダが使用するフィールドのみが一致し、表示されます。
entryPoint.password string
会議へのアクセスに使用されたパスワード。 最大長は 128 文字です。一般的に、カンファレンス プロバイダは、カンファレンスへのアクセスを提供する目的で {accessCodemeetingCodepasscodepasswordpin} のサブセットのみを使用します。カンファレンス プロバイダが使用するフィールドのみが一致し、表示されます。
entryPoint.pin string
会議へのアクセスに使用された PIN。 最大長は 128 文字です。一般的に、カンファレンス プロバイダは、カンファレンスへのアクセスを提供する目的で {accessCodemeetingCodepasscodepasswordpin} のサブセットのみを使用します。カンファレンス プロバイダが使用するフィールドのみが一致し、表示されます。
entryPoint.regionCode string
電話番号の地域コード。URI に国コードが含まれていない場合に必要です。値は、一般公開されているリージョン コードの CLDR リストに基づいています。
entryPoint.uri string
エントリ ポイントの URI。最大長は 1,300 文字です。形式は、エントリ ポイントのタイプによって異なります。
  • more: http: または https: スキーマが必要です。
  • phone: tel: スキーマは必須です。URI には、ダイヤル シーケンス全体を含める必要があります(例: &telt;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(accessToken) メソッドとともに使用して、現在開いている Gmail のメッセージへのアドオンの一時的なアクセス権を付与するか、アドオンで新しい下書きを作成できるようにします。
gmail.bccRecipients[] list of strings
デフォルトでは無効。現在、アドオンが作成中の下書きに含まれる「BCC:" 受信者のメールアドレス」のリスト。このフィールドを有効にするには、マニフェストの「addOns.gmail.composeTrigger."></Access」フィールドを「METADATA」に設定する必要があります。
gmail.ccRecipients[] list of strings
デフォルトでは無効。アドオンが作成中の下書きに現在含まれている「CC:" 受信者のメールアドレス」のリスト。このフィールドを有効にするには、マニフェストの「addOns.gmail.composeTrigger."></Access」フィールドを「METADATA」に設定する必要があります。
gmail.messageId string
現在開いている Gmail のメッセージの ID。
gmail.threadId string
現在開いている Gmail のスレッド ID。
gmail.toRecipients[] list of strings
デフォルトでは無効。現在、アドオンで作成中の下書きの「To:"」受信者のメールアドレスのリスト。このフィールドを有効にするには、マニフェストの「addOns.gmail.composeTrigger."></Access」フィールドを「METADATA」に設定する必要があります。

Docs のイベント オブジェクト

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

Docs のイベント オブジェクト
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 になります。

Sheets イベント オブジェクト

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

Sheets イベント オブジェクト
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 になります。

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

スライド イベント オブジェクトは、イベント オブジェクト全体のうち、ユーザーのドキュメントとそのコンテンツに関する情報を保持する部分です。これは、ホスト アプリケーションが 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 になります。