イベント オブジェクト

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

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

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

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

    ホームページ トリガーの呼び出し時に作成されるイベント オブジェクトに、 フィールドが含まれます。関連するウィジェットと 省略されます。

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

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

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

    ウィジェット アクションの結果として作成されたイベント オブジェクトには、 コンテキストに応じたトリガー イベント オブジェクトに含まれるフィールドと、 表示できます。

  • リンクトリガーをプレビューする。 Google ドキュメント、スプレッドシート、スライドでは、 サードパーティ サービス用のリンク プレビューの設定 パターンを特定できますユーザーが要件を満たすリンクを操作した場合、 パターン、 linkPreviewTriggers が発生し、リンクを含むイベント オブジェクトがトリガーの 使用します。アドオンはこのイベント オブジェクトを使用して、 ホスト内でリンクに関する情報を表示するスマートチップとカード 説明します。ウィジェットのアクションを作成して、ユーザーが プレビュー カードとその内容が表示されます。

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

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

下位互換性を維持するため イベント オブジェクトには、作成時に使用された元のフィールドもすべて含まれます。 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
非推奨。スレッドのメッセージ ID Gmail UI で開きます。

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

eventObject.clientPlatform string
非推奨。イベントがどこで ウェブ、iOS、Android など、Google の独自コンテンツにアクセスできます。

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

eventObject.formInput object
非推奨。現在の値のマップ 1 つのウィジェットにつき 1 つの値に制限されます。「 キーはウィジェットに関連付けられた文字列 ID で、値は 使用します。このイベント オブジェクトは、formInput を 複数のウィジェットからデータを読み取る必要がある場合に、 単数形の値（テキスト入力やスイッチなど）が予期される値です。対象 チェックボックスなどの複数の値を持つウィジェットでは、 代わりに formInputs を使用してください。

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

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

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

eventObject.parameters object
非推奨。その他の追加情報のマップ パラメータで <ph type="x-smartling-placeholder"></ph> Action を使用 <ph type="x-smartling-placeholder"></ph> Action.setParameters()。マップのキーと値は次のとおりです。 使用します。

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。詳しくは、 <ph type="x-smartling-placeholder"></ph> 詳しくは、ユーザーの言語 / 地域とタイムゾーンにアクセスするをご覧ください。

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

eventObject.userTimezone.offset string
非推奨となり、デフォルトで無効になっています。「 <ph type="x-smartling-placeholder"></ph> ユーザーのタイムゾーン（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 の選択ツールの場合、 アクセスする DateTimeInput オブジェクト e.commonEventObject.formInputs.myDTPicker.dateTimeInput。

  • A date-only picker: DateInput object。

    例: ID が myDatePicker の選択ツールの場合、 アクセスする DateInput オブジェクトの e.commonEventObject.formInputs.myDatePicker.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 に提供します。 Action.setParameters()。
commonEventObject.userLocale string
デフォルトで無効。ユーザーの言語 および国/地域識別子の形式は、 ISO 639 言語コード - ISO 3166 国/地域コード。たとえば、en-US のようにします。

このフィールドを有効にするには、addOns.common.useLocaleFromApp を以下に設定する必要があります true と指定する必要があります。また、アドオンのスコープリストも https://www.googleapis.com/auth/script.locale を含めます。 <ph type="x-smartling-placeholder"></ph>をご覧ください。 詳しくは、ユーザーの言語 / 地域とタイムゾーンにアクセスするをご覧ください。

commonEventObject.timeZone string
デフォルトで無効。タイムゾーン ID オフセットされますこのフィールドを有効にするには、 アドオンのマニフェストで addOns.common.useLocaleFromApp を true に設定します。 アドオンのスコープリストには、 https://www.googleapis.com/auth/script.locale。 <ph type="x-smartling-placeholder"></ph>をご覧ください。 詳しくは、ユーザーの言語 / 地域とタイムゾーンにアクセスするをご覧ください。
commonEventObject.timeZone.id string
<ph type="x-smartling-placeholder"></ph> タイムゾーン識別子。以下に例を示します。 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
<ph type="x-smartling-placeholder"></ph> タイムゾーンの協定世界時（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
参加者の回答ステータス。可能 次のような値があります。 <ph type="x-smartling-placeholder">
    </ph>
  • accepted: 参加者がイベントを承諾しました 。
  • declined: 参加者は予定を辞退しました 。
  • needsAction: 参加者からまだ応答がありませんでした。 クリックします。
  • tentative: 参加者は、 クリックします。
attendee.self この参加者が以下の代表者である場合は boolean
true です。 この予定が表示されるカレンダーそうでない場合は false。

会議データ

会議データ オブジェクトは、接続されている会議に関する情報を保持する Google カレンダーの予定に 追加できますこれらは Google の会議ソリューションで、 Google Meet やサードパーティの会議など、この情報は データがカレンダーのイベントに存在し、かつ アドオンが addOns.calendar.currentEventAccess を設定します。 マニフェスト フィールドから READ または READ_WRITE。

会議データ オブジェクト
conferenceData.conferenceId string
会議の ID。この ID は、 アプリケーションで会議を追跡できるようにする。CANNOT TRANSLATE ユーザーにこの ID を表示します。
conferenceData.conferenceSolution object
会議を表すオブジェクト コラボレーション ツールを利用できます。
conferenceData.conferenceSolution.iconUri string
ユーザーに表示されるアイコンの URI。 可能です。
conferenceData.conferenceSolution.key object
データを一意に識別するキー Google Meet の会議ソリューションを検討します。
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 エントリ ポイントにのみ適用されます。 <ph type="x-smartling-placeholder">
    </ph>
  • toll: エントリ ポイントは有料通話です。
  • toll_free: エントリ ポイントはフリーダイヤルです。
entryPoint.entryPointType string
エントリ ポイントのタイプ。有効な値は次のとおりです。 次のとおりです。 <ph type="x-smartling-placeholder">
    </ph>
  • more: 会議参加に関するその他の手順 電話番号などです1 つの会議に more エントリ ポイント少なくとも 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
電話番号の地域コード。要件 ユーザーを返します。値のベース 一般公開の リージョン コードの 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: 必須です。

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

ドライブのイベントオブジェクトは には、ユーザーの 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 イベント オブジェクトは、イベント オブジェクト全体で ユーザーのドキュメントとその内容に関する情報が含まれます。モデルが イベント オブジェクトを返します。

ドキュメント イベント オブジェクト
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
次の条件が満たされる場合にのみ表示: <ph type="x-smartling-placeholder">
    </ph>
  • 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.id string
https://www.googleapis.com/auth/drive.file スコープが構成済みである場合にのみ表示されます できます。Google スプレッドシートの UI で開かれるスプレッドシートの ID。
sheets.title string
https://www.googleapis.com/auth/drive.file スコープが構成済みである場合にのみ表示されます できます。Google スプレッドシートで開いているスプレッドシートのタイトル UI です。
sheets.addonHasFileScopePermission boolean
true の場合、アドオンはリクエストを行っています 、受信済み: https://www.googleapis.com/auth/drive.file Google スプレッドシートの UI で開かれているスプレッドシートのスコープ承認。 このフィールドは false です。
sheets.matchedUrl.url string
次の条件が満たされる場合にのみ表示: <ph type="x-smartling-placeholder">
    </ph>
  • 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 スコープが構成済みである場合にのみ表示されます できます。スライドで開くプレゼンテーションの ID UI です。
slides.title string
https://www.googleapis.com/auth/drive.file スコープが構成済みである場合にのみ表示されます できます。Google Chat で開いたプレゼンテーションのタイトル スライド UI。
slides.addonHasFileScopePermission boolean
true の場合、アドオンはリクエストを行っています 、受信済み: https://www.googleapis.com/auth/drive.file スライド UI で開かれているプレゼンテーションのスコープ承認。 このフィールドは false です。
slides.matchedUrl.url string
次の条件が満たされる場合にのみ表示: <ph type="x-smartling-placeholder">
    </ph>
  • 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"
  }
}