アドオンは、マニフェスト ファイルを使用して、アプリとそのオペレーションに関する特定の詳細を構成します。
このドキュメントでは、Google Workspace アドオンのマニフェストの構成について詳しく説明します。
Google Workspace アドオンのマニフェスト構造
Google Workspace アドオンはマニフェスト ファイルを使用して、インフラストラクチャのさまざまな側面を定義します。 アドオンの 確認します。
Google Workspace アドオンのマニフェスト プロパティは次のとおりです。
これはマニフェスト オブジェクト構造の addOns セクションにあり、
- Apps Script マニフェスト ファイルの詳細については、マニフェストの構造をご覧ください。
- Google Cloud でビルドされたアドオンのマニフェスト ファイルについては、
HTTP エンドポイント。REST リソース:
projects.deploymentsをご覧ください。
Google Workspace アドオン マニフェストの構成例
次のマニフェスト サンプルは、マニフェスト ファイルの中で、 次のような特長があります。
addOns.commonセクションでは、名前、ロゴの URL、色、その他の値を ホストに依存しない一般的な設定です。- このマニフェストでは、共通のホームページを定義するだけでなく、 カレンダー、ドライブ、ドキュメント、 スプレッドシート、スライド専用のホームページを作成できます。 Gmail ではデフォルトのホームページが使用されます。
- サンプルのマニフェスト設定では、次のことが可能になります。
- カレンダーの
eventOpenトリガーとeventUpdatedトリガー。 - （Apps Script のみ）2 つのカレンダー 会議ソリューションをご覧ください。
- 2 つのユニバーサル アクション。
- ドライブ
onItemsSelectedTrigger。 - Gmail の作成操作とコンテキスト トリガー。
- Docs の
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 を指定する 編集することもできます。許可リストでユーザーを保護 data;許可リストを定義すると、スクリプト プロジェクトは許可リストに登録されている URL には 追加されていないことを確認します。
テストデプロイをインストールする場合、このフィールドは省略できますが、 バージョニングされた Deployment を作成します。
許可リストを使用するのは、スクリプトまたはアドオンが できます。
- 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 が許可リストのプレフィックスと一致するかどうかを判断する際は、次のルールが適用されます。 apply:
- パス マッチングでは大文字と小文字が区別されます。
- 接頭辞が 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（先頭の接頭辞としてワイルドカードを使用する必要があります）。