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

Google Workspace アドオンのコンテンツと、エディタ内の動作を定義するために使用されるリソース構成。Google Workspace アドオンのマニフェストでエディタを拡張する場合、すべてのコンポーネントで「必須」とマークされている必要があります。

エディタ

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

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

object (HomepageTrigger)

このトリガー関数は、ホストアプリにアドオンのホームページを作成します。これにより、 addOns.common.homepageTrigger がオーバーライドされます。
onFileScopeGrantedTrigger

object (OnFileScopeGrantedTrigger)

アドオンに現在のエディタ ドキュメントに固有の動作が含まれている場合は必須です。これは、ユーザーが drive.file スコープを承認したときにトリガーされます。
linkPreviewTriggers[]

object (LinkPreviewTriggers)

リンク プレビューの場合は必須。Google ドキュメント ドキュメント内のリンクをプレビューするためのトリガーのリスト。詳しくは、Google ドキュメントのプレビュー リンク（デベロッパー プレビュー）をご覧ください。

OnFileScopeGrantedTrigger

CardService.newEditorFileScopeActionResponseBuilder() .requestFileScopeForActiveDocument().build(); を使用してリクエスト ファイル スコープ ダイアログをリクエストし、ユーザーが drive.file スコープの権限を付与すると起動するコンテキスト トリガーの構成。

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

string

drive.file スコープが付与された場合に実行する関数の名前。指定した場合、この関数を実装してアドオン UI に表示する Card オブジェクトの配列を作成し、返す必要があります。

リンク プレビュー トリガー

ユーザーがサードパーティまたは Google 以外のサービスからリンクを Google ドキュメント ドキュメントに入力または貼り付けたときに配信されるトリガーの構成。

Google Workspace アドオンでこのトリガーを設定するには、Google ドキュメントのプレビュー リンク（デベロッパー プレビュー）をご覧ください。

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

string

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

map

（省略可）他の言語にローカライズするための labelText のマップ。言語は ISO 639 の形式で指定します。国/地域は ISO 3166 のハイフン - で区切ります。例: en-US

ユーザーの言語 / 地域が地図のキーに存在する場合は、ローカライズされた labelText が表示されます。
patterns[]

object (UriPattern)

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

string

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

string

（省略可）スマートチップに表示されるアイコン。省略した場合、チップはアドオンのツールバー アイコン logoUrl を使用します。

URI パターン

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

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

string

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

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

string

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

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

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