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

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

詳細については、 許可リストの URL をご覧ください。

universalActions[]

object (UniversalAction)

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

boolean

`true` の場合、アクション コールバック関数またはトリガー関数に渡されるアドオン イベント オブジェクトには、ユーザーのロケールとタイムゾーンが含まれます。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 関数の名前。

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