イベント オブジェクト

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

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

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

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

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

  • コンテキスト トリガー。 ホスト アプリケーションごとに、コンテキストに応じたさまざまなトリガーのセットが用意されており、 ユーザーが特定のコンテキストに入ったときに起動されます。例:

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

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

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

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

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

次の表に、Google Workspace アドオンのイベント オブジェクトの最上位構造を示します。イベント commonEventObject を含むオブジェクト構造 ホストに依存しない情報用の最上位フィールドです。各イベントオブジェクトは 次のいずれかのホスト固有のトップレベル フィールドがあります。これは、 アクティブ ホストアプリ: gmailEventObject、 calendarEventObject または driveEventObject。

下位互換性を確保するため、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 ドキュメントである場合のみ表示されます。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 サービスで生成されたコンテンツにアクセスできます。

Google Workspace アドオンについては、 eventObject.commonEventObject.platform 表示されます。

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

Google Workspace アドオンについては、 eventObject.commonEventObject.formInputs フィールドを使用してください。単一の値を持つウィジェットは、配列として表され、 単一の要素です。

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

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
非推奨となり、デフォルトで無効になっています。「 <ph type="x-smartling-placeholder"></ph> タイムゾーン識別子。例: America/New_York、Europe/Vienna、Asia/Seoul などです。詳しくは、ユーザーの言語 / 地域とタイムゾーンへのアクセスをご覧ください。

Google Workspace アドオンについては、 eventObject.commonEventObject.timeZone.id 表示されます。

eventObject.userTimezone.offset string
非推奨で、デフォルトで無効。ユーザーのタイムゾーンの協定世界時（UTC）からの時刻オフセット（ミリ秒単位）。詳しくは、 <ph type="x-smartling-placeholder"></ph> 詳しくは、ユーザーの言語 / 地域とタイムゾーンにアクセスするをご覧ください。

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

共通イベント オブジェクト

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

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

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

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

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

    例: テキスト入力ウィジェットで、 employeeName の場合、テキスト 次の値を持つ入力値: e.commonEventObject.formInputs.employeeName.stringInputs.value[0]

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

    例: 複数の値を持つウィジェットで、 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 の選択ツールの場合、 アクセスする TimeInput オブジェクト e.commonEventObject.formInputs.myTimePicker.timeInput。
commonEventObject.hostApp string
イベント オブジェクトが生成されたときにアドオンがアクティブになっているホストアプリを示します。有効な値は次のとおりです。 次のとおりです。 <ph type="x-smartling-placeholder">
    </ph>
  • 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_York、Europe/Vienna、Asia/Seoul。このフィールドを有効にするには、 アドオンのマニフェストで addOns.common.useLocaleFromApp を true に設定。 アドオンのスコープライストにも https://www.googleapis.com/auth/script.locale を含める必要があります。詳しくは、 <ph type="x-smartling-placeholder"></ph> 詳しくは、ユーザーの言語 / 地域とタイムゾーンにアクセスするをご覧ください。
commonEventObject.timeZone.offset string
ユーザーのタイムゾーンの協定世界時（UTC）からの時刻オフセット（ミリ秒単位）。詳しくは、 <ph type="x-smartling-placeholder"></ph> 詳しくは、ユーザーの言語 / 地域とタイムゾーンにアクセスするをご覧ください。

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

アクション コールバック関数 現在のウィジェット値を 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
ユーザーが選択した分。

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

カレンダーイベントオブジェクトは は、ユーザーのカレンダーとカレンダーの予定に関する情報を保持します。たった イベント オブジェクトに存在する必要があります。

次の表に、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
会議を表すオブジェクト コラボレーション ツールを利用できます。
conferenceData.conferenceSolution.iconUri string
ユーザーに表示されるアイコンの URI。 可能です。
conferenceData.conferenceSolution.key object
このイベントのコンファレンス ソリューションを一意に識別するキー。
conferenceData.conferenceSolution.key.type string
会議ソリューションのタイプ。有効な値 次の内容が含まれます。 <ph type="x-smartling-placeholder">
    </ph>
  • 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 文字です。形式はエントリ ポイントによって異なる type: <ph type="x-smartling-placeholder">
    </ph>
  • more: http: または https: スキーマが必要です。
  • phone: tel: スキーマが必要です。「 URI には、ダイヤル シーケンス全体（例: 「tel:+12345678900,,12345678;1234」）。
  • sip: sip: または sips: 必須です。例: 「sip:12345678@myprovider.com」。
  • video: http: または https: 必須です。

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

Drive イベント オブジェクトは、ユーザーの 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.accessToken string
Gmail 固有のアクセス トークン。次を使用: このトークンを <ph type="x-smartling-placeholder"></ph> 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
デフォルトで無効になっています。リスト 「To:」受信者のメールアドレスも含まれるため、 作成中です。このフィールドを有効にするには、 マニフェストに 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 スコープが設定された場合にのみ存在します。 。
Google ドキュメントの UI で開かれるドキュメントのタイトル。
docs.addonHasFileScopePermission boolean
true の場合、アドオンはリクエストを行っています 、受信済み: https://www.googleapis.com/auth/drive.file Google ドキュメント UI で開かれているドキュメントのスコープ承認それ以外の場合は、 フィールドは 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 の場合、アドオンはリクエストを行っています 、受信済み: https://www.googleapis.com/auth/drive.file Google スプレッドシートの UI で開かれているスプレッドシートのスコープ承認。 このフィールドは 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"
  }
}

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

スライド イベント オブジェクトは、イベント オブジェクト全体で ユーザーのドキュメントとその内容に関する情報が含まれます。モデルが イベント オブジェクト。

スライド イベント オブジェクト
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"
  }
}