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

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

編集者

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

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

object (HomepageTrigger)

このトリガー関数は、ホストアプリにアドオンのホームページを作成します。これにより、 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 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 で指定し、ハイフン - で区切ります。
patterns[]

object (UriPattern)

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

string

必須。ユーザーが https://www.googleapis.com/auth/workspace.linkpreview スコープを承認したときに実行する関数の名前。この関数は、プレビューする URL を含む matchedUrl.url プロパティを含むイベント オブジェクトを受け取り、Card オブジェクトを返す必要があります。
logoUrl

string

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

UriPattern

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

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

string

各 URL パターンで必須。URL パターンのドメイン。アドオンは、このドメインを含むリンクをプレビューします。すべてのサブドメインを照合するには、ワイルドカード アスタリスク（*）を使用します。
pathPrefix

string

省略可。ドメインを追加するパス。ドメイン内のすべての URL を照合するには、pathPrefix を空のままにします。

CreateActionTriggers

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

Google Workspace アドオンでこのトリガーを設定するには、スマートチップを使用してサードパーティ リソースを作成するをご覧ください。

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

string

必須。この拡張ポイントの一意の ID。[a-zA-Z0-9-]+. 形式で 64 文字まで使用します。
labelText

string

必須。@ メニューに表示されるテキスト（Create support case など）。
localizedLabelText

map (key: string, value: string)

省略可。ローカライズする labelText の地図。言語は ISO 639、国/地域は ISO 3166 で指定し、ハイフン - で区切ります。
runFunction

string

必須。ユーザーが拡張ポイントを選択したときに実行する関数の名前。関数はフォームカードを返す必要があります。
logoUrl

string

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