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,

  "openLink": string,
  "runFunction": string
}
フィールド
label

string

必須。この拡張ポイントを有効にすることで実行されるアクションを説明する、ユーザーに表示されるテキスト（例: 「新しい連絡先を追加」）。
必須。ユニバーサル操作メニュー項目でサポートされているアクション タイプ。開くリンクまたは実行するエンドポイントのいずれかです。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
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,

  "unconditional": {
    object (UnconditionalTrigger)
  }
}
フィールド
onTriggerFunction

string

必須。メッセージがトリガーと一致したときに呼び出すエンドポイントの名前。
トリガーのタイプによって、Gmail がアドオンを表示する条件が決まります。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
unconditional

object (UnconditionalTrigger)

無条件トリガーは、メール メッセージが開かれたときに実行されます。
相互に排他的なフィールドの終了。

UnconditionalTrigger

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

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

UniversalAction

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

JSON 表現 
{
  "text": string,

  "openLink": string,
  "runFunction": string
}
フィールド
text

string

必須。アクションを説明するユーザーに表示されるテキスト（「新しい連絡先を追加」など）。
アクションのタイプによって、ユーザーがアクションを呼び出したときの Gmail の動作が決まります。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
runFunction

string

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

ComposeTrigger

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

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

object (MenuItemExtensionPoint)

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

enum (DraftAccess)

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

DraftAccess

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

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

DriveAddOnManifest

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

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

object (HomepageExtensionPoint)

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

object (DriveExtensionPoint)

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

DriveExtensionPoint

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

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

string

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

CalendarAddOnManifest

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

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

object (HomepageExtensionPoint)

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

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

object (ConferenceSolution)

省略可。このアドオンによって提供される会議ソリューションを定義します。
createSettingsUrlFunction

string

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

object (CalendarExtensionPoint)

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

object (CalendarExtensionPoint)

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

object (CalendarExtensionPoint)

省略可。ユーザーが登録しているカレンダーで予定が作成または更新されたときにトリガーされます。CalendarSubscriptionActionMarkup を使用して HTTP endpoints によって作成されたトリガーにのみ適用されます。

再帰的な通知ループを防ぐため、アドオンがアドオンのデプロイをホストする同じ Google Cloud プロジェクトの認証情報を使用して Calendar API で Google カレンダーの予定を変更すると、プラットフォームは変更通知を抑制します。独自のプロジェクトの Calendar API 呼び出しをセルフ トリガーすることはサポートされていません。

Apps Script add-ons と Apps Script installable triggers には適用されません。
eventAttachmentTrigger

object (MenuItemExtensionPoint)

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

enum (EventAccess)

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

ConferenceSolution

会議関連の値を定義します。

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

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

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

アドオンがブラウザのピクチャー イン ピクチャー機能へのポップアウトをサポートしているかどうか。
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

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

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

string

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

HttpOptions

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

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

enum (HttpAuthorizationHeader)

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

enum (GranularOauthPermissionSupport)

アドオンできめ細かい OAuth の同意が有効になっているかどうか。

HttpAuthorizationHeader

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

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

GranularOauthPermissionSupport

アドオンできめ細かい OAuth の同意が有効になっているかどうか。

列挙型
GRANULAR_OAUTH_PERMISSION_SUPPORT_UNSPECIFIED デフォルト値。使用しないでください。
OPT_IN アドオンが詳細な OAuth の同意を有効にしている。
OPT_OUT アドオンで詳細な OAuth 同意が無効になっている。

メソッド

create

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

delete

 指定された名前の Deployment を削除します。

get

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

getInstallStatus

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

install

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

list

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

replaceDeployment

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

uninstall

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