AddOns マニフェスト リソース

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

AddOns

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

JSON 表現 
{
  "common": {
    object (Common)
  },
  "calendar": {
    object (Calendar)
  },
  "chat": {
    object (Chat)
  },
  "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 カレンダーでアドオンが無効になります。
chat

object ()

Google Workspace アドオンが Chat を拡張する場合に必須。 Google Chat アプリの構成。このフィールドを省略すると、Google Chat でアドオンが無効になります。

addOns.chat オブジェクトは空にする必要があります。Chat でアドオンの動作と外観を構成するには、Chat アプリを構成するをご覧ください。
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 アドオンのドキュメント ホスト アプリケーション内での外観と動作の設定。このフィールドを省略すると、アドオンはドキュメントで無効になります。
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 関数の名前。

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