REST Resource: projects.deployments

リソース: Deployment

Google Workspace アドオンのデプロイ

JSON 表現 
{
  "name": string,
  "oauthScopes": [
    string
  ],
  "addOns": {
    object (AddOns)
  },
  "etag": string
}
フィールド
name

string

デプロイ リソース名。例: projects/123/deployments/my_deployment。
oauthScopes[]

string

アドオン エンドポイントを実行する前にエンドユーザーに同意を求める Google OAuth スコープのリスト。
addOns

object (AddOns)

Google Workspace アドオンの構成。
etag

string

この値は、ストレージ内のデプロイのバージョンに基づいてサーバーによって計算されます。これは、更新リクエストと削除リクエストで送信され、続行する前にクライアントが最新の値を持っていることを確認できます。

AddOns

Google Workspace アドオンの構成。

JSON 表現 
{
  "common": {
    object (CommonAddOnManifest)
  },
  "gmail": {
    object (GmailAddOnManifest)
  },
  "drive": {
    object (DriveAddOnManifest)
  },
  "calendar": {
    object (CalendarAddOnManifest)
  },
  "docs": {
    object (DocsAddOnManifest)
  },
  "meet": {
    object (MeetAddOnManifest)
  },
  "sheets": {
    object (SheetsAddOnManifest)
  },
  "slides": {
    object (SlidesAddOnManifest)
  },
  "httpOptions": {
    object (HttpOptions)
  }
}
フィールド
common

object (CommonAddOnManifest)

すべての Google Workspace アドオンに共通する構成。
gmail

object (GmailAddOnManifest)

Gmail アドオンの構成。
drive

object (DriveAddOnManifest)

ドライブ アドオンの構成。
calendar

object (CalendarAddOnManifest)

カレンダー アドオンの構成。
docs

object (DocsAddOnManifest)

ドキュメント アドオンの構成。
meet

object (MeetAddOnManifest)

Meet アドオンの構成。
sheets

object (SheetsAddOnManifest)

スプレッドシート アドオンの構成。
slides

object (SlidesAddOnManifest)

スライド アドオンの構成。
httpOptions

object (HttpOptions)

アドオンの HTTP エンドポイントにリクエストを送信するためのオプション

CommonAddOnManifest

すべてのアドオン ホスト アプリケーション間で共有されるアドオン構成。

JSON 表現 
{
  "name": string,
  "logoUrl": string,
  "layoutProperties": {
    object (LayoutProperties)
  },
  "addOnWidgetSet": {
    object (AddOnWidgetSet)
  },
  "useLocaleFromApp": boolean,
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "universalActions": [
    {
      object (UniversalActionExtensionPoint)
    }
  ],
  "openLinkUrlPrefixes": array
}
フィールド
name

string

必須。アドオンの表示名。
logoUrl

string

必須。アドオンのツールバーに表示されるロゴ画像の URL。
layoutProperties

object (LayoutProperties)

アドオンカードの共通レイアウト プロパティ。
addOnWidgetSet

object (AddOnWidgetSet)

アドオンで使用されているウィジェット。このフィールドが指定されていない場合は、デフォルトのセットが使用されます。
useLocaleFromApp

boolean

ホストアプリからロケール情報を渡すかどうか。
homepageTrigger

object (HomepageExtensionPoint)

任意のコンテキスト、任意のホストで実行されるエンドポイントを定義します。この関数で生成されたカードは常にユーザーが利用できますが、このアドオンがよりターゲットを絞ったトリガーを宣言すると、コンテキスト コンテンツによって隠される可能性があります。
universalActions[]

object (UniversalActionExtensionPoint)

アドオンの設定メニューとして機能する、ユニバーサル アクション メニューの拡張ポイントのリストを定義します。拡張ポイントは、開くリンク URL またはフォーム送信として実行するエンドポイントにできます。
openLinkUrlPrefixes

array (ListValue format)

