AddOns マニフェスト リソース

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)
  },
  "meet": {
    object (Meet)
  }
}
フィールド
common

object (Common)

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

object (Calendar)

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

object ()

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

addOns.chat オブジェクトは空である必要があります。Chat でのアドオンの動作と外観を構成するには、Google Chat 用アプリを構成するをご覧ください。
drive

object (Drive)

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

object (Gmail)

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

object (Docs)

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

object (Sheets)

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

object (Slides)

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

object (Meet)

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

共通

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

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。
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 関数の名前。

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