インデックス
AddOnWidgetSet
(メッセージ)AddOnWidgetSet.WidgetType
(列挙型)CommonAddOnManifest
(メッセージ)CreateActionExtensionPoint
(メッセージ)HomepageExtensionPoint
(メッセージ)HttpAuthorizationHeader
(列挙型)HttpOptions
(メッセージ)LayoutProperties
(メッセージ)LinkPreviewExtensionPoint
(メッセージ)MenuItemExtensionPoint
(メッセージ)UniversalActionExtensionPoint
(メッセージ)UriPattern
(メッセージ)
AddOnWidgetSet
アドオンで使用されるウィジェットのサブセット。
フィールド | |
---|---|
used |
アドオンで使用されるウィジェットのリスト。 |
WidgetType
ウィジェットのタイプ。WIDGET_TYPE_UNSPECIFIED
は基本的なウィジェット セットです。
列挙型 | |
---|---|
WIDGET_TYPE_UNSPECIFIED |
デフォルトのウィジェット セットです。 |
DATE_PICKER |
日付選択ツール。 |
STYLED_BUTTONS |
スタイル設定されたボタンには、塗りつぶしボタンと無効なボタンがあります。 |
PERSISTENT_FORMS |
永続フォームを使用すると、アクション中にフォームの値を保持できます。 |
FIXED_FOOTER |
カードのフッターを修正しました。 |
UPDATE_SUBJECT_AND_RECIPIENTS |
下書きの件名と受信者を更新する。 |
GRID_WIDGET |
グリッド ウィジェット。 |
ADDON_COMPOSE_UI_ACTION |
アドオンの作成 UI に適用される Gmail アドオンの操作。 |
CommonAddOnManifest
すべてのアドオンホスト アプリケーションで共有されるアドオン構成。
フィールド | |
---|---|
name |
必須。アドオンの表示名。 |
logo |
必須。アドオン ツールバーに表示されるロゴ画像の URL。 |
layout |
アドオン カードの一般的なレイアウト プロパティ。 |
add |
アドオンで使用されるウィジェット。このフィールドが指定されていない場合は、デフォルトのセットが使用されます。 |
use |
ホストアプリから言語 / 地域情報を渡すかどうか。 |
homepage |
任意のコンテキスト、任意のホストで実行されるエンドポイントを定義します。この関数で生成されるカードはすべて、ユーザーが常に利用できますが、このアドオンでさらにターゲットを絞ったトリガーが宣言されると、コンテキスト コンテンツによって置き換えられる場合があります。 |
universal |
アドオンの設定メニューとして機能するユニバーサル アクション メニュー内の拡張ポイントのリストを定義します。拡張ポイントは、開くリンク URL またはフォーム送信として実行するエンドポイントにすることができます。 |
open |
OpenLink アクションで使用できる URL は、 |
CreateActionExtensionPoint
ユーザーが Google Workspace アプリケーションでリソース作成ワークフローを呼び出したときに配信されるトリガーの構成。詳細については、@ メニューからサードパーティのリソースを作成するをご覧ください。
フィールド | |
---|---|
id |
必須。この拡張ポイントを区別する一意の ID。ID は 64 文字以下で、 |
label |
必須。リソース作成エントリ ポイントのアイコンの横に表示されるテキスト( |
localized |
省略可。他の言語にローカライズするための ユーザーのロケール キーが地図のキーに存在する場合、ローカライズされたバージョンの |
run |
必須。リソース作成ワークフローがトリガーされてリンクが作成されるときに実行されるエンドポイント。 |
logo |
省略可。リソース作成エントリ ポイントに表示されるアイコン。省略した場合、メニューにはアドオンのツールバー アイコン |
HomepageExtensionPoint
アドオンのホームページ ビューを宣言するための一般的な形式。
フィールド | |
---|---|
run |
必須。この拡張ポイントが有効になったときに実行するエンドポイント。 |
enabled |
省略可。 設定しない場合、デフォルトは アドオンのカスタム ホームページ ビューが無効になっている場合は、代わりに汎用の概要カードが表示されます。 |
HttpAuthorizationHeader
アドオンの HTTP
リクエストで送信される認証ヘッダー。
列挙型 | |
---|---|
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED |
デフォルト値。SYSTEM_ID_TOKEN と同等。 |
SYSTEM_ID_TOKEN |
プロジェクト固有の Google Workspace アドオンのシステム サービス アカウントの ID トークンを送信します(デフォルト)。 |
USER_ID_TOKEN |
エンドユーザーの ID トークンを送信します。 |
NONE |
Authentication ヘッダーは送信しないでください。 |
HttpOptions
アドオンの HTTP
エンドポイントにリクエストを送信するためのオプション。
フィールド | |
---|---|
authorization |
|
LayoutProperties
すべてのアドオン ホスト アプリケーションで共有されるカード レイアウト プロパティ。
フィールド | |
---|---|
primary |
アドオンのメインカラー。ツールバーの色を設定します。プライマリ カラーが設定されていない場合は、フレームワークから提供されるデフォルト値が使用されます。 |
secondary |
アドオンのセカンダリ カラー。ボタンの色を設定します。プライマリ カラーが設定されていて、セカンダリ カラーが設定されていない場合、セカンダリ カラーはプライマリ カラーと同じになります。プライマリ カラーもセカンダリ カラーも設定されていない場合は、フレームワークが提供するデフォルト値が使用されます。 |
use |
カードのマテリアル デザインを有効にします。 |
LinkPreviewExtensionPoint
ユーザーがサードパーティまたは Google 以外のサービスから Google ドキュメント、スプレッドシート、スライドのファイルにリンクを入力または貼り付けたときにトリガーされるトリガーの設定。
フィールド | |
---|---|
label |
必須。リンクをプレビューするようユーザーに促すスマートチップの例のテキスト( |
localized |
省略可。他の言語にローカライズする ユーザーのロケール キーが地図のキーに存在する場合、ローカライズされたバージョンの |
patterns[] |
必須。プレビュー リンクのアドオンをトリガーする URL パターンの配列。 |
run |
必須。リンク プレビューがトリガーされたときに実行するエンドポイント。 |
logo |
省略可。スマートチップとプレビュー カードに表示されるアイコン。省略した場合、アドオンではツールバー アイコン |
MenuItemExtensionPoint
ホストアプリ内に表示されるメニュー項目やボタンを宣言するための一般的な形式。
フィールド | |
---|---|
run |
必須。この拡張ポイントがアクティブになったときに実行されるエンドポイント。 |
label |
必須。この拡張ポイントを有効にすることで実行されるアクションを説明する、ユーザーに表示されるテキスト。(例: 「請求書を挿入」)。 |
logo |
アドオン ツールバーに表示されるロゴ画像の URL。 設定されていない場合、アドオンのメインロゴの URL がデフォルトになります。 |
UniversalActionExtensionPoint
ユニバーサル アクション メニュー項目の拡張ポイントを宣言する形式。
フィールド | |
---|---|
label |
必須。この拡張ポイントを有効にすることで実行されるアクションを説明する、ユーザーに表示されるテキスト(「新しい連絡先を追加」など)。 |
共用体フィールド action_type 。必須。ユニバーサル アクション メニュー アイテムでサポートされているアクション タイプ。開くリンクか、実行するエンドポイントのいずれかになります。action_type は次のいずれかになります。 |
|
open |
UniversalAction によって開く URL。 |
run |
UniversalAction によって実行されるエンドポイント。 |
UriPattern
リンク プレビューをトリガーする各 URL パターンの設定。
フィールド | |
---|---|
host |
プレビューする URL パターンごとに必須。URL パターンのドメイン。このアドオンは、URL にこのドメインを含むリンクをプレビューします。特定のサブドメイン( たとえば、 |
path |
省略可。 たとえば、URL ホストパターンが ホストパターン ドメイン内のすべての URL を一致させるには、 |