このページでは、Google Workspace アドオンのイベント オブジェクトの構造について説明します。
イベント オブジェクトは、ユーザーがアドオンを操作したときに自動的に構築され、トリガー関数またはコールバック関数にパラメータとして渡される JSON 構造です。イベント オブジェクトは、ホストアプリと現在のコンテキストに関するクライアント サイドの情報をアドオンのサーバーサイド コールバック関数に渡します。
Google Workspace アドオンでは、次の場所でイベント オブジェクトが使用されます。
ホームページ トリガー。 定義したすべての
homepageTrigger
関数には、ホームページ トリガー関数が起動したときにイベント オブジェクトが自動的に渡されます。このオブジェクトをホームページ トリガー関数で使用して、アクティブなホストアプリ、クライアントのプラットフォーム、ユーザーの言語 / 地域などの情報を特定できます。ホームページ トリガーが発火したときに作成されるイベント オブジェクトには、他の 2 つのケースに含まれるすべてのフィールドが含まれていません。ウィジェットとコンテキスト情報に関連するフィールドは省略されます。
コンテキスト トリガー。各ホストアプリは、ユーザーが特定のコンテキストに入ったときに起動するさまざまなコンテキスト トリガーを提供します。次に例を示します。
- Gmail は、ユーザーがメッセージを開いたときのコンテキスト トリガーと、ユーザーがメッセージを作成したときのコンテキスト トリガーを提供します。
- Google カレンダーには、ユーザーが予定を開いたときにトリガーされるコンテキスト トリガーが用意されています。
- Google ドライブは、ユーザーが ドライブ ファイルを選択したときにコンテキスト トリガーを提供します。
コンテキスト トリガーが起動すると、ホスト アプリケーションは、アドオン マニフェストに記載されている対応する
runFunction
を呼び出し、イベント オブジェクトをパラメータとして渡します。コンテキスト トリガーが発火したときに作成されるイベント オブジェクトには、ホームページ トリガー イベント オブジェクトに含まれるすべてのフィールドに加えて、コンテキスト情報を含むフィールドが含まれます。ウィジェットの操作。イベント オブジェクトは、Gmail アドオンで使用されるものと同じアクション モデルを使用して、ウィジェットのインタラクティビティを提供するためにも使用されます。Google Workspace アドオンは、同じウィジェット ハンドラ関数、
Action
オブジェクト、アクション レスポンスをすべて使用します。ただし、Google Workspace アドオンでは、アクション イベント オブジェクトに、コールバック関数が処理できる情報がさらに含まれています。ウィジェット アクションの結果として作成されるイベント オブジェクトには、コンテキスト トリガー イベント オブジェクトに含まれるすべてのフィールドと、ウィジェット情報を含むフィールドが含まれます。
プレビュー リンク トリガー。Google ドキュメント、スプレッドシート、スライドでは、特定の URL パターンに基づいてサードパーティ サービスのリンク プレビューを設定できます。ユーザーがパターンに一致するリンクを操作すると、
linkPreviewTriggers
が起動し、リンクを含むイベント オブジェクトがトリガーのコールバック関数に渡されます。アドオンは、このイベント オブジェクトを使用して、ホスト アプリケーション内のリンクに関する情報を表示するスマートチップとカードを作成できます。ウィジェット アクションを構築して、ユーザーがプレビュー カードとそのコンテンツを操作できるようにすることもできます。Google Chat アプリのトリガー。Google Chat では、アドオンはユーザーに Chat 用アプリとして表示されます。ユーザーは、スペースへの追加、メッセージの送信、スラッシュ コマンドの使用などによって、アドオンを操作できます。インタラクティブ機能を作成するには、さまざまな Chat 用アプリのトリガーを設定して使用します。各トリガーは、さまざまなイベント オブジェクト ペイロードを送信します。これにより、各タイプのインタラクションを処理または応答できます。
イベント オブジェクトの構造
次の表に、Google Workspace アドオンのイベント オブジェクトの最上位の構造を示します。イベント オブジェクト構造には、ホストに依存しない情報用の最上位フィールド commonEventObject
が含まれています。各イベント オブジェクトには、アクティブなホストアプリに応じて、gmailEventObject
、calendarEventObject
、driveEventObject
のいずれかのホスト固有のトップレベル フィールドを含めることもできます。
下位互換性を維持するため、Google Workspace アドオンのイベント オブジェクトには、Gmail アドオンのアクション イベント オブジェクトで使用される元のフィールドもすべて含まれています。これらのフィールドは、下の表の「元の Gmail アドオンのフィールド」に記載されています。これらのフィールドの情報は、新しいオブジェクト構造で再現されます。
イベント オブジェクト | |
---|---|
eventObject.commonEventObject |
Common fields object
ホスト アプリケーションに関係なく、すべてのイベント オブジェクトに共通の情報を含むオブジェクト。 |
eventObject.calendar |
Calendar event object
呼び出し元のホストが Google カレンダーの場合にのみ存在します。カレンダーと予定の情報を含むオブジェクト。 |
eventObject.chat |
Chat event object
呼び出し元のホストが Google Chat の場合にのみ存在します。Chat 情報を含むオブジェクト。 |
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 非推奨となり、デフォルトで無効になりました。ユーザーのタイムゾーンの タイムゾーン ID。例: 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 actionParameters または
Action.setParameters() を使用してアクションに指定する追加のパラメータ。デベロッパー プレビュー: Google Chat を拡張するアドオンで、ユーザーが複数選択メニューに入力した内容に基づいて項目を提案するには、 |
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 ユーザーのタイムゾーンの タイムゾーン ID。例: 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
フィールドで現在のウィジェット値を受け取ることができます。これには、日付または時刻選択ウィジェットでユーザーが選択した日付または時刻の値が含まれます。ただし、情報の構造は、ウィジェットが日時選択ツール、日付のみの選択ツール、時刻のみの選択ツールのいずれとして構成されたかによって異なります。構造上の違いは次の表のとおりです。
Chat イベント オブジェクト
Chat イベント オブジェクトは、ユーザーが Chat 用アプリとやり取りした情報を含む、イベント オブジェクト全体の一部です。アドオンが Google Chat を拡張している場合にのみ、イベント オブジェクトに存在します。
チャット | |
---|---|
chat.user |
object
(User)
Chat アプリとやり取りした Chat ユーザー。 |
chat.space |
object
(Space)
ユーザーが Chat 用アプリとやり取りした Chat スペース。 |
chat.eventTime |
|
共用体フィールド
|
|
chat.messagePayload |
Chat 用アプリが メッセージ トリガーから受け取るペイロード。 |
chat.addedToSpacePayload |
Chat 用アプリが Added to space トリガーから受け取るペイロード。 |
chat.removedFromSpacePayload |
Removed from space トリガーから Chat 用アプリが受け取るペイロード。 |
chat.buttonClickedPayload |
ユーザーがメッセージまたはカードのボタンをクリックしたときに Chat 用アプリが受け取るペイロード。ユーザーがボタンをクリックして情報を送信すると、 |
chat.widgetUpdatedPayload |
ユーザーが
|
chat.appCommandPayload |
ユーザーが Chat 用アプリのコマンドを使用したときに Chat 用アプリが受け取るペイロード。 |
ペイロード
Chat 用アプリのインタラクションのタイプに応じて、イベントには 1 つ以上の Chat API リソースを含むペイロードが含まれます。
メッセージ ペイロード
MessagePayload | |
---|---|
chat.messagePayload.message |
object
(Message)
イベントをトリガーした Chat メッセージ。 |
chat.messagePayload.space |
object
(Space)
ユーザーが Chat 用アプリを呼び出したメッセージを送信した Chat スペース。 |
chat.messagePayload.configCompleteRedirectUri |
string Google Chat の外部で認証フローまたは構成フローを完了した後に、Chat 用アプリがユーザーをリダイレクトする URL。詳しくは、Google Workspace アドオンをサードパーティ サービスに接続するをご覧ください。 |
スペースのペイロードに追加
AddedToSpacePayload | |
---|---|
chat.addedToSpacePayload.space |
object
(Space)
ユーザーが Chat アプリを追加またはインストールした Chat スペース。 管理者が Chat 用アプリをインストールすると、 |
chat.addedToSpacePayload.interactionAdd |
boolean ユーザーがメッセージを使用して Chat 用アプリをスペースに追加するかどうか。たとえば、Chat 用アプリを @メンションしたり、コマンドを使用したりします。 true の場合、Chat はメッセージに関する情報を含む messagePayload を含む別のイベント オブジェクトを送信します。 |
chat.addedToSpacePayload.configCompleteRedirectUri |
string Google Chat の外部で認証フローまたは構成フローを完了した後に、Chat 用アプリがユーザーをリダイレクトする URL。詳しくは、Google Workspace アドオンをサードパーティ サービスに接続するをご覧ください。 |
スペースのペイロードから削除
RemovedFromSpacePayload | |
---|---|
chat.removedFromSpacePayload.space |
object
(Space)
ユーザーが Chat アプリを削除またはアンインストールした Chat スペース。 管理者が Chat 用アプリをアンインストールすると、 |
ボタンがクリックされたペイロード
ButtonClickedPayload | |
---|---|
chat.buttonClickedPayload.message |
object
(Message)
ユーザーがクリックしたボタンを含む Chat メッセージ。 |
chat.buttonClickedPayload.space |
object
(Space)
ユーザーが Chat 用アプリのメッセージのボタンをクリックした Chat スペース。 |
chat.buttonClickedPayload.isDialogEvent |
boolean ユーザーがボタンをクリックしてダイアログを操作したかどうか。 |
chat.buttonClickedPayload.dialogEventType |
enum (DialogEventType) isDialogEvent が true の場合、ダイアログのインタラクションのタイプ。 |
列挙型
|
|
TYPE_UNSPECIFIED |
デフォルト値。(指定なし) |
REQUEST_DIALOG |
ユーザーがダイアログをリクエストします。たとえば、コマンドを使用したり、メッセージのボタンをクリックしたりします。 |
SUBMIT_DIALOG |
ユーザーがダイアログ内のインタラクティブ要素をクリックします。たとえば、ユーザーがダイアログに情報を入力し、ボタンをクリックして情報を送信します。 |
ウィジェット更新のペイロード
WidgetUpdatedPayload | |
---|---|
chat.widgetUpdatedPayload.space |
object
(Space)
インタラクションが発生した Chat スペース。 |
アプリ コマンドのペイロード
AppCommandPayload | |
---|---|
chat.appCommandPayload.appCommandMetadata |
object
(AppCommandMetadata)
ユーザーが使用したコマンドと、コマンドをトリガーした方法に関するメタデータ。 |
chat.appCommandPayload.space |
object
(Space)
ユーザーがコマンドを使用した Chat スペース。 |
chat.appCommandPayload.thread |
object
(Thread)
インタラクションがスレッドで発生した場合、ユーザーがコマンドを使用した Chat スレッド。 |
chat.appCommandPayload.message |
object
(Message)
スラッシュ コマンドの場合、スラッシュ コマンドを含むメッセージ。 |
chat.appCommandPayload.configCompleteRedirectUri |
string コマンドに承認または構成が必要な場合、Google Chat の外部でプロセスを完了した後にユーザーをリダイレクトする URL。 |
chat.appCommandPayload.isDialogEvent |
boolean コマンドがダイアログを開くかどうか。 |
chat.appCommandPayload.dialogEventType |
enum (DialogEventType) ダイアログとのインタラクションのタイプ。 |
列挙型
|
|
TYPE_UNSPECIFIED |
デフォルト値。(指定なし) |
REQUEST_DIALOG |
ユーザーがダイアログをリクエストします。たとえば、コマンドを使用したり、メッセージのボタンをクリックしたりします。 |
SUBMIT_DIALOG |
ユーザーがダイアログ内のインタラクティブ要素をクリックします。たとえば、ユーザーがダイアログに情報を入力し、ボタンをクリックして情報を送信します。 |
アプリ コマンドのメタデータ
AppCommandMetadata | |
---|---|
chat.appCommandPayload.appCommandMetadata.appCommandId |
コマンド ID。 |
chat.appCommandPayload.appCommandMetadata.appCommandType |
enum (AppCommandType) コマンドのタイプ。 |
列挙型
|
|
APP_COMMAND_TYPE_UNSPECIFIED |
デフォルト値。(指定なし) |
SLASH_COMMAND |
ユーザーは、スラッシュ / で始まるメッセージを送信してコマンドを使用します。 |
QUICK_COMMAND |
ユーザーがメッセージの返信欄の Chat メニューからコマンドを選択します。 |
カレンダーの予定オブジェクト
カレンダー イベント オブジェクトは、ユーザーのカレンダーとカレンダー イベントに関する情報を伝達する、イベント オブジェクト全体の一部です。アドオンが 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 オブジェクト | |
---|---|
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
マニフェスト フィールドが 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 会議ソリューションのタイプ。有効な値は次のとおりです。
|
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 エントリ ポイントにのみ適用されます。
|
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 デフォルトで無効。アドオンが作成中の下書きに現在含まれている [宛先] の受信者のメールアドレスのリスト。このフィールドを有効にするには、マニフェストの 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 スコープがユーザーによって承認されている場合にのみ存在します。ドキュメント UI で開いているドキュメントのタイトル。 |
docs.addonHasFileScopePermission |
boolean true の場合、アドオンは Docs 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 スコープがユーザーによって承認されている場合にのみ存在します。Google スプレッドシートの UI で開いているスプレッドシートのタイトル。 |
sheets.addonHasFileScopePermission |
boolean true の場合、アドオンは Sheets 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" } } |