OpenLink アクションでは、HTTPS、MAILTO、TEL スキームの URL のみを使用できます。HTTPS リンクの場合、URL は許可リストで指定された接頭辞のいずれかと一致している必要があります。接頭辞でスキームが省略されている場合は、HTTPS が想定されます。HTTP リンクは HTTPS リンクに自動的に書き換えられます。

LayoutProperties

すべてのアドオン ホスト アプリケーションで共有されるカード レイアウト プロパティ。

JSON 表現 
{
  "primaryColor": string,
  "secondaryColor": string,
  "useNewMaterialDesign": boolean
}
フィールド
primaryColor

string

アドオンのメインの色。ツールバーの色を設定します。プライマリ カラーが設定されていない場合は、フレームワークによって提供されるデフォルト値が使用されます。
secondaryColor

string

アドオンのセカンダリ カラー。ボタンの色を設定します。プライマリ カラーが設定されていてもセカンダリ カラーが設定されていない場合、セカンダリ カラーはプライマリ カラーと同じになります。プライマリ カラーもセカンダリ カラーも設定されていない場合は、フレームワークによって提供されるデフォルト値が使用されます。
useNewMaterialDesign
(deprecated)

boolean

カードのマテリアル デザインを有効にします。

AddOnWidgetSet

アドオンで使用されるウィジェットのサブセット。

JSON 表現 
{
  "usedWidgets": [
    enum (WidgetType)
  ]
}
フィールド
usedWidgets[]

enum (WidgetType)

アドオンで使用されるウィジェットのリスト。

WidgetType

ウィジェットのタイプ。WIDGET_TYPE_UNSPECIFIED は基本的なウィジェット セットです。

列挙型
WIDGET_TYPE_UNSPECIFIED デフォルトのウィジェット セット。
DATE_PICKER 日付選択ツール。
STYLED_BUTTONS スタイル付きボタンには、塗りつぶしボタンと無効化されたボタンがあります。
PERSISTENT_FORMS 永続フォームを使用すると、アクション中にフォームの値を保持できます。
UPDATE_SUBJECT_AND_RECIPIENTS 下書きの件名と宛先を更新します。
GRID_WIDGET グリッド ウィジェット。
ADDON_COMPOSE_UI_ACTION アドオンの作成 UI に適用される Gmail アドオン アクション。

HomepageExtensionPoint

アドオンのホームページ ビューを宣言するための一般的な形式。

JSON 表現 
{
  "runFunction": string,
  "enabled": boolean
}
フィールド
runFunction

string

必須。この拡張ポイントが有効になったときに実行されるエンドポイント。
enabled

boolean

省略可。false に設定すると、このコンテキストでホームページ ビューが無効になります。

設定しない場合、デフォルトは true です。

アドオンのカスタム ホームページ ビューが無効になっている場合、代わりに汎用の概要カードがユーザーに表示されます。

UniversalActionExtensionPoint

ユニバーサル アクション メニュー項目の拡張ポイントを宣言する形式。

JSON 表現 
{
  "label": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}
フィールド
label

string

必須。この拡張ポイントを有効にしたときに実行されるアクションを説明する、ユーザーに表示されるテキスト（「新しい連絡先を追加」など）。
共用体フィールド action_type。必須。ユニバーサル アクション メニュー アイテムでサポートされているアクション タイプ。開くリンクまたは実行するエンドポイントのいずれかになります。action_type は次のいずれかになります。
runFunction

string

UniversalAction によって実行されるエンドポイント。

GmailAddOnManifest

Gmail アドオンの外観と実行をカスタマイズするプロパティ。

JSON 表現 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "authorizationCheckFunction": string
}
フィールド
homepageTrigger

object (HomepageExtensionPoint)

宣言されたコンテキスト トリガーと一致しないコンテキストで実行されるエンドポイントを定義します。この関数で生成されたカードは常にユーザーが利用できますが、このアドオンがよりターゲットを絞ったトリガーを宣言すると、コンテキスト コンテンツによって隠されることがあります。

存在する場合は、addons.common.homepageTrigger の構成をオーバーライドします。
contextualTriggers[]

object (ContextualTrigger)

アドオンをトリガーする条件のセットを定義します。
universalActions[]

