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

Конфигурация ресурса, используемая для определения содержания и поведения надстройки Google Workspace в редакторах. В манифестах надстройки Google Workspace все компоненты должны быть помечены как обязательные , если они расширяют редактор.

Редакторы

Конфигурация манифеста надстройки Google Workspace для расширений редактора. Дополнительную информацию см . в разделе Расширение возможностей редакторов с помощью надстроек Google Workspace .

Представление JSON
  {
    "homepageTrigger": {
      object (HomepageTrigger)
    },
    "onFileScopeGrantedTrigger": {
      object (OnFileScopeGrantedTrigger)
    },
    "linkPreviewTriggers": [
      {
        object (LinkPreviewTriggers)
      }
    ]
  }
Поля
homepageTrigger

object ( HomepageTrigger )

Эта триггерная функция создает домашнюю страницу надстройки в хост-приложении. Это переопределяет addOns.common.homepageTrigger .

onFileScopeGrantedTrigger

object ( OnFileScopeGrantedTrigger )

Требуется, если ваша надстройка включает поведение, характерное для текущего документа редактора, срабатывающее, когда пользователь авторизует область действия drive.file .

linkPreviewTriggers[]

object ( LinkPreviewTriggers )

Требуется для предварительного просмотра ссылок. Список триггеров для предварительного просмотра ссылок в документе Google Docs. Дополнительные сведения см. в разделе Ссылки для предварительного просмотра в Документах Google (предварительная версия для разработчиков) .

Онфилескопегрантедтриггер

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

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

string

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

LinkPreviewТриггеры

Конфигурация триггера, который срабатывает, когда пользователь вводит или вставляет ссылку из сторонней службы или службы, отличной от Google, в документ Google Docs.

Чтобы настроить этот триггер для надстройки Google Workspace, см. раздел Ссылки для предварительного просмотра в Документах Google (предварительная версия для разработчиков) .

Представление JSON
{
  "labelText": string,
  "runFunction": string,
  "logoUrl": string,
  "patterns": [
    {
      object(patterns)
    }
  ]
}
Поля
labelText

string

Необходимый. Текст примера смарт-чипа, который предлагает пользователям предварительно просмотреть ссылку, например Example: Support case . Этот текст является статическим и отображается до того, как пользователи запустят надстройку.
localizedLabelText

map

Необязательный. Карта labelText для локализации на другие языки. Отформатируйте язык в формате ISO 639 и страну/регион в формате ISO 3166 , разделив их дефисом - . Например, en-US .

Если локаль пользователя указана в ключах карты, пользователь увидит локализованную версию labelText .

patterns[]

object ( UriPattern )

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

string

Необходимый. Имя функции, которая запускается, когда пользователь авторизует область https://www.googleapis.com/auth/workspace.linkpreview . Если указано, вы должны реализовать эту функцию, чтобы принимать объект события, содержащий docs.matchedUrl.url в качестве аргумента, и возвращать один объект 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 , чтобы сопоставить URL-адреса для запросов, размещенных на support.example.com/cases/ , используйте cases использования.

Чтобы сопоставить все URL-адреса в домене шаблона хоста, оставьте pathPrefix пустым.