このページでは、Google Workspace アドオンのイベント オブジェクトの構造について説明します。
イベント オブジェクトは JSON 構造です。この構造は自動的に構築され、ユーザーがアドオンを操作すると、トリガーまたはコールバック関数用のパラメータとして渡されます。イベント オブジェクトは、ホストアプリと現在のコンテキストに関するクライアント側の情報を、アドオンのサーバー側コールバック関数に伝達します。
Google Workspace アドオンは、次の場所でイベント オブジェクトを使用します。
ホームページ トリガー。定義したすべての
homepageTrigger
関数は、ホームページ トリガー関数が呼び出されると自動的にイベント オブジェクトに渡されます。このオブジェクトをホームページのトリガー関数で使用すると、アクティブなホストアプリ、クライアントのプラットフォーム、ユーザーの言語 / 地域などの情報を識別できます。ホームページ トリガーの起動時に作成されるイベント オブジェクトには、他の 2 つのケースに含まれるすべてのフィールドは含まれません。ウィジェットとコンテキスト情報に関連するフィールドは省略されます。
コンテキスト トリガー。各ホスト アプリケーションは、ユーザーが特定のコンテキストを入力したときに起動する、異なるコンテキスト トリガーのセットを提供します。次に例を示します。
- Gmail では、ユーザーがメッセージを開いたときと、メッセージを作成したときの、コンテキストに応じたトリガーが用意されています。
- Google カレンダーでは、ユーザーが予定を開いたときに、コンテキストに応じたトリガーが提供されます。
- Google ドライブでは、ユーザーがドライブのファイルを選択すると、コンテキストに応じてトリガーされます。
コンテキスト トリガーが起動すると、ホストアプリはアドオン マニフェストにリストされている対応する
runFunction
を呼び出し、イベント オブジェクトをパラメータとして渡します。コンテキスト トリガーが発動したときに作成されるイベント オブジェクトには、ホームページ トリガー イベント オブジェクトに含まれるすべてのフィールドと、コンテキスト情報を含むフィールドが含まれます。ウィジェットの操作。イベント オブジェクトは、Gmail アドオンが使用するのと同じアクション モデルを使用して、ウィジェット インタラクティビティを提供するためにも使用されます。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 ドキュメントの場合にのみ表示されます。ドキュメントの情報を含むオブジェクト。 |
eventObject.sheets |
Sheets event object
呼び出し元のホストが Google スプレッドシートの場合にのみ存在します。スプレッドシートの情報を含むオブジェクト。 |
eventObject.slides |
Slides event object
主催者が Google スライドの場合にのみ表示。スライドの情報を含むオブジェクト。 |
元の Gmail アドオン フィールド | |
eventObject.messageMetadata.accessToken |
string 非推奨。アクセス トークン。これを使用すると、一時的な Gmail アドオン スコープを使用するユーザーデータへのアクセスを有効にできます。
Google Workspace アドオンの場合、この情報は |
eventObject.messageMetadata.messageId |
string 非推奨。Gmail UI で開かれているスレッドのメッセージ ID。
Google Workspace アドオンの場合、この情報は |
eventObject.clientPlatform |
string 非推奨。イベントの発生元を示します(ウェブ、iOS、Android)。
Google Workspace アドオンの場合、この情報は |
eventObject.formInput |
object 非推奨。カード内のすべてのフォーム ウィジェットの現在の値のマップ。ウィジェットごとに 1 つの値に制限されます。キーはウィジェットに関連付けられた文字列 ID で、値は文字列です。イベント オブジェクトは、想定される単数形の値を持つ複数のウィジェット(テキスト入力やスイッチなど)からデータを読み取る必要がある場合に役立つ formInput を提供します。チェックボックスなど、複数の値を持つウィジェットの場合は、代わりに formInputs から各値を読み取ることができます。
Google Workspace アドオンの場合、この情報は |
eventObject.formInputs |
object 非推奨。カード内のウィジェットの現在の値のマップ。文字列のリストとして示されます。キーは、ウィジェットに関連付けられた文字列 ID です。単一値ウィジェットの場合、値は単一要素の配列で表されます。チェックボックス グループなど、複数の値を持つウィジェットの場合、すべての値がリストで表示されます。
Google Workspace アドオンの場合、この情報は |
eventObject.parameters |
object 非推奨。 Action.setParameters() を使用して
Action に指定する追加パラメータのマップ。マップのキーと値は文字列です。
Google Workspace アドオンの場合、この情報は |
eventObject.userCountry |
string 非推奨であり、デフォルトで無効になっています。ユーザーの国または地域を示す 2 文字のコード。数値の UN M49 国コードを指定することもできます。
Google Workspace アドオンの場合、この情報は |
eventObject.userLocale |
string 非推奨であり、デフォルトで無効になっています。ユーザーの言語を示す 2 文字の ISO 639 コード。詳しくは、ユーザーの言語 / 地域とタイムゾーンへのアクセスをご覧ください。
Google Workspace アドオンの場合、この情報は |
eventObject.userTimezone.id |
string 非推奨であり、デフォルトで無効になっています。ユーザーのタイムゾーンの タイムゾーン識別子。たとえば、 America/New_York 、Europe/Vienna 、Asia/Seoul などです。詳しくは、
ユーザーの言語 / 地域とタイムゾーンへのアクセスをご覧ください。
Google Workspace アドオンの場合、この情報は |
eventObject.userTimezone.offset |
string 非推奨であり、デフォルトで無効になっています。ユーザーのタイムゾーンの 協定世界時(UTC)からの時間オフセット(ミリ秒単位)。詳しくは、 ユーザーの言語 / 地域とタイムゾーンへのアクセスをご覧ください。
Google Workspace アドオンの場合、この情報は |
一般的なイベント オブジェクト
共通のイベント オブジェクトは、イベント オブジェクト全体の一部で、ホストに依存しない一般的な情報をユーザーのクライアントからアドオンに送信します。この情報には、ユーザーの言語 / 地域、ホストアプリ、プラットフォームなどの詳細が含まれます。
アドオンは、ホームページとコンテキスト トリガーに加えて、ユーザーがウィジェットを操作したときにイベント オブジェクトを作成してアクション コールバック関数に渡します。アドオンのコールバック関数は、共通イベント オブジェクトをクエリして、ユーザーのクライアントで開かれているウィジェットの内容を判別できます。たとえば、アドオンは、ユーザーが eventObject.commentEventObject.formInputs
オブジェクトの TextInput
ウィジェットに入力したテキストを見つけることができます。
一般的なイベント オブジェクト フィールド | |
---|---|
commonEventObject.platform |
string イベントの発生場所(「WEB」、「IOS」、「ANDROID」)を示します。 |
commonEventObject.formInputs |
object 表示されたカード内のウィジェットの現在の値を含むマップ。マップキーは、各ウィジェットに割り当てられた文字列 ID です。 マップ値オブジェクトの構造はウィジェットのタイプによって異なります。
|
commonEventObject.hostApp |
string イベント オブジェクトの生成時にアドオンがアクティブになっているホストアプリを示します。有効な値は次のとおりです。
|
commonEventObject.parameters |
object
Action.setParameters() を使用して
Action に指定する追加パラメータ。 |
commonEventObject.userLocale |
string デフォルトで無効。ユーザーの言語と国/地域の識別子。ISO 639 言語コード(ISO 3166 国/地域コード)の形式で指定します。例: en-US
このフィールドを有効にするには、アドオンのマニフェストで |
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
フィールドで現在のウィジェット値を受け取ることができます。これには、日付選択ツールや時刻選択ツールでユーザーが選択した日付や時刻の値が含まれます。ただし、情報の構造は、ウィジェットが日時選択ツール、日付のみの選択ツール、時間のみの選択ツールのいずれとして構成されているかによって異なります。次の表に、構造上の違いを示します。
Calendar イベント オブジェクト
カレンダー イベント オブジェクトは、ユーザーのカレンダーやカレンダーの予定に関する情報を含んだイベント オブジェクト全体の一部です。ホストアプリケーションが Google カレンダーである場合にのみ、イベント オブジェクトに存在します。
次の表に、イベント オブジェクトの calendarEventObject
フィールドのフィールドを示します。データがカレンダーの予定に存在し、アドオンで addOns.calendar.currentEventAccess
マニフェスト フィールドが READ
または READ_WRITE
に設定されている場合にのみ、「ユーザー生成データ」とマークされたフィールドがイベント オブジェクト内に存在します。
Calendar イベント オブジェクト | |
---|---|
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
manifest フィールドを READ
または READ_WRITE
に設定する場合のみです。
Attendee オブジェクト | |
---|---|
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 参加者の回答ステータス。有効な値は次のとおりです。
|
attendee.self |
boolean この参加者がこの予定が表示されるカレンダーを表す場合は true 、それ以外の場合は false です。
|
会議データ
会議データ オブジェクトには、Google カレンダーの予定に関連付けられた会議に関する情報が格納されます。これには、Google Meet などの Google の会議ソリューションやサードパーティの会議が含まれます。この情報は、カレンダーの予定にデータが存在し、アドオンで addOns.calendar.currentEventAccess
manifest フィールドが READ
または READ_WRITE
に設定されている場合にのみ、イベント オブジェクトに含まれます。
会議データ オブジェクト | |
---|---|
conferenceData.conferenceId |
string 会議の ID。この ID は、アプリケーションで会議を追跡できるようにするためのものです。ユーザーに対して表示しないでください。 |
conferenceData.conferenceSolution |
object ハングアウトや Google Meet などの会議ソリューションを表すオブジェクト。 |
conferenceData.conferenceSolution.iconUri |
string この会議ソリューションを表す、ユーザーに表示されるアイコンの URI。 |
conferenceData.conferenceSolution.key |
object このイベントの会議ソリューションを一意に識別するキー。 |
conferenceData.conferenceSolution.key.type |
string 会議ソリューションのタイプ。有効な値は次のとおりです。
|
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
manifest フィールドを READ
または READ_WRITE
に設定する場合のみです。
エントリ ポイント オブジェクト | |
---|---|
entryPoint.accessCode |
string 会議へのアクセスに使用されるアクセスコード。最大文字数は 128 文字です。会議プロバイダは通常、{ accessCode 、meetingCode 、passcode 、password 、pin } のサブセットのみを使用して、会議へのアクセスを提供します。会議プロバイダが使用するフィールドのみを照合します。
|
entryPoint.entryPointFeatures |
list エントリ ポイントの機能。現在、これらの機能は phone エントリ ポイントにのみ適用されます。
|
entryPoint.entryPointType |
string エントリ ポイントのタイプ。有効な値は次のとおりです。
|
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 文字です。形式は、エントリ ポイントのタイプによって異なります。
|
ドライブ イベント オブジェクト
ドライブ イベント オブジェクトは、ユーザーの 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 デフォルトで無効。アドオンの作成中に下書きに現在含まれている「To:」受信者のメールアドレスのリスト。このフィールドを有効にするには、マニフェストの 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
次の条件が満たされる場合にのみ存在します。
Google ドキュメントでプレビューを生成するリンクの URL。このフィールドを使用するには、アドオンのマニフェストで LinkPreviewTriggers を設定する必要があります。詳しくは、スマートチップを使用してリンクをプレビューするをご覧ください。
ユーザーがリンク "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
次の条件が満たされる場合にのみ存在します。
Google スプレッドシートでプレビューを生成するリンクの URL。このフィールドを使用するには、アドオンのマニフェストで LinkPreviewTriggers を設定する必要があります。詳しくは、スマートチップを使用してリンクをプレビューするをご覧ください。
ユーザーがリンク "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
次の条件が満たされる場合にのみ存在します。
Google スライドでプレビューを生成するリンクの URL。このフィールドを使用するには、アドオンのマニフェストで LinkPreviewTriggers を設定する必要があります。
詳しくは、スマートチップを使用してリンクをプレビューするをご覧ください。
ユーザーがリンク "slides" : { "matchedUrl" : { "url" : "https://www.example.com/12345" } } |