AddOns マニフェスト リソース

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

アドオン

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 を拡張する場合は必須。Google Workspace アドオンの外観と Gmail ホスト アプリケーション内の動作。このフィールドを省略した場合、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 です。

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

レイアウト プロパティ

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

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

string

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

string

ボタンのデフォルトの色。デフォルトはメインカラーに設定されます（設定されていない場合）。デフォルトは青（#2196F3）。

ユニバーサル アクション

ユニバーサル アクションの構成。ユニバーサル アクションを選択すると、指定された 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 関数の名前。

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