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

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

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

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

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

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

string

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

СсылкаПредварительный просмотрТриггеры

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

string

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

Урипаттерн

Конфигурация для каждого шаблона 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.

Чтобы настроить этот триггер для надстройки 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 .
,

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

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

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

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

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

string

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

СсылкаПредварительный просмотрТриггеры

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

string

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

Урипаттерн

Конфигурация для каждого шаблона 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.

Чтобы настроить этот триггер для надстройки 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 .