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

エディタ内の 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 ドキュメント ドキュメント内のリンクをプレビューするためのトリガーのリスト。 詳しくは、スマートチップを使用してリンクをプレビューするをご覧ください。

OnFileScopeGrantedTrigger

CardService.newEditorFileScopeActionResponseBuilder() .requestFileScopeForActiveDocument().build(); を使用してリクエスト ファイル スコープ ダイアログが起動され、ユーザーが drive.file スコープを承認したときに配信されるコンテキスト トリガーの構成。

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

string

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

LinkPreviewTriggers

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

Google Workspace アドオン用にこのトリガーを設定するには、スマートチップを使用してリンクをプレビューするをご覧ください。

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 を空のままにします。