エディタ内で Google Workspace アドオンのコンテンツと動作を定義するために使用されるリソース構成。Google Workspace アドオン マニフェストでエディタを拡張する場合は、すべてのコンポーネントを「必須」とマークする必要があります。
編集者
エディタ拡張機能用の Google Workspace アドオン マニフェストの構成。詳しくは、Google Workspace アドオンによるエディタの拡張をご覧ください。
JSON 表現 |
---|
{ "homepageTrigger": { object (HomepageTrigger) }, "onFileScopeGrantedTrigger": { object (OnFileScopeGrantedTrigger) }, "linkPreviewTriggers": [ { object (LinkPreviewTriggers) } ], "createActionTriggers": [ { object (CreateActionTriggers) } } |
フィールド | |
---|---|
homepageTrigger |
このトリガー関数は、ホストアプリにアドオンのホームページを作成します。これは
|
onFileScopeGrantedTrigger |
アドオンに現在のエディタ ドキュメント固有の動作が含まれている場合は必須です。ユーザーが |
linkPreviewTriggers[] |
リンク プレビューに必要です。Google ドキュメント、スプレッドシート、スライドのファイル内のリンクをプレビューするためのトリガーのリスト。 詳しくは、スマートチップを使用してリンクをプレビューするをご覧ください。 |
createActionTriggers[] |
サードパーティ リソースを作成する場合には必須です。@ メニューからサードパーティ サービスのリソースを作成するためのトリガーのリスト。詳しくは、スマートチップを使用してサードパーティのリソースを作成するをご覧ください。 |
OnFileScopeGrantedTrigger
CardService.newEditorFileScopeActionResponseBuilder()
.requestFileScopeForActiveDocument().build();
を使用してリクエスト ファイル スコープのダイアログが発生し、ユーザーが drive.file
スコープの認可を付与したときに配信されるコンテキスト トリガーの構成。
JSON 表現 |
---|
{ "runFunction": string } |
フィールド | |
---|---|
runFunction |
drive.file スコープが付与されている場合に実行する関数の名前。指定した場合、この関数を実装して、アドオン UI に表示する
Card オブジェクトの配列を作成して返す必要があります。
|
LinkPreviewTriggers
ユーザーがサードパーティまたは Google 以外のサービスからドキュメント、スプレッドシート、スライドのファイルにリンクを入力するか貼り付けたときに起動するトリガーの構成。
Google Workspace アドオンにこのトリガーを設定するには、スマートチップを使用してリンクをプレビューするをご覧ください。
JSON 表現 |
---|
{ "labelText": string, "localizedLabelText": { string: string, ... }, "runFunction": string, "logoUrl": string, "patterns": [ { object(patterns) } ] } |
フィールド | |
---|---|
labelText |
Example: Support case など)。このテキストは静的で、ユーザーがアドオンを実行する前に表示されます。 |
localizedLabelText |
labelText のマップ。言語は ISO 639 形式、国/地域は ISO 3166 形式で指定します(ハイフン - で区切ります)。例: en-US ユーザーのロケールが地図のキーに含まれている場合、ユーザーには |
patterns[] |
|
runFunction |
https://www.googleapis.com/auth/workspace.linkpreview スコープを承認したときに実行する関数の名前。指定する場合、EDITOR_NAME.matchedUrl.url を含むイベント オブジェクトを引数として受け取り、アドオン UI にリンク プレビューを表示する単一の
Card オブジェクトを返すように、この関数を実装する必要があります。
|
logoUrl |
logoUrl が使用されます。 |
UriPattern
リンク プレビューをトリガーする各 URL パターンの設定。
JSON 表現 |
---|
{ "hostPattern": string, "pathPrefix" : string } |
フィールド | |
---|---|
hostPattern |
subdomain.example.com など)のリンクをプレビューするには、そのサブドメインを含めます。
ドメイン全体のリンクをプレビューするには、サブドメインとしてアスタリスク(* )付きのワイルドカード文字を指定します。たとえば、 |
pathPrefix |
hostPattern のドメインを追加するパス。たとえば、URL ホストパターンが ホストパターン ドメイン内のすべての URL を一致させるには、 |
CreateActionTriggers
ユーザーが Google ドキュメントの @ メニューからサードパーティ統合のメニュー項目を選択したときに起動するトリガーの構成。
Google Workspace アドオンにこのトリガーを設定するには、スマートチップを使用してサードパーティのリソースを作成するをご覧ください。
JSON 表現 |
---|
{ "id": string, "labelText": string, "localizedLabelText": { string: string, ... }, "runFunction": string, "logoUrl": string, } |
フィールド | |
---|---|
id |
[a-zA-Z0-9-]+. の形式にする必要があります。 |
labelText |
Create support case など)。 |
localizedLabelText |
labelText のマップ。言語は ISO 639 形式、国/地域は ISO 3166 形式で指定します(ハイフン - で区切ります)。例: en-US ユーザーのロケールが地図のキーに含まれている場合、ユーザーには |
runFunction |
|
logoUrl |
logoUrl が使用されます。 |