アドオンは、マニフェスト ファイルを使用して、アプリとそのオペレーションに関する特定の詳細を構成します。
このドキュメントでは、Google Workspace アドオンのマニフェストの構成について詳しく説明します。
Google Workspace アドオンのマニフェストの構造
Google Workspace アドオンでは、マニフェスト ファイルを使用してアドオンの外観と動作に関するいくつかの要素を定義します。
Google Workspace アドオンのマニフェスト プロパティは、マニフェスト オブジェクト構造の addOns セクションに整理されています。
- Apps Script マニフェスト ファイルの詳細については、マニフェストの構造をご覧ください。
- HTTP エンドポイントを使用してビルドされたアドオンのマニフェスト ファイルについては、REST リソース:
projects.deploymentsをご覧ください。
Google Workspace アドオン マニフェストの構成例
次のマニフェスト サンプルは、Google Workspace アドオンを定義するマニフェスト ファイルのセクションを示しています。これには次の側面が含まれています。
- マニフェストの
addOns.commonセクションでは、アドオンの名前、ロゴの URL、色、その他のホストに依存しない一般的な設定を定義します。 - このマニフェストでは、共通のホームページを定義しますが、カレンダー、ドライブ、ドキュメント、スプレッドシート、スライド固有のホームページも定義します。Gmail ではデフォルトのホームページが使用されます。
- マニフェスト設定のサンプルでは、次のことができます。
- カレンダーの
eventOpenトリガーとeventUpdatedトリガー。 - （Apps Script のみ）2 つのカレンダーの会議ソリューション。
- 2 つの普遍的なアクションがあります。
- ドライブの
onItemsSelectedTrigger。 - Gmail の作成操作とコンテキスト トリガー。
- ドキュメント
linkPreviewTriggersオブジェクト。このトリガーの詳細については、スマートチップを使用してリンクをプレビューするをご覧ください。 - ドキュメントの
createActionTriggersオブジェクト。このトリガーの詳細については、@ メニューからサードパーティのリソースを作成するをご覧ください。 - ドキュメント、スプレッドシート、スライドのファイル固有のインターフェースです。
- カレンダーの
oauthScopesフィールドには、プロジェクトの認証スコープが設定されます（通常、アドオンに必要です）。- （Apps Script のみ）
urlFetchWhitelistフィールドは、取得されたエンドポイントが、指定された HTTPS URL プレフィックスのリストと一致することを確認するフィールドです。詳細については、URL を許可リストに登録するをご覧ください。
サンプル内のリンクは、Apps Script と HTTP Google Workspace アドオンの対応するマニフェスト リファレンス ドキュメントにあるフィールドの説明へのリンクです。
Apps Script
{
"addOns": {
"calendar": {
"createSettingsUrlFunction": "getConferenceSettingsPageUrl",
"conferenceSolution": [{
"id": "my-video-conf",
"logoUrl": "https://lh3.googleusercontent.com/...",
"name": "My Video Conference",
"onCreateFunction": "onCreateMyVideoConference"
}, {
"id": "my-streamed-conf",
"logoUrl": "https://lh3.googleusercontent.com/...",
"name": "My Streamed Conference",
"onCreateFunction": "onCreateMyStreamedConference"
}],
"currentEventAccess": "READ_WRITE",
"eventOpenTrigger": {
"runFunction": "onCalendarEventOpen"
},
"eventUpdateTrigger": {
"runFunction": "onCalendarEventUpdate"
},
"eventAttachmentTrigger": {
"label": "My Event Attachment",
"runFunction": "onCalendarEventAddAttachment"
},
"homepageTrigger": {
"runFunction": "onCalendarHomePageOpen",
"enabled": true
}
},
"common": {
"homepageTrigger": {
"runFunction": "onDefaultHomePageOpen",
"enabled": true
},
"layoutProperties": {
"primaryColor": "#ff392b",
"secondaryColor": "#d68617"
},
"logoUrl": "https://ssl.gstatic.com/docs/script/images/logo/script-64.png",
"name": "Demo Google Workspace Add-on",
"openLinkUrlPrefixes": [
"https://mail.google.com/",
"https://script.google.com/a/google.com/d/",
"https://drive.google.com/a/google.com/file/d/",
"https://www.example.com/"
],
"universalActions": [{
"label": "Open settings",
"runFunction": "getSettingsCard"
}, {
"label": "Open Help URL",
"openLink": "https://www.example.com/help"
}],
"useLocaleFromApp": true
},
"drive": {
"homepageTrigger": {
"runFunction": "onDriveHomePageOpen",
"enabled": true
},
"onItemsSelectedTrigger": {
"runFunction": "onDriveItemsSelected"
}
},
"gmail": {
"composeTrigger": {
"selectActions": [
{
"text": "Add images to email",
"runFunction": "getInsertImageComposeCards"
}
],
"draftAccess": "METADATA"
},
"contextualTriggers": [
{
"unconditional": {},
"onTriggerFunction": "onGmailMessageOpen"
}
]
},
"docs": {
"homepageTrigger": {
"runFunction": "onEditorsHomepage"
},
"onFileScopeGrantedTrigger": {
"runFunction": "onFileScopeGrantedEditors"
},
"linkPreviewTriggers": [
{
"runFunction": "onLinkPreview",
"patterns": [
{
"hostPattern": "example.com",
"pathPrefix": "example-path"
}
],
"labelText": "Link preview",
"localizedLabelText": {
"es": "Link preview localized in Spanish"
},
"logoUrl": "https://www.example.com/images/smart-chip-icon.png"
}
],
"createActionTriggers": [
{
"id": "exampleId",
"labelText": "Example label text",
"localizedLabelText": {
"es": "Label text localized in Spanish"
},
"runFunction": "exampleFunction",
"logoUrl": "https://www.example.com/images/case.png"
}
]
},
"sheets": {
"homepageTrigger": {
"runFunction": "onEditorsHomepage"
},
"onFileScopeGrantedTrigger": {
"runFunction": "onFileScopeGrantedEditors"
}
},
"slides": {
"homepageTrigger": {
"runFunction": "onEditorsHomepage"
},
"onFileScopeGrantedTrigger": {
"runFunction": "onFileScopeGrantedEditors"
}
}
},
"oauthScopes": [
"https://www.googleapis.com/auth/calendar.addons.execute",
"https://www.googleapis.com/auth/calendar.addons.current.event.read",
"https://www.googleapis.com/auth/calendar.addons.current.event.write",
"https://www.googleapis.com/auth/drive.addons.metadata.readonly",
"https://www.googleapis.com/auth/gmail.addons.current.action.compose",
"https://www.googleapis.com/auth/gmail.addons.current.message.metadata",
"https://www.googleapis.com/auth/userinfo.email",
"https://www.googleapis.com/auth/script.external_request",
"https://www.googleapis.com/auth/script.locale",
"https://www.googleapis.com/auth/script.scriptapp",
"https://www.googleapis.com/auth/drive.file",
"https://www.googleapis.com/auth/documents.currentonly",
"https://www.googleapis.com/auth/spreadsheets.currentonly",
"https://www.googleapis.com/auth/presentations.currentonly",
"https://www.googleapis.com/auth/workspace.linkpreview"
],
"urlFetchWhitelist": [
"https://www.example.com/myendpoint/"
]
}
HTTP
{
"addOns": {
"calendar": {
"currentEventAccess": "READ_WRITE",
"eventOpenTrigger": {
"runFunction": "https://myownpersonaldomain.com/mypage?trigger=onCalendarEventOpen"
},
"eventUpdateTrigger": {
"runFunction": "https://myownpersonaldomain.com/mypage?trigger=onCalendarEventUpdate"
},
"eventAttachmentTrigger": {
"label": "My Event Attachment",
"runFunction": "https://myownpersonaldomain.com/mypage?trigger=onCalendarEventAddAttachment"
},
"homepageTrigger": {
"runFunction": "https://myownpersonaldomain.com/mypage?trigger=onCalendarHomePageOpen",
"enabled": true
}
},
"common": {
"homepageTrigger": {
"runFunction": "https://myownpersonaldomain.com/mypage?trigger=onDefaultHomePageOpen",
"enabled": true
},
"layoutProperties": {
"primaryColor": "#ff392b",
"secondaryColor": "#d68617"
},
"logoUrl": "https://ssl.gstatic.com/docs/script/images/logo/script-64.png",
"name": "Demo Google Workspace Add-on",
"openLinkUrlPrefixes": [
"https://mail.google.com/",
"https://script.google.com/a/google.com/d/",
"https://drive.google.com/a/google.com/file/d/",
"https://www.example.com/"
],
"universalActions": [{
"label": "Open settings",
"runFunction": "https://myownpersonaldomain.com/mypage?trigger=getSettingsCard"
}, {
"label": "Open Help URL",
"openLink": "https://www.example.com/help"
}],
"useLocaleFromApp": true
},
"drive": {
"homepageTrigger": {
"runFunction": "https://myownpersonaldomain.com/mypage?trigger=onDriveHomePageOpen",
"enabled": true
},
"onItemsSelectedTrigger": {
"runFunction": "https://myownpersonaldomain.com/mypage?trigger=onDriveItemsSelected"
}
},
"gmail": {
"composeTrigger": {
"actions": [
{
"label": "Add images to email",
"runFunction": "https://myownpersonaldomain.com/mypage?trigger=getInsertImageComposeCards"
}
],
"draftAccess": "METADATA"
},
"contextualTriggers": [
{
"unconditional": {},
"onTriggerFunction": "https://myownpersonaldomain.com/mypage?trigger=onGmailMessageOpen"
}
]
},
"docs": {
"homepageTrigger": {
"runFunction": "https://myownpersonaldomain.com/mypage?trigger=onEditorsHomepage"
},
"onFileScopeGrantedTrigger": {
"runFunction": "https://myownpersonaldomain.com/mypage?trigger=onFileScopeGrantedEditors"
},
"linkPreviewTriggers": [
{
"runFunction": "https://myownpersonaldomain.com/mypage?trigger=onLinkPreview",
"patterns": [
{
"hostPattern": "example.com",
"pathPrefix": "example-path"
}
],
"labelText": "Link preview",
"localizedLabelText": {
"es": "Link preview localized in Spanish"
},
"logoUrl": "https://www.example.com/images/smart-chip-icon.png"
}
],
"createActionTriggers": [
{
"id": "exampleId",
"labelText": "Example label text",
"localizedLabelText": {
"es": "Label text localized in Spanish"
},
"runFunction": "https://myownpersonaldomain.com/mypage?trigger=onCreateAction",
"logoUrl": "https://www.example.com/images/case.png"
}
]
},
"sheets": {
"homepageTrigger": {
"runFunction": "https://myownpersonaldomain.com/mypage?trigger=onEditorsHomepage"
},
"onFileScopeGrantedTrigger": {
"runFunction": "https://myownpersonaldomain.com/mypage?trigger=onFileScopeGrantedEditors"
}
},
"slides": {
"homepageTrigger": {
"runFunction": "https://myownpersonaldomain.com/mypage?trigger=onEditorsHomepage"
},
"onFileScopeGrantedTrigger": {
"runFunction": "https://myownpersonaldomain.com/mypage?trigger=onFileScopeGrantedEditors"
}
}
},
"oauthScopes": [
"https://www.googleapis.com/auth/calendar.addons.execute",
"https://www.googleapis.com/auth/calendar.addons.current.event.read",
"https://www.googleapis.com/auth/calendar.addons.current.event.write",
"https://www.googleapis.com/auth/drive.addons.metadata.readonly",
"https://www.googleapis.com/auth/gmail.addons.current.action.compose",
"https://www.googleapis.com/auth/gmail.addons.current.message.metadata",
"https://www.googleapis.com/auth/userinfo.email",
"https://www.googleapis.com/auth/script.external_request",
"https://www.googleapis.com/auth/script.locale",
"https://www.googleapis.com/auth/script.scriptapp",
"https://www.googleapis.com/auth/drive.file",
"https://www.googleapis.com/auth/documents.currentonly",
"https://www.googleapis.com/auth/spreadsheets.currentonly",
"https://www.googleapis.com/auth/presentations.currentonly",
"https://www.googleapis.com/auth/workspace.linkpreview"
]
}URL を許可リストに登録
許可リストを使用して、スクリプトまたはアドオンによるアクセスが事前に承認されている特定の URL を指定します。許可リストはユーザーデータの保護に役立ちます。許可リストを定義すると、スクリプト プロジェクトは許可リストに登録されていない URL にアクセスできません。
テストデプロイをインストールする場合、このフィールドは省略できますが、バージョニングされたデプロイを作成する場合は必須です。
許可リストは、スクリプトまたはアドオンが次のアクションを実行する場合に使用します。
- Apps Script の
UrlFetchサービスを使用して、外部の場所（HTTPS エンドポイントなど）から情報を取得または取得します。取得対象の URL を許可リストに登録するには、マニフェスト ファイルにurlFetchWhitelistフィールドを含めます。 - ユーザーの操作に応じて URL を開くか表示します（Google の外部にある URL を開くか表示する Google Workspace アドオンに必要です）。URL を開くことを許可リストに登録するには、マニフェスト ファイルに
addOns.common.openLinkUrlPrefixesフィールドを含めます。
許可リストにプレフィックスを追加する
マニフェスト ファイルで許可リストを指定する（addOns.common.openLinkUrlPrefixes フィールドまたは urlFetchWhitelist フィールドを含める）場合は、URL 接頭辞のリストを含める必要があります。マニフェストに追加する接頭辞は、次の要件を満たす必要があります。
- 各接頭辞には有効な URL を指定する必要があります。
- 各プレフィックスでは
http://ではなくhttps://を使用する必要があります。 - 各プレフィックスには完全なドメインが必要です。
- 各接頭辞には空でないパスが必要です。たとえば、
https://www.google.com/は有効ですが、https://www.google.comは無効です。 - ワイルドカードを使用して、URL サブドメインの接頭辞と照合できます。
- すべてのリンクと一致するように
addOns.common.openLinkUrlPrefixesフィールドで*ワイルドカードを 1 つ使用できますが、この方法はユーザーのデータをリスクにさらす可能性があり、アドオンの審査プロセスが長引く可能性があるためおすすめしません。ワイルドカードは、アドオン機能で必要な場合にのみ使用します。
URL が許可リストに登録されたプレフィックスと一致するかどうかを判断するには、次のルールが適用されます。
- パス マッチングでは大文字と小文字が区別されます。
- プレフィックスが URL と同一の場合は、一致とみなされます。
- URL が接頭辞と同じ、または子である場合は一致とみなされます。
たとえば、接頭辞 https://example.com/foo は次の URL と一致します。
https://example.com/foohttps://example.com/foo/https://example.com/foo/barhttps://example.com/foo?barhttps://example.com/foo#bar
ワイルドカードの使用
1 つのワイルドカード文字（*）を使用して、urlFetchWhitelist フィールドと addOns.common.openLinkUrlPrefixes フィールドの両方のサブドメインに一致させることができます。複数のワイルドカードを使用して複数のサブドメインに一致させることはできません。ワイルドカードは、URL の先頭のプレフィックスを表す必要があります。
たとえば、接頭辞 https://*.example.com/foo は次の URL と一致します。
https://subdomain.example.com/foohttps://any.number.of.subdomains.example.com/foo
接頭辞 https://*.example.com/foo は次の URL とは一致しません。
https://subdomain.example.com/bar（接尾辞の不一致）https://example.com/foo（サブドメインが 1 つ以上必要です）
マニフェストを保存しようとすると、一部の接頭辞ルールが適用されます。たとえば、次の接頭辞は、保存しようとしたときにマニフェストに存在するとエラーが発生します。
https://*.*.example.com/foo（複数のワイルドカードは禁止されています）https://subdomain.*.example.com/foo（先頭の接頭辞としてワイルドカードを使用する必要があります）