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

Конфигурация ресурсов, используемая для определения содержимого и поведения надстроек 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

Конфигурация триггера, который срабатывает, когда пользователь вводит или вставляет ссылку из стороннего или не принадлежащего Google сервиса в файл 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 , разделённые дефисом - . Например, en-US .

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

patterns[]

object ( UriPattern )

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

string

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

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 , разделённые дефисом - . Например, en-US .

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

runFunction

string

Обязательно. Имя функции, которая будет запущена при выборе пользователем точки расширения в меню @. Функция должна возвращать карточку формы с входными данными для создания стороннего ресурса.
logoUrl

string

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