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