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

エディタ内での 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 を使用します。