エディタ マニフェスト リソース

リソース構成を定義するには、 Google Workspace アドオン 表示内容と動作を変更できます。 Google Workspace アドオン マニフェストでは、 Editor を拡張する場合は、Required とマーク付けされたすべてのコンポーネントをレンダリングする必要があります。

編集者

Google Workspace アドオン マニフェストの構成は、 エディタの拡張機能です。詳しくは、 Google Workspace アドオンでエディタを拡張する をご覧ください。

JSON 表現
  {
    "homepageTrigger": {
      object (HomepageTrigger)
    },
    "onFileScopeGrantedTrigger": {
      object (OnFileScopeGrantedTrigger)
    },
    "linkPreviewTriggers": [
      {
        object (LinkPreviewTriggers)
      }
    ],
    "createActionTriggers": [
      {
        object (CreateActionTriggers)
      }
  }
フィールド
homepageTrigger

object (HomepageTrigger)

このトリガー関数は、このアドオンの ホームページ ホストアプリ。このオーバーライドは、 <ph type="x-smartling-placeholder"></ph> addOns.common.homepageTrigger

onFileScopeGrantedTrigger

object (OnFileScopeGrantedTrigger)

アドオンに現在の 編集者ドキュメント。ユーザーが drive.file スコープを承認するとトリガーされます。

linkPreviewTriggers[]

object (LinkPreviewTriggers)

リンク プレビューに必要です。アラートの取り込み時に Google ドキュメント、スプレッドシート、スライドのファイル内のリンクのプレビュー。 詳しくは、スマートチップを使用してリンクをプレビューするをご覧ください。

createActionTriggers[]

object (createActionTriggers)

サードパーティ リソースを作成する場合には必須です。@ メニューからサードパーティ サービスのリソースを作成するためのトリガーのリスト。 詳しくは、スマートチップを使用してサードパーティのリソースを作成するをご覧ください。

OnFileScopeGrantedTrigger

コンテキストに基づくトリガーの設定です。このトリガーは、 CardService.newEditorFileScopeActionResponseBuilder() .requestFileScopeForActiveDocument().build(); を使用してファイル スコープをリクエストし、ユーザーが drive.file を付与する スコープ認可。

JSON 表現
{
  "runFunction": string
}
フィールド
runFunction

string

drive.file スコープの場合に実行する関数の名前 付与されています。指定する場合は、この関数を実装して、インフラストラクチャの の配列を返す アドオン UI に表示する Card オブジェクト。

LinkPreviewTriggers

ユーザーがリンクを入力または貼り付けたときに起動するトリガーの設定です サードパーティや Google 以外のサービスからドキュメントに変換したり、 スプレッドシート、スライドのファイルを共有することもできます。

Google Workspace アドオンにこのトリガーを設定するには: スマートチップを使用してリンクをプレビューする

JSON 表現
{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string,
  "patterns": [
    {
      object(patterns)
    }
  ]
}
フィールド
labelText

string

必須。ユーザーにメッセージを表示するスマートチップの例のテキスト リンクをプレビューします(Example: Support case など)。このテキストは静的で、ユーザーがアドオンを実行する前に表示されます。
localizedLabelText

map (key: string, value: string)

省略可。他の言語にローカライズするための labelText のマップ。言語の書式を設定する ISO 639 に準拠し、 ISO 3166、 ハイフン - で区切ります。たとえば、en-US のようにします。

ユーザーの言語 / 地域が地図のキーに存在する場合、ユーザーには labelText のローカライズ版。

patterns[]

object (UriPattern)

必須。プレビュー リンクのアドオンをトリガーする URL パターンの配列。
runFunction

string

必須。ユーザーが https://www.googleapis.com/auth/workspace.linkpreview スコープを承認したときに実行する関数の名前。 指定する場合、EDITOR_NAME.matchedUrl.url を引数として含むイベント オブジェクトを引数として受け取り、単一の を返すように、この関数を実装する必要があります。 Card オブジェクトで、アドオン UI にリンク プレビューを表示します。
logoUrl

string

省略可。スマートチップとプレビュー カードに表示されるアイコン。条件 省略されている場合、アドオンのツールバー アイコン logoUrl が使用されます。

UriPattern

リンク プレビューをトリガーする各 URL パターンの設定。

JSON 表現
{
  "hostPattern": string,
  "pathPrefix" : string
}
フィールド
hostPattern

string

プレビューする URL パターンごとに必須。URL パターンのドメイン。このアドオンは、URL にこのドメインを含むリンクをプレビューします。特定のサブドメイン(subdomain.example.com など)のリンクをプレビューするには、そのサブドメインを含めます。 ドメイン全体のリンクをプレビューするには、サブドメインとしてアスタリスク(*)付きのワイルドカード文字を指定します。

たとえば、*.example.comsubdomain.example.com と一致します。 および another.subdomain.example.com

pathPrefix

string

省略可。hostPattern のドメインを追加するパス。

たとえば、URL ホストパターンが support.example.com の場合、support.example.com/cases/ でホストされているケースの URL を照合するには、cases を使用します。

ホストパターンのドメイン内のすべての URL に一致させるには、pathPrefix を空白のままにします。

CreateActionTriggers

ユーザーがサードパーティを選択したときに配信されるトリガーの設定 Google ドキュメントの @ メニューから統合メニュー項目を選択し、

Google Workspace アドオンにこのトリガーを設定するには: スマートチップを使用してサードパーティのリソースを作成する

JSON 表現
{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string,
}
フィールド
id

string

必須。この拡張機能を区別するための一意の ID ありますID は 64 文字までで、次の形式にする必要があります。 [a-zA-Z0-9-]+.
labelText

string

必須。@ で始まる メニュー(Create support case など)。
localizedLabelText

map (key: string, value: string)

省略可。他の言語にローカライズするための labelText のマップ。言語の書式を設定する ISO 639 に準拠し、 ISO 3166、 ハイフン - で区切ります。たとえば、en-US のようにします。

ユーザーの言語 / 地域が地図のキーに存在する場合、ユーザーには labelText のローカライズ版。

runFunction

string

必須。ユーザーが @ メニューから拡張ポイントを選択したときに実行する関数の名前。 この関数は、サードパーティ リソースを作成するための入力を含むフォームカードを返します。
logoUrl

string

省略可。@ メニューに表示されるアイコン。省略した場合、アドオンはツールバー アイコン logoUrl を使用します。