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 を拡張する場合に必須です。 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。

name

string

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

openLinkUrlPrefixes[]

string

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

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

universalActions[]

object (UniversalAction)

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

boolean

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

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

LayoutProperties

アドオン ツールバーとボタンの色と外観を制御する設定。 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 関数の名前。

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