Ресурс манифеста редактора

Конфигурация ресурсов, используемая для определения содержимого и поведения надстройки 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 Docs, Sheets или Slides. Подробнее см. раздел «Предварительный просмотр ссылок с помощью смарт-чипов» .

createActionTriggers[]

object ( createActionTriggers )

Необходим для создания ресурсов сторонних сервисов. Список триггеров для создания ресурсов в стороннем сервисе из меню @. Подробнее см. раздел «Создание ресурсов сторонних сервисов с помощью смарт-чипов» .

OnFileScopeGrantedTrigger

Настройки для контекстного триггера, который срабатывает, когда диалоговое окно запроса области действия файла использует CardService.newEditorFileScopeActionResponseBuilder().requestFileScopeForActiveDocument().build(); и пользователь предоставляет разрешение на использование области действия drive.file .

JSON-представление
{
  "runFunction": string
}
Поля
runFunction

string

Имя функции, которая будет выполняться, если предоставлена ​​область видимости drive.file . Функция должна возвращать массив объектов Card для пользовательского интерфейса.

LinkPreviewTriggers

Настройки триггера, срабатывающего при вводе или вставке пользователем ссылки из стороннего сервиса в файл Docs, Sheets или Slides.

Чтобы настроить этот триггер для дополнения 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 . Функция должна принимать объект события, который включает свойство matchedUrl.url , содержащее URL-адрес для предварительного просмотра, и возвращать объект Card .
logoUrl

string

Необязательно. Значок, отображаемый на смарт-чипе и карточке предварительного просмотра. Если он отсутствует, дополнение использует свой значок на панели инструментов, logoUrl .

UriPattern

Настройки для каждого шаблона URL-адреса, запускающего предварительный просмотр ссылки.

JSON-представление
{
  "hostPattern": string,
  "pathPrefix" : string
}
Поля
hostPattern

string

Обязательно для каждого шаблона URL . Домен шаблона URL. Дополнение отображает предварительный просмотр ссылок, содержащих этот домен. Для сопоставления всех поддоменов используйте символ подстановки звездочкой ( * ).
pathPrefix

string

Необязательный параметр. Путь, добавляемый к домену. Чтобы сопоставить все URL-адреса в домене, оставьте pathPrefix пустым.

CreateActionTriggers

Настройки триггера, срабатывающего при выборе пользователем пункта меню интеграции со сторонним сервисом из меню Google Docs @.

Чтобы настроить этот триггер для дополнения Google Workspace, см. раздел «Создание сторонних ресурсов с помощью смарт-чипов» .

JSON-представление
{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string,
}
Поля
id

string

Обязательно. Уникальный идентификатор для этой точки расширения. Используйте до 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 .