イベント オブジェクト

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

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

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

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

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

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

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

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

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

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

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

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

次の表に、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 で、値は文字列です。イベント オブジェクトは、テキスト入力やスイッチなどの想定される単一の値を持つ複数のウィジェットからデータを読み取る必要がある場合に便利です。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_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.useLocaleFromApptrue に設定する必要があります。アドオンのスコープリストには https://www.googleapis.com/auth/script.locale も含める必要があります。詳しくは、ユーザーの言語 / 地域とタイムゾーンにアクセスするをご覧ください。

commonEventObject.timeZone string
デフォルトで無効。タイムゾーン ID とオフセット。このフィールドを有効にするには、アドオンのマニフェストで addOns.common.useLocaleFromApptrue に設定する必要があります。アドオンのスコープリストには https://www.googleapis.com/auth/script.locale も含める必要があります。詳しくは、ユーザーの言語 / 地域とタイムゾーンにアクセスするをご覧ください。
commonEventObject.timeZone.id string
ユーザーのタイムゾーンのタイムゾーン ID。例: America/New_YorkEurope/ViennaAsia/Seoulこのフィールドを有効にするには、アドオンのマニフェストで addOns.common.useLocaleFromApptrue に設定する必要があります。アドオンのスコープリストには 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 をユーザーに表示するべきではありません。
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 ユーザー向けの従来のハングアウト(http://hangouts.google.com)については、eventNamedHangout
  • 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 個のエントリ ポイントを配置できます。
  • video: HTTP 経由で会議に参加します。会議には最大 video 個のエントリ ポイントを設定できます。
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 には、ダイヤル シーケンス全体(例: 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.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 のイベント オブジェクト

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 になります。
docs.matched.url string
次の条件が満たされる場合にのみ存在します。
  • https://www.googleapis.com/auth/documents.readonly がユーザーによって承認されました。
  • URL が LinkPreviewTriggers トリガーで指定されたホストパターンと一致する。

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

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

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

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

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