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

エディタ内で 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。 64 文字まで [a-zA-Z0-9-]+. 形式で使用できます。
labelText

string

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

map (key: string, value: string)

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

string

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

string

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