AddOns マニフェスト リソース

Google Workspace アドオンのコンテンツと動作の定義に使用されるリソース構成。Google Workspace アドオン マニフェストでは、すべてのコンポーネントが必須とマークされている必要があります。

AddOns

Google Workspace アドオン マニフェスト構成の最上位。

JSON 表現
{
  "common": {
    object (Common)
  },
  "calendar": {
    object (Calendar)
  },
  "drive": {
    object (Drive)
  },
  "gmail": {
    object (Gmail)
  },
  "docs": {
    object (Docs)
  },
  "sheets": {
    object (Sheets)
  },
  "slides": {
    object (Slides)
  }
}
フィールド
common

object (Common)

必須: すべてのホストアプリケーションに共通する Google Workspace アドオンの値を定義します。ここで定義した一部の値は、特定のホストの特定の値が省略された場合のデフォルトとして使用されます。

calendar

object (Calendar)

Google Workspace アドオンがカレンダーを拡張する場合は必須。 Google カレンダー ホストアプリケーション内での Google Workspace アドオンの外観と動作の構成。このフィールドを省略すると、Google カレンダーでアドオンが無効になります。

drive

object (Drive)

Google Workspace アドオンが Google ドライブを拡張する場合は必須。 Google ドライブ ホストアプリケーション内での Google Workspace アドオンの外観と動作の構成。このフィールドを省略すると、Google ドライブでアドオンは無効になります。

gmail

object (Gmail)

Google Workspace アドオンが Gmail を拡張する場合は必須。 Gmail ホストアプリケーション内での Google Workspace アドオンの外観と動作の構成。このフィールドを省略すると、Gmail でアドオンは無効になります。

docs

object (Docs)

Google Workspace アドオンがドキュメントを拡張する場合は必須。 ドキュメント ホスト アプリケーション内での Google Workspace アドオンの外観と動作の構成。このフィールドを省略すると、Google ドキュメントでアドオンが無効になります。

sheets

object (Sheets)

Google Workspace アドオンがスプレッドシートを拡張する場合は必須。 スプレッドシート ホストアプリケーション内での Google Workspace アドオンの外観と動作の構成。このフィールドを省略すると、スプレッドシートでアドオンが無効になります。

slides

object (Slides)

Google Workspace アドオンがスライドを拡張する場合は必須。 スライド ホストアプリ内での Google Workspace アドオンの外観と動作の構成。このフィールドを省略すると、スライドでアドオンが無効になります。

一般的な

すべてのホストアプリケーションに共通するパラメータのマニフェスト構成。ここで定義した一部の値は、特定のホストの特定の値が省略された場合のデフォルトとして使用されます。

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

object (HomepageTrigger)

アドオンのホームページを作成するためのデフォルトのトリガー関数の仕様。この仕様は、ホスト固有のホームページ トリガーが定義されていない場合に使用されます。これも省略すると、必要に応じて汎用のホームページ カードが作成されて使用されます。
layoutProperties

object (LayoutProperties)

アドオンのツールバーとボタンで使用される色の構成。
logoUrl

string

必須: ツールバーに表示される画像の URL。URL が公開されていること。

name

string

必須: ツールバーに表示されるアドオンの名前。

openLinkUrlPrefixes[]

string

OpenLink を使用するウィジェット内か、HTML アンカータグを使用するテキスト ウィジェット内であるかにかかわらず、アドオンがアウトバウンド リンクを表示する場合は必須。HTTPS URL プレフィックスのリスト。ユーザーデータを保護するため、アドオンによってレンダリングされるリンクは、このリストのいずれかの接頭辞と一致する必要があります。

詳しくは、 URL を許可リストに登録するをご覧ください。

universalActions[]

object (UniversalAction)

アドオン UI で常に使用できるユニバーサル アクションのリスト。
useLocaleFromApp

boolean

true の場合、 アクション コールバック関数またはトリガー関数に渡されるアドオンの イベント オブジェクトに、ユーザーのロケールとタイムゾーン情報が含まれます。デフォルトは false です。

詳しくは、 ユーザーの言語 / 地域とタイムゾーンへのアクセスをご覧ください。

LayoutProperties

アドオンのツールバー、ボタンの色と外観を制御する構成。 Google Workspace

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

string

ツールバーの色。デフォルトはグレーです(#424242)。
secondaryColor

string

ボタンのデフォルトの色。デフォルトはプライマリ カラー(設定されている場合)で、それ以外の場合は青になります(#2196F3)。

UniversalAction

ユニバーサル アクションの構成。選択すると、ユニバーサル アクションにより、指定された URL リンクが開かれるか、指定された Apps Script 関数が実行されます。

JSON 表現
{
  "label": string,

  // Union field rule can be only one of the following:
  "openLink": string,
  "runFunction": string,
  // End of list of possible types for union field rule.

}
フィールド
label

string

すべてのユニバーサル アクションで必須。このアクションの UI メニューに表示されるテキスト。
runFunction

string

openLink が存在しない場合は、すべてのユニバーサル アクションで必須です。指定されている場合、ユーザーがこのアクションを選択したときに実行される Apps Script 関数の名前。

詳細については、 ユニバーサル アクションのガイドをご覧ください。