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

エディタ内で 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 が使用されます。