REST Resource: projects.deployments

{
  "name": string,
  "oauthScopes": [
    string
  ],
  "addOns": {
    object (AddOns)
  },
  "etag": string
}

string

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

string

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

object (AddOns)

Google Workspace アドオンの構成。

string

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

{
  "common": {
    object (CommonAddOnManifest)
  },
  "gmail": {
    object (GmailAddOnManifest)
  },
  "drive": {
    object (DriveAddOnManifest)
  },
  "calendar": {
    object (CalendarAddOnManifest)
  },
  "docs": {
    object (DocsAddOnManifest)
  },
  "sheets": {
    object (SheetsAddOnManifest)
  },
  "slides": {
    object (SlidesAddOnManifest)
  },
  "httpOptions": {
    object (HttpOptions)
  }
}

object (CommonAddOnManifest)

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

object (GmailAddOnManifest)

Gmail アドオンの構成。

object (DriveAddOnManifest)

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

object (CalendarAddOnManifest)

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

object (DocsAddOnManifest)

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

object (SheetsAddOnManifest)

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

object (SlidesAddOnManifest)

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

object (HttpOptions)

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

{
  "name": string,
  "logoUrl": string,
  "layoutProperties": {
    object (LayoutProperties)
  },
  "addOnWidgetSet": {
    object (AddOnWidgetSet)
  },
  "useLocaleFromApp": boolean,
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "universalActions": [
    {
      object (UniversalActionExtensionPoint)
    }
  ],
  "openLinkUrlPrefixes": array
}

string

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

string

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

object (LayoutProperties)

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

object (AddOnWidgetSet)

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

boolean

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

object (HomepageExtensionPoint)

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

object (UniversalActionExtensionPoint)

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

array (ListValue format)

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

{
  "primaryColor": string,
  "secondaryColor": string,
  "useNewMaterialDesign": boolean
}

string

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

string

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

boolean

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

{
  "usedWidgets": [
    enum (WidgetType)
  ]
}

enum (WidgetType)

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

{
  "runFunction": string,
  "enabled": boolean
}

string

必須。この拡張ポイントがアクティブになったときに実行されるエンドポイント。

boolean

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

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

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

{
  "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.
}

string

必須。この拡張ポイントを有効にしたことで行われる操作を説明する、ユーザーに表示されるテキスト（「新しい連絡先を追加してください」など）。

string

UniversalAction によって開かれる URL。

string

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

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "authorizationCheckFunction": string
}

object (HomepageExtensionPoint)

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

存在する場合、addons.common.homepageTrigger の構成がオーバーライドされます。

object (ContextualTrigger)

アドオンをトリガーする一連の条件を定義します。

object (UniversalAction)

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

object (ComposeTrigger)

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

string

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

{
  "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.
}

string

必須。メッセージがトリガーに一致したときに呼び出すエンドポイントの名前。

object (UnconditionalTrigger)

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

{
  "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.
}

string

必須。操作を説明するユーザーに表示されるテキスト（「新しい連絡先の追加」など）。

string

ユーザーがアクションをトリガーしたときに Gmail が開くリンク。

string

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

{
  "actions": [
    {
      object (MenuItemExtensionPoint)
    }
  ],
  "draftAccess": enum (DraftAccess)
}

object (MenuItemExtensionPoint)

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

enum (DraftAccess)

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

{
  "runFunction": string,
  "label": string,
  "logoUrl": string
}

string

必須。この拡張ポイントがアクティブになったときに実行されるエンドポイント。

string

必須。この拡張ポイントを有効にしたことで行われる操作を説明する、ユーザーに表示されるテキスト。（例: 「請求書を挿入」）。

string

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

設定されていない場合、アドオンのメインロゴの URL がデフォルトになります。

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onItemsSelectedTrigger": {
    object (DriveExtensionPoint)
  }
}

object (HomepageExtensionPoint)

存在する場合、addons.common.homepageTrigger の構成がオーバーライドされます。

object (DriveExtensionPoint)

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

{
  "runFunction": string
}

string

必須。拡張ポイントがアクティブになったときに実行されるエンドポイント。

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "createSettingsUrlFunction": string,
  "eventOpenTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventUpdateTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventAttachmentTrigger": {
    object (MenuItemExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}

object (HomepageExtensionPoint)

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

存在する場合、addons.common.homepageTrigger の構成がオーバーライドされます。

object (ConferenceSolution)

このアドオンが提供する会議ソリューションを定義します。

string

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

object (CalendarExtensionPoint)

閲覧または編集するためにイベントが開かれたときにトリガーされるエンドポイント。

object (CalendarExtensionPoint)

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

object (MenuItemExtensionPoint)

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

enum (EventAccess)

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

{
  "onCreateFunction": string,
  "id": string,
  "name": string,
  "logoUrl": string
}

string

必須。会議データの作成時に呼び出すエンドポイント。

string

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

string

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

string

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

{
  "runFunction": string
}

string

必須。この拡張ポイントがアクティブになったときに実行されるエンドポイント。

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (DocsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ],
  "createActionTriggers": [
    {
      object (CreateActionExtensionPoint)
    }
  ]
}

object (HomepageExtensionPoint)

存在する場合、addons.common.homepageTrigger の構成がオーバーライドされます。

object (DocsExtensionPoint)

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

object (LinkPreviewExtensionPoint)

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

object (CreateActionExtensionPoint)

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

{
  "runFunction": string
}

string

必須。この拡張ポイントがアクティブになったときに実行されるエンドポイント。

{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "patterns": [
    {
      object (UriPattern)
    }
  ],
  "runFunction": string,
  "logoUrl": string
}

string

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

map (key: string, value: string)

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

ユーザーの言語 / 地域が地図のキーに含まれている場合、ユーザーには labeltext のローカライズ版が表示されます。

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

object (UriPattern)

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

string

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

string

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

{
  "hostPattern": string,
  "pathPrefix": string
}

string

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

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

string

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

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

ホストパターン ドメイン内のすべての URL を一致させるには、pathprefix を空のままにします。

{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string
}

string

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

string

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

map (key: string, value: string)

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

ユーザーの言語 / 地域が地図のキーに含まれている場合、ユーザーには labeltext のローカライズ版が表示されます。

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

string

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

string

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

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SheetsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}

object (HomepageExtensionPoint)

存在する場合、addons.common.homepageTrigger の構成がオーバーライドされます。

object (SheetsExtensionPoint)

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

object (LinkPreviewExtensionPoint)

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

{
  "runFunction": string
}

string

必須。この拡張ポイントがアクティブになったときに実行されるエンドポイント。

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SlidesExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}

object (HomepageExtensionPoint)

存在する場合、addons.common.homepageTrigger の構成がオーバーライドされます。

object (SlidesExtensionPoint)

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

object (LinkPreviewExtensionPoint)

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

{
  "runFunction": string
}

string

必須。この拡張ポイントがアクティブになったときに実行されるエンドポイント。

{
  "authorizationHeader": enum (HttpAuthorizationHeader)
}

enum (HttpAuthorizationHeader)

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