object (UniversalAction)

アドオンのユニバーサル アクションのセットを定義します。ユーザーは、アドオンのツールバー メニューからユニバーサル アクションをトリガーします。
composeTrigger

object (ComposeTrigger)

作成時アドオンの作成時トリガーを定義します。これは、ユーザーがメールを作成しているときにアドオンがアクションを実行するトリガーです。下書きを編集しない場合でも、すべての作成時アドオンに gmail.addons.current.action.compose スコープが必要です。
authorizationCheckFunction

string

サードパーティ API をプローブして、アドオンに必要なサードパーティのすべての承認があることを確認するエンドポイントの名前。プローブが失敗した場合、関数は例外をスローして承認フローを開始する必要があります。この関数は、スムーズなユーザー エクスペリエンスを確保するため、アドオンが呼び出されるたびに呼び出されます。

ContextualTrigger

メールを開いたときに特定の条件を満たした場合にトリガーされるトリガーを定義します。トリガーが起動すると、通常は新しいカードを作成して UI を更新するために、特定のエンドポイントが実行されます。

JSON 表現 
{
  "onTriggerFunction": string,

  // Union field trigger can be only one of the following:
  "unconditional": {
    object (UnconditionalTrigger)
  }
  // End of list of possible types for union field trigger.
}
フィールド
onTriggerFunction

string

必須。メッセージがトリガーと一致したときに呼び出すエンドポイントの名前。
共用体フィールド trigger。トリガーのタイプによって、Gmail がアドオンを表示する条件が決まります。trigger は次のいずれかになります。
unconditional

object (UnconditionalTrigger)

無条件トリガーは、メール メッセージが開かれたときに実行されます。

UnconditionalTrigger

この型にはフィールドがありません。

メール メッセージが開かれたときに起動するトリガー。

UniversalAction

メッセージのコンテキストに関係なく、アドオンのツールバー メニューで常に使用できるアクション。

JSON 表現 
{
  "text": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}
フィールド
text

string

必須。アクションを説明するユーザーに表示されるテキスト（「新しい連絡先を追加」など）。
共用体フィールド action_type。アクションのタイプによって、ユーザーがアクションを呼び出したときの Gmail の動作が決まります。action_type は次のいずれかになります。
runFunction

string

ユーザーがアクションをトリガーしたときに呼び出されるエンドポイント。詳しくは、ユニバーサル アクションのガイドをご覧ください。

ComposeTrigger

ユーザーがメールを作成しているときに有効になるトリガー。

JSON 表現 
{
  "actions": [
    {
      object (MenuItemExtensionPoint)
    }
  ],
  "draftAccess": enum (DraftAccess)
}
フィールド
actions[]

object (MenuItemExtensionPoint)

作成時アドオンのアクションのセットを定義します。これらは、ユーザーが作成時のアドオンでトリガーできるアクションです。
draftAccess

enum (DraftAccess)

作成時のアドオンがトリガーされたときのデータアクセスのレベルを定義します。

DraftAccess

コンポーズ トリガーに必要なデータアクセス レベルを定義する列挙型。

列挙型
UNSPECIFIED draftaccess に何も設定されていない場合のデフォルト値。
NONE 作成アドオンがトリガーされると、作成トリガーは下書きのデータにアクセスできません。
METADATA 作成アドオンがトリガーされたときに、作成トリガーに下書きのメタデータへのアクセス権を付与します。これには、下書きメールの宛先リストや CC リストなどのユーザー リストが含まれます。

DriveAddOnManifest

Google ドライブ アドオンの見た目と実行をカスタマイズするプロパティ。

JSON 表現 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onItemsSelectedTrigger": {
    object (DriveExtensionPoint)
  }
}
フィールド
homepageTrigger

object (HomepageExtensionPoint)

存在する場合は、addons.common.homepageTrigger の構成をオーバーライドします。
onItemsSelectedTrigger

object (DriveExtensionPoint)

マイドライブのドキュメント リストなど、関連するドライブ ビューでアイテムが選択されたときに実行される動作に対応します。

DriveExtensionPoint

Google ドライブ アドオンのトリガーを宣言する一般的な形式。

JSON 表現 
{
  "runFunction": string
}
フィールド
runFunction

string

必須。拡張機能ポイントが有効になったときに実行されるエンドポイント。

CalendarAddOnManifest

カレンダー アドオンの外観と実行をカスタマイズするプロパティ。

JSON 表現 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "createSettingsUrlFunction": string,
  "eventOpenTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventUpdateTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventAttachmentTrigger": {
    object (MenuItemExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}
フィールド
homepageTrigger

object (HomepageExtensionPoint)

宣言されたコンテキスト トリガーと一致しないコンテキストで実行されるエンドポイントを定義します。この関数で生成されたカードは常にユーザーが利用できますが、このアドオンがよりターゲットを絞ったトリガーを宣言すると、コンテキスト コンテンツによって隠される可能性があります。

存在する場合は、addons.common.homepageTrigger の構成をオーバーライドします。
conferenceSolution[]

object (ConferenceSolution)

このアドオンが提供する会議ソリューションを定義します。サードパーティ製会議アドオンは Apps Script でのみ構築できます。
createSettingsUrlFunction

string

アドオンの設定ページへの URL を作成するエンドポイント。
eventOpenTrigger

object (CalendarExtensionPoint)

イベントが開かれて表示または編集されるときにトリガーされるエンドポイント。
eventUpdateTrigger

object (CalendarExtensionPoint)

オープン イベントが更新されたときにトリガーされるエンドポイント。
eventAttachmentTrigger

object (MenuItemExtensionPoint)

ユーザーがカレンダーのドロップダウン メニューでアドオンの添付ファイル プロバイダをクリックしたときに起動するコンテキスト トリガーの構成。
currentEventAccess

enum (EventAccess)

イベント アドオンがトリガーされたときのデータアクセス レベルを定義します。

ConferenceSolution

会議関連の値を定義します。サードパーティ製会議アドオンは Apps Script でのみ構築できます。

JSON 表現 
{
  "onCreateFunction": string,
  "id": string,
  "name": string,
  "logoUrl": string
}
フィールド
onCreateFunction

string

必須。会議データを作成するときに呼び出すエンドポイント。
id

string

必須。ID は 1 つのアドオン内の会議ソリューション全体で一意に割り当てる必要があります。そうしないと、アドオンがトリガーされたときに誤った会議ソリューションが使用される可能性があります。アドオンの表示名は変更できますが、ID は変更しないでください。
name

string

必須。会議ソリューションの表示名。
logoUrl

string

必須。会議ソリューションのロゴ画像の URL。

CalendarExtensionPoint

カレンダー アドオンのトリガーを宣言する一般的な形式。

JSON 表現 
{
  "runFunction": string
}
フィールド
runFunction

string

必須。この拡張ポイントが有効になったときに実行されるエンドポイント。

EventAccess

データアクセス イベント トリガーに必要なレベルを定義する列挙型。

列挙型
UNSPECIFIED eventAccess に何も設定されていない場合のデフォルト値。
METADATA イベント トリガーに、イベントのメタデータ（イベント ID やカレンダー ID など）にアクセスする権限を付与します。
READ イベント トリガーに、メタデータ、参加者、会議データなど、提供されたすべてのイベント フィールドへのアクセス権を付与します。
WRITE イベント トリガーにイベントのメタデータへのアクセス権を付与し、出席者の追加や会議データの設定など、すべてのアクションを実行できるようにします。
READ_WRITE イベント トリガーに、メタデータ、参加者、会議データなど、提供されたすべてのイベント フィールドへのアクセス権と、すべてのアクションを実行する権限を付与します。

DocsAddOnManifest

Google ドキュメント アドオンの外観と実行をカスタマイズするプロパティ。

JSON 表現 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (DocsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ],
  "createActionTriggers": [
    {
      object (CreateActionExtensionPoint)
    }
  ]
}
フィールド
homepageTrigger

object (HomepageExtensionPoint)

存在する場合は、addons.common.homepageTrigger の構成をオーバーライドします。
onFileScopeGrantedTrigger

object (DocsExtensionPoint)

このドキュメントとユーザーのペアに対してファイル スコープの承認が付与されたときに実行するエンドポイント。
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Google ドキュメントのリンクをプレビューするための拡張ポイントのリスト。詳しくは、スマートチップを使用してリンクをプレビューするをご覧ください。
createActionTriggers[]

object (CreateActionExtensionPoint)

Google Workspace アプリケーション内からサードパーティ製リソースを作成するための拡張ポイントのリスト。詳しくは、@ メニューからサードパーティのリソースを作成するをご覧ください。

DocsExtensionPoint

ドキュメント アドオンのトリガーを宣言する一般的な形式。

JSON 表現 
{
  "runFunction": string
}
フィールド
runFunction

string

必須。この拡張ポイントが有効になったときに実行されるエンドポイント。

LinkPreviewExtensionPoint

ユーザーがサードパーティまたは Google 以外のサービスのリンクを Google ドキュメント、スプレッドシート、スライドのファイルに入力または貼り付けたときにトリガーされるトリガーの構成。

JSON 表現 
{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "patterns": [
    {
      object (UriPattern)
    }
  ],
  "runFunction": string,
  "logoUrl": string
}
フィールド
labelText

string

必須。ユーザーにリンクのプレビューを促すスマートチップのテキスト（Example: Support case など）。このテキストは静的で、ユーザーがアドオンを実行する前に表示されます。
localizedLabelText

map (key: string, value: string)

省略可。他の言語にローカライズする labeltext のマップ。言語は ISO 639 形式、国/地域は ISO 3166 形式で指定し、ハイフン - で区切ります。例: en-US。

ユーザーのロケールがマップのキーに存在する場合、ユーザーには labeltext のローカライズされたバージョンが表示されます。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
patterns[]

object (UriPattern)

必須。アドオンがリンクをプレビューするトリガーとなる URL パターンの配列。
runFunction

string

必須。リンク プレビューがトリガーされたときに実行するエンドポイント。
logoUrl

string

省略可。スマートチップとプレビュー カードに表示されるアイコン。省略した場合、アドオンはツールバー アイコン logourl を使用します。

UriPattern

リンク プレビューをトリガーする各 URL パターンの構成。

JSON 表現 
{
  "hostPattern": string,
  "pathPrefix": string
}
フィールド
hostPattern

string

プレビューする各 URL パターンに必要です。URL パターンのドメイン。アドオンは、URL にこのドメインが含まれているリンクをプレビューします。subdomain.example.com などの特定のサブドメインのリンクをプレビューするには、サブドメインを含めます。ドメイン全体のリンクをプレビューするには、サブドメインとしてアスタリスク（*）を含むワイルドカード文字を指定します。

たとえば、*.example.com は subdomain.example.com および another.subdomain.example.com と一致します。
pathPrefix

string

省略可。hostpattern のドメインを追加するパス。

たとえば、URL ホスト パターンが support.example.com で、support.example.com/cases/ でホストされているケースの URL を照合するには、cases と入力します。

ホストパターンのドメイン内のすべての URL を照合するには、pathprefix を空白のままにします。

CreateActionExtensionPoint

ユーザーが Google Workspace アプリケーションでリソース作成ワークフローを呼び出したときにトリガーされるトリガーの構成。詳しくは、@ メニューからサードパーティのリソースを作成するをご覧ください。

JSON 表現 
{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string
}
フィールド
id

string

必須。この拡張ポイントを区別するための一意の ID。ID は 64 文字以内で、[a-zA-Z0-9-]+ の形式にする必要があります。
labelText

string

必須。リソース作成エントリ ポイントのアイコン（Create support case など）の横に表示されるテキスト。このテキストは静的で、ユーザーがアドオンを実行する前に表示されます。
localizedLabelText

map (key: string, value: string)

省略可。他の言語にローカライズする labeltext のマップ。言語は ISO 639 形式、国/地域は ISO 3166 形式で指定し、ハイフン - で区切ります。例: en-US。

ユーザーのロケールがマップのキーに存在する場合、ユーザーには labeltext のローカライズされたバージョンが表示されます。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
runFunction

string

必須。リソース作成ワークフローがトリガーされてリンクが作成されるときに実行されるエンドポイント。
logoUrl

string

省略可。リソース作成のエントリ ポイントに表示されるアイコン。省略した場合、メニューにはアドオンのツールバー アイコン logourl が使用されます。

MeetAddOnManifest

Meet アドオンのマニフェスト。

JSON 表現 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "web": {
    object (Web)
  },
  "supportsCollaboration": boolean,
  "termsUri": string
}
フィールド
homepageTrigger

object (HomepageExtensionPoint)

存在する場合は、addons.common.homepageTrigger の構成をオーバーライドします。
web

object (Web)

Meet ウェブ クライアントを強化するアドオンの詳細。
supportsCollaboration

boolean

アドオンがコラボレーションや他のユーザーをアドオン エクスペリエンスに招待することをサポートしているかどうか。
termsUri

string

アドオンの利用規約へのリンク（表示する必要がある場合）。

ウェブ

Meet ウェブ クライアントを強化するアドオンの詳細。

JSON 表現 
{
  "sidePanelUri": string,
  "sidePanelUrl": string,
  "mainStageUri": string,
  "supportsScreenSharing": boolean,
  "supportsCollaboration": boolean,
  "supportsPopOut": boolean,
  "hostOrigins": [
    string
  ],
  "addOnOrigins": [
    string
  ],
  "openState": enum (State),
  "supportsCollaborationHostControls": boolean,
  "logoUrl": string,
  "darkModeLogoUrl": string,
  "displayFlow": enum (DisplayFlow)
}
フィールド
sidePanelUri
(deprecated)

string

サイドパネルの iframe の URI。
sidePanelUrl

string

サイドパネルの iframe の URL。
mainStageUri
(deprecated)

string

「メインステージ」iframe の URI。
supportsScreenSharing

boolean

アドオンがメインステージの画面共有をサポートしているかどうか。
supportsCollaboration
(deprecated)

boolean

アドオンがコラボレーションや他のユーザーをアドオン エクスペリエンスに招待することをサポートしているかどうか。このフィールドは非推奨になりました。MeetAddOnManifest のトップレベル フィールドを使用してください。
supportsPopOut

boolean

アドオンがブラウザの PIP エクスペリエンスへのポップアウトをサポートしているかどうか。
hostOrigins[]
(deprecated)

string

非推奨のレガシー名。サードパーティ サイトを含む iframe の frame-src プロパティに追加する必要があるオリジン。代わりに addonorigins を使用してください。
addOnOrigins[]

string

サードパーティ サイトを含む iframe の frame-src プロパティに追加する必要があるオリジン。
openState

enum (State)

アドオンを開いたときの初期状態。
supportsCollaborationHostControls

boolean

コラボレーション アドオンが主催者用ボタンをサポートしているかどうか。
logoUrl

string

アドオンに表示されるロゴの URL。指定しない場合、ロゴはマニフェストの共通セクションのロゴがデフォルトになります。
darkModeLogoUrl

string

logourl のダークモード バージョン。
displayFlow
(deprecated)

enum (DisplayFlow)

アドオンが起動されたときに従う表示フロー。

州

アドオンの初期の開閉状態を指定する列挙型。

列挙型
STATE_UNSPECIFIED アドオンで初期状態が指定されていません。
SIDE_PANEL_ONLY アドオンが開き、サイドパネルのみがアクティブになります。
MAIN_STAGE_ONLY アドオンはメインステージのみがアクティブな状態で開きます。
SIDE_PANEL_AND_MAIN_STAGE アドオンが開き、サイドパネルとメインステージの両方がアクティブになります。

DisplayFlow

アドオンの起動時にアドオンが従う表示フローを指定する列挙型

列挙型
DISPLAY_FLOW_UNSPECIFIED 表示フローが指定されていません。
FOCUS アドオンは「フォーカス」ディスプレイ フローで起動する必要があります。
AUGMENT アドオンは「拡張」ディスプレイ フローで起動する必要があります。

SheetsAddOnManifest

Google スプレッドシート アドオンの見た目と実行をカスタマイズするプロパティ。

JSON 表現 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SheetsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
フィールド
homepageTrigger

object (HomepageExtensionPoint)

存在する場合は、addons.common.homepageTrigger の構成をオーバーライドします。
onFileScopeGrantedTrigger

object (SheetsExtensionPoint)

このドキュメントとユーザーのペアに対してファイル スコープの承認が付与されたときに実行するエンドポイント。
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Google スプレッドシート ドキュメント内のリンクをプレビューするための拡張ポイントのリスト。詳しくは、スマートチップを使用してリンクをプレビューするをご覧ください。

SheetsExtensionPoint

スプレッドシート アドオンのトリガーを宣言する一般的な形式。

JSON 表現 
{
  "runFunction": string
}
フィールド
runFunction

string

必須。この拡張ポイントが有効になったときに実行されるエンドポイント。

SlidesAddOnManifest

Google スライド アドオンの外観と実行をカスタマイズするプロパティ。

JSON 表現 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SlidesExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
フィールド
homepageTrigger

object (HomepageExtensionPoint)

存在する場合は、addons.common.homepageTrigger の構成をオーバーライドします。
onFileScopeGrantedTrigger

object (SlidesExtensionPoint)

このドキュメントとユーザーのペアに対してファイル スコープの承認が付与されたときに実行するエンドポイント。
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Google スライド ドキュメントでリンクをプレビューするための拡張ポイントのリスト。詳しくは、スマートチップを使用してリンクをプレビューするをご覧ください。

SlidesExtensionPoint

スライド アドオンのトリガーを宣言する一般的な形式。

JSON 表現 
{
  "runFunction": string
}
フィールド
runFunction

string

必須。この拡張ポイントが有効になったときに実行されるエンドポイント。

HttpOptions

アドオンの HTTP エンドポイントにリクエストを送信するためのオプション。

JSON 表現 
{
  "authorizationHeader": enum (HttpAuthorizationHeader),
  "granularOauthPermissionSupport": enum (GranularOauthPermissionSupport)
}
フィールド
authorizationHeader

enum (HttpAuthorizationHeader)

HTTP Authorization ヘッダーで送信されるトークンの構成。
granularOauthPermissionSupport

enum (GranularOauthPermissionSupport)

アドオンで Granular OAuth Consent が有効になっているかどうか。

HttpAuthorizationHeader

アドオンの HTTP リクエストで送信される Authorization ヘッダー。

列挙型
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED デフォルト値。SYSTEM_ID_TOKEN と同等。
SYSTEM_ID_TOKEN プロジェクト固有の Google Workspace アドオンのシステム サービス アカウントの ID トークンを送信します（デフォルト）。
USER_ID_TOKEN エンドユーザーの ID トークンを送信します。
NONE Authentication ヘッダーを送信しないでください。

GranularOauthPermissionSupport

アドオンで Granular OAuth Consent が有効になっているかどうか。

列挙型
GRANULAR_OAUTH_PERMISSION_SUPPORT_UNSPECIFIED デフォルト値。使用しないでください。
OPT_IN アドオンで、きめ細かい OAuth の同意が有効になっている。
OPT_OUT アドオンが、きめ細かい OAuth の同意からオプトアウトされている。

メソッド

create

 指定された名前と構成でデプロイを作成します。

delete

 指定された名前のデプロイを削除します。

get

 指定された名前のデプロイを取得します。

getInstallStatus

 テスト デプロイのインストール ステータスを取得します。

install

 テスト用にアカウントにデプロイメントをインストールします。

list

 特定のプロジェクト内のすべてのデプロイを一覧表示します。

replaceDeployment

 指定した名前のデプロイを作成または置き換えます。

uninstall

 ユーザーのアカウントからテスト デプロイをアンインストールします。