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

エディタ内の 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 以外のサービスのリンクをドキュメント、スプレッドシート、スライドのファイルに入力または貼り付けたときにトリガーされるトリガーの構成。

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 を含むイベント オブジェクトを引数として受け取り、アドオンの UI にリンクのプレビューを表示する単一の Card オブジェクトを返すように、この関数を実装する必要があります。
logoUrl

string

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

UriPattern

リンク プレビューをトリガーする各 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 を空白のままにします。

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 を使用します。