- リソース: Deployment
- AddOns
- CommonAddOnManifest
- LayoutProperties
- AddOnWidgetSet
- WidgetType
- HomepageExtensionPoint
- UniversalActionExtensionPoint
- GmailAddOnManifest
- ContextualTrigger
- UnconditionalTrigger
- UniversalAction
- ComposeTrigger
- MenuItemExtensionPoint
- DraftAccess
- DriveAddOnManifest
- DriveExtensionPoint
- CalendarAddOnManifest
- ConferenceSolution
- CalendarExtensionPoint
- EventAccess
- DocsAddOnManifest
- DocsExtensionPoint
- LinkPreviewExtensionPoint
- UriPattern
- CreateActionExtensionPoint
- SheetsAddOnManifest
- SheetsExtensionPoint
- SlidesAddOnManifest
- SlidesExtensionPoint
- HttpOptions
- HttpAuthorizationHeader
- メソッド
リソース: Deployment
Google Workspace アドオンのデプロイ
JSON 表現 |
---|
{
"name": string,
"oauthScopes": [
string
],
"addOns": {
object ( |
フィールド | |
---|---|
name |
デプロイ リソース名。(例: |
oauthScopes[] |
アドオン エンドポイントを実行する前にエンドユーザーに同意を求める Google OAuth スコープのリスト。 |
addOns |
Google Workspace アドオンの構成。 |
etag |
この値は、ストレージ内のデプロイのバージョンに基づいてサーバーによって計算され、続行する前にクライアントが最新の値を持つことを確認するために、更新リクエストおよび削除リクエスト時に送信されます。 |
AddOns
Google Workspace アドオンの構成。
JSON 表現 |
---|
{ "common": { object ( |
フィールド | |
---|---|
common |
すべての Google Workspace アドオンに共通する構成。 |
gmail |
Gmail アドオンの構成。 |
drive |
ドライブ アドオンの構成。 |
calendar |
カレンダー アドオンの設定。 |
docs |
ドキュメント アドオンの構成。 |
sheets |
スプレッドシート アドオンの構成。 |
slides |
スライド アドオンの構成。 |
httpOptions |
アドオンの HTTP エンドポイントにリクエストを送信するオプション |
CommonAddOnManifest
すべてのアドオン ホスト アプリケーションで共有されるアドオン構成。
JSON 表現 |
---|
{ "name": string, "logoUrl": string, "layoutProperties": { object ( |
フィールド | |
---|---|
name |
必須。アドオンの表示名。 |
logoUrl |
必須。アドオン ツールバーに表示されるロゴ画像の URL。 |
layoutProperties |
アドオンカードの一般的なレイアウト プロパティ。 |
addOnWidgetSet |
アドオンで使用されるウィジェット。このフィールドが指定されていない場合は、デフォルトのセットが使用されます。 |
useLocaleFromApp |
ホストアプリからロケール情報を渡すかどうか。 |
homepageTrigger |
任意のコンテキスト、任意のホストで実行されるエンドポイントを定義します。この関数によって生成されたカードは常にユーザーに表示されますが、このアドオンでよりターゲットを絞ったトリガーが宣言されている場合、コンテキスト コンテンツによってカードが隠れる可能性があります。 |
universalActions[] |
アドオンの設定メニューとして機能するユニバーサル アクション メニューで拡張ポイントのリストを定義します。拡張ポイントには、開くリンク URL か、フォームの送信として実行するエンドポイントを指定できます。 |
openLinkUrlPrefixes |
OpenLink アクションでは、 |
LayoutProperties
すべてのアドオン ホスト アプリケーションで共有されるカード レイアウト プロパティ。
JSON 表現 |
---|
{ "primaryColor": string, "secondaryColor": string, "useNewMaterialDesign": boolean } |
フィールド | |
---|---|
primaryColor |
アドオンのメインの色。ツールバーの色を設定します。プライマリ カラーが設定されていない場合は、フレームワークで指定されたデフォルト値が使用されます。 |
secondaryColor |
アドオンのセカンダリ カラー。ボタンの色を設定します。プライマリ カラーは設定されているがセカンダリ カラーが設定されていない場合、セカンダリ カラーはプライマリ カラーと同じになります。プライマリ カラーもセカンダリ カラーも設定されていない場合は、フレームワークで指定されたデフォルト値が使用されます。 |
useNewMaterialDesign |
カードのマテリアル デザインを有効にします。 |
AddOnWidgetSet
アドオンで使用されるウィジェットのサブセット。
JSON 表現 |
---|
{
"usedWidgets": [
enum ( |
フィールド | |
---|---|
usedWidgets[] |
アドオンで使用されるウィジェットのリスト。 |
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 アドオン アクション。 |
HomepageExtensionPoint
アドオンのホームページ ビューを宣言するための一般的な形式です。
JSON 表現 |
---|
{ "runFunction": string, "enabled": boolean } |
フィールド | |
---|---|
runFunction |
必須。この拡張ポイントが有効になったときに実行されるエンドポイント。 |
enabled |
(省略可) 設定しない場合のデフォルトは アドオンのカスタム ホームページ ビューが無効になっている場合は、代わりに汎用の概要カードが表示されます。 |
UniversalActionExtensionPoint
ユニバーサル アクション メニュー項目の拡張ポイントを宣言するための形式です。
JSON 表現 |
---|
{ "label": string, // Union field |
フィールド | |
---|---|
label |
必須。この拡張ポイントを有効にして行った操作を説明する、ユーザーに表示されるテキスト(「新しい連絡先を追加」など)。 |
共用体フィールド action_type 。必須。ユニバーサル アクション メニュー項目でサポートされているアクション タイプ。開くリンクまたは実行するエンドポイントを指定できます。action_type は次のいずれかになります。 |
|
openLink |
UniversalAction によって開かれる URL。 |
runFunction |
UniversalAction によって実行されるエンドポイント。 |
GmailAddOnManifest
Gmail アドオンの外観と実行をカスタマイズするプロパティ。
JSON 表現 |
---|
{ "homepageTrigger": { object ( |
フィールド | |
---|---|
homepageTrigger |
宣言されたコンテキスト トリガーと一致しないコンテキストで実行されるエンドポイントを定義します。この関数によって生成されたカードは常にユーザーに表示されますが、このアドオンでよりターゲットを絞ったトリガーが宣言されている場合、コンテキスト コンテンツによってカードが隠れる可能性があります。 存在する場合、 |
contextualTriggers[] |
アドオンをトリガーする一連の条件を定義します。 |
universalActions[] |
アドオンの一連のユニバーサル アクションを定義します。ユーザーがアドオンのツールバー メニューからユニバーサル アクションをトリガーする。 |
composeTrigger |
作成時アドオンの作成時トリガーを定義します。これは、ユーザーがメールを作成する際にアドオンでアクションを実行するトリガーです。下書きを編集しない可能性がある場合でも、作成時のすべてのアドオンには |
authorizationCheckFunction |
サードパーティ API を調査して、アドオンに必要なサードパーティ承認がすべて揃っていることを確認するエンドポイントの名前。プローブが失敗した場合、関数は例外をスローして承認フローを開始します。この関数は、スムーズなユーザー エクスペリエンスを実現するため、アドオンが呼び出される前に呼び出されます。 |
ContextualTrigger
開封メールが特定の条件に一致したときに発動するトリガーを定義します。トリガーが発動すると、通常は新しいカードの作成と UI の更新を目的として特定のエンドポイントが実行されます。
JSON 表現 |
---|
{ "onTriggerFunction": string, // Union field |
フィールド | |
---|---|
onTriggerFunction |
必須。メッセージがトリガーに一致したときに呼び出すエンドポイントの名前。 |
共用体フィールド trigger 。トリガーのタイプによって、Gmail でアドオンの表示に使用される条件が決まります。trigger は次のいずれかになります。 |
|
unconditional |
メール メッセージが開かれると、無条件のトリガーが実行されます。 |
UnconditionalTrigger
このタイプにはフィールドがありません。
メール メッセージが開かれたときに配信されるトリガー。
UniversalAction
メールのコンテキストに関係なく、アドオンのツールバー メニューで常に利用できる操作です。
JSON 表現 |
---|
{ "text": string, // Union field |
フィールド | |
---|---|
text |
必須。ユーザーに表示される操作を説明するテキスト(例: 「新しい連絡先を追加」)。 |
共用体フィールド action_type 。アクションの種類によって、ユーザーがアクションを呼び出したときの Gmail の動作が決まります。action_type は次のいずれかになります。 |
|
openLink |
ユーザーがアクションをトリガーしたときに Gmail によって開かれるリンク。 |
runFunction |
ユーザーがアクションをトリガーしたときに呼び出されるエンドポイント。詳しくは、ユニバーサル アクションのガイドをご覧ください。 |
ComposeTrigger
ユーザーがメールを作成する際に有効になるトリガー。
JSON 表現 |
---|
{ "actions": [ { object ( |
フィールド | |
---|---|
actions[] |
作成時アドオンの一連のアクションを定義します。これらは、作成時アドオンでユーザーがトリガーできるアクションです。 |
draftAccess |
作成時アドオンがトリガーされたときのデータアクセスのレベルを定義します。 |
MenuItemExtensionPoint
ホストアプリ内に表示されるメニュー項目またはボタンを宣言するための一般的な形式。
JSON 表現 |
---|
{ "runFunction": string, "label": string, "logoUrl": string } |
フィールド | |
---|---|
runFunction |
必須。この拡張ポイントが有効になったときに実行されるエンドポイント。 |
label |
必須。この拡張ポイントを有効にして行った操作を説明する、ユーザーに表示されるテキスト。(例: 「請求書を挿入」)。 |
logoUrl |
アドオン ツールバーに表示されるロゴ画像の URL。 設定しない場合、アドオンのメインロゴの URL がデフォルトで使用されます。 |
DraftAccess
Compose トリガーに必要なデータアクセスのレベルを定義する列挙型。
列挙型 | |
---|---|
UNSPECIFIED |
draftaccess が設定されていない場合のデフォルト値。 |
NONE |
作成アドオンがトリガーされた場合、作成トリガーは下書きのデータにアクセスできません。 |
METADATA |
Compose アドオンがトリガーされたときに下書きのメタデータにアクセスする権限を Compose トリガーに付与します。これには、下書きメッセージの To リストや Cc リストなどのオーディエンス リストが含まれます。 |
DriveAddOnManifest
ドライブ アドオンの外観と実行をカスタマイズするプロパティ。
JSON 表現 |
---|
{ "homepageTrigger": { object ( |
フィールド | |
---|---|
homepageTrigger |
存在する場合、 |
onItemsSelectedTrigger |
マイドライブのドキュメントリストなど、関連するドライブのビューでアイテムが選択されたときに実行される動作に対応します。 |
DriveExtensionPoint
ドライブ アドオンのトリガーを宣言するための一般的な形式です。
JSON 表現 |
---|
{ "runFunction": string } |
フィールド | |
---|---|
runFunction |
必須。拡張ポイントが有効になったときに実行されるエンドポイント。 |
CalendarAddOnManifest
カレンダー アドオンの外観と実行をカスタマイズするプロパティ。
JSON 表現 |
---|
{ "homepageTrigger": { object ( |
フィールド | |
---|---|
homepageTrigger |
宣言されたコンテキスト トリガーと一致しないコンテキストで実行されるエンドポイントを定義します。この関数によって生成されたカードは常にユーザーに表示されますが、このアドオンでよりターゲットを絞ったトリガーが宣言されている場合、コンテキスト コンテンツによってカードが隠れる可能性があります。 存在する場合、 |
conferenceSolution[] |
このアドオンによって提供される会議ソリューションを定義します。 |
createSettingsUrlFunction |
アドオンの設定ページへの URL を作成するエンドポイント。 |
eventOpenTrigger |
イベントが表示または編集のために開かれたときにトリガーされるエンドポイント。 |
eventUpdateTrigger |
オープン イベントが更新されたときにトリガーされるエンドポイント。 |
currentEventAccess |
イベント アドオンがトリガーされたときのデータアクセスのレベルを定義します。 |
ConferenceSolution
会議関連の値を定義します。
JSON 表現 |
---|
{ "onCreateFunction": string, "id": string, "name": string, "logoUrl": string } |
フィールド | |
---|---|
onCreateFunction |
必須。会議データの作成時に呼び出すエンドポイント。 |
id |
必須。ID は、1 つのアドオン内の会議ソリューション間で一意に割り当てられる必要があります。そうしないと、アドオンがトリガーされたときに間違った会議ソリューションが使用される可能性があります。アドオンの表示名は変更できますが、ID は変更しないでください。 |
name |
必須。会議ソリューションの表示名。 |
logoUrl |
必須。会議ソリューションのロゴ画像の URL。 |
CalendarExtensionPoint
カレンダー アドオンのトリガーを宣言するための一般的な形式です。
JSON 表現 |
---|
{ "runFunction": string } |
フィールド | |
---|---|
runFunction |
必須。この拡張ポイントが有効になったときに実行されるエンドポイント。 |
EventAccess
データアクセス イベント トリガーに必要なレベルを定義する列挙型。
列挙型 | |
---|---|
UNSPECIFIED |
eventAccess に何も設定されていない場合のデフォルト値。 |
METADATA |
イベント ID やカレンダー ID などのイベントのメタデータにアクセスする権限をイベント トリガーに付与します。 |
READ |
メタデータ、参加者、会議データなど、指定されたすべてのイベント フィールドへのアクセス権をイベント トリガーに付与します。 |
WRITE |
イベント トリガーにイベントのメタデータへのアクセス権を付与し、参加者の追加や会議データの設定など、すべての操作を行う権限を付与します。 |
READ_WRITE |
メタデータ、参加者、会議データなど、指定されたすべてのイベント フィールドに対するアクセス権と、すべてのアクションの実行をイベント トリガーに付与します。 |
DocsAddOnManifest
Google ドキュメント アドオンの外観と実行をカスタマイズするプロパティ。
JSON 表現 |
---|
{ "homepageTrigger": { object ( |
フィールド | |
---|---|
homepageTrigger |
存在する場合、 |
onFileScopeGrantedTrigger |
このドキュメントとユーザーのペアに対してファイル スコープの承認が付与されたときに実行されるエンドポイント。 |
linkPreviewTriggers[] |
Google ドキュメント ドキュメント内のリンクをプレビューするための拡張ポイントのリスト。詳しくは、スマートチップを使用してリンクをプレビューするをご覧ください。 |
createActionTriggers[] |
Google Workspace アプリケーション内からサードパーティのリソースを作成するための拡張ポイントのリスト。詳細については、@ メニューからサードパーティ リソースを作成するをご覧ください。 |
DocsExtensionPoint
ドキュメント アドオンのトリガーを宣言するための一般的な形式です。
JSON 表現 |
---|
{ "runFunction": string } |
フィールド | |
---|---|
runFunction |
必須。この拡張ポイントが有効になったときに実行されるエンドポイント。 |
LinkPreviewExtensionPoint
ユーザーがサードパーティまたは Google 以外のサービスから Google ドキュメント、スプレッドシート、スライドのファイルにリンクを入力または貼り付けたときに配信されるトリガーの構成。
JSON 表現 |
---|
{
"labelText": string,
"localizedLabelText": {
string: string,
...
},
"patterns": [
{
object ( |
フィールド | |
---|---|
labelText |
必須。リンクのプレビューをユーザーに促すスマートチップの例のテキスト( |
localizedLabelText |
(省略可)他の言語にローカライズするための ユーザーの言語 / 地域が地図のキーに存在する場合、ローカライズされたバージョンの
|
patterns[] |
必須。リンクをプレビューするためにアドオンをトリガーする URL パターンの配列。 |
runFunction |
必須。リンク プレビューがトリガーされたときに実行されるエンドポイント。 |
logoUrl |
(省略可)スマートチップとプレビュー カードに表示されるアイコン。省略した場合、アドオンではツールバー アイコン |
UriPattern
リンク プレビューをトリガーする各 URL パターンの設定。
JSON 表現 |
---|
{ "hostPattern": string, "pathPrefix": string } |
フィールド | |
---|---|
hostPattern |
プレビューするには、各 URL パターンに必要です。URL パターンのドメイン。URL にこのドメインを含むリンクをプレビューします。特定のサブドメイン( たとえば、 |
pathPrefix |
(省略可) たとえば、URL ホストパターンが ホストパターン ドメイン内のすべての URL を照合する場合は、 |
CreateActionExtensionPoint
ユーザーが Google Workspace アプリケーションでリソース作成ワークフローを呼び出したときに配信されるトリガーの構成。詳細については、@ メニューからサードパーティ リソースを作成するをご覧ください。
JSON 表現 |
---|
{ "id": string, "labelText": string, "localizedLabelText": { string: string, ... }, "runFunction": string, "logoUrl": string } |
フィールド | |
---|---|
id |
必須。この拡張ポイントを区別するための一意の ID。ID は最大 64 文字で、 |
labelText |
必須。リソース作成のエントリ ポイントのアイコンと一緒に表示されるテキスト( |
localizedLabelText |
(省略可)他の言語にローカライズするための ユーザーの言語 / 地域が地図のキーに存在する場合、ローカライズされたバージョンの
|
runFunction |
必須。リソース作成ワークフローがトリガーされてリンクが作成されるときに実行されるエンドポイント。 |
logoUrl |
(省略可)リソース作成のエントリ ポイントに表示されるアイコン。省略した場合、メニューにはアドオンのツールバー アイコン |
SheetsAddOnManifest
Google スプレッドシート アドオンの外観と実行をカスタマイズするプロパティ。
JSON 表現 |
---|
{ "homepageTrigger": { object ( |
フィールド | |
---|---|
homepageTrigger |
存在する場合、 |
onFileScopeGrantedTrigger |
このドキュメントとユーザーのペアに対してファイル スコープの承認が付与されたときに実行されるエンドポイント。 |
linkPreviewTriggers[] |
Google スプレッドシート ドキュメント内のリンクをプレビューするための拡張ポイントのリスト。詳しくは、スマートチップを使用してリンクをプレビューするをご覧ください。 |
SheetsExtensionPoint
スプレッドシート アドオンのトリガーを宣言するための一般的な形式です。
JSON 表現 |
---|
{ "runFunction": string } |
フィールド | |
---|---|
runFunction |
必須。この拡張ポイントが有効になったときに実行されるエンドポイント。 |
SlidesAddOnManifest
Google スライドのアドオンの外観と実行をカスタマイズするプロパティ。
JSON 表現 |
---|
{ "homepageTrigger": { object ( |
フィールド | |
---|---|
homepageTrigger |
存在する場合、 |
onFileScopeGrantedTrigger |
このドキュメントとユーザーのペアに対してファイル スコープの承認が付与されたときに実行されるエンドポイント。 |
linkPreviewTriggers[] |
Google スライドのドキュメント内のリンクをプレビューするための拡張ポイントのリスト。詳しくは、スマートチップを使用してリンクをプレビューするをご覧ください。 |
SlidesExtensionPoint
スライド アドオンのトリガーを宣言するための一般的な形式です。
JSON 表現 |
---|
{ "runFunction": string } |
フィールド | |
---|---|
runFunction |
必須。この拡張ポイントが有効になったときに実行されるエンドポイント。 |
HttpOptions
アドオンの HTTP
エンドポイントにリクエストを送信するためのオプション。
JSON 表現 |
---|
{
"authorizationHeader": enum ( |
フィールド | |
---|---|
authorizationHeader |
|
HttpAuthorizationHeader
アドオンの HTTP
リクエストで送信される認証ヘッダー。
列挙型 | |
---|---|
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED |
デフォルト値。SYSTEM_ID_TOKEN と同等。 |
SYSTEM_ID_TOKEN |
プロジェクト固有の Google Workspace アドオンのシステム サービス アカウントの ID トークンを送信します(デフォルト)。 |
USER_ID_TOKEN |
エンドユーザーの ID トークンを送信します。 |
NONE |
Authentication ヘッダーを送信しないでください。 |
Methods |
|
---|---|
|
指定された名前と構成でデプロイを作成します。 |
|
指定した名前のデプロイメントを削除します。 |
|
指定された名前のデプロイメントを取得します。 |
|
テストデプロイのインストール ステータスを取得します。 |
|
テスト用に、アカウントにデプロイメントをインストールします。 |
|
特定のプロジェクト内のすべてのデプロイを一覧表示します。 |
|
指定された名前でデプロイを作成または置換します。 |
|
ユーザーのアカウントからテストデプロイをアンインストールします。 |