REST Resource: projects.deployments

{
  "name": string,
  "oauthScopes": [
    string
  ],
  "addOns": {
    object (AddOns)
  },
  "etag": string
}

string

Имя ресурса развертывания. Пример: projects/123/deployments/my_deployment .

string

Список областей Google OAuth, для которых запрашивается согласие конечного пользователя перед выполнением конечной точки надстройки.

object ( AddOns )

Конфигурация надстройки Google Workspace.

string

Это значение вычисляется сервером на основе версии развертывания в хранилище и может отправляться в запросах на обновление и удаление, чтобы убедиться, что клиент имеет актуальное значение, прежде чем продолжить.

{
  "common": {
    object (CommonAddOnManifest)
  },
  "gmail": {
    object (GmailAddOnManifest)
  },
  "drive": {
    object (DriveAddOnManifest)
  },
  "calendar": {
    object (CalendarAddOnManifest)
  },
  "docs": {
    object (DocsAddOnManifest)
  },
  "sheets": {
    object (SheetsAddOnManifest)
  },
  "slides": {
    object (SlidesAddOnManifest)
  },
  "httpOptions": {
    object (HttpOptions)
  }
}

object ( CommonAddOnManifest )

Конфигурация, общая для всех дополнений Google Workspace.

object ( GmailAddOnManifest )

Конфигурация дополнения Gmail.

object ( DriveAddOnManifest )

Конфигурация надстройки диска.

object ( CalendarAddOnManifest )

Настройка дополнения календаря.

object ( DocsAddOnManifest )

Конфигурация дополнения «Документы».

object ( SheetsAddOnManifest )

Конфигурация надстройки Таблиц.

object ( SlidesAddOnManifest )

Конфигурация надстройки слайдов.

object ( HttpOptions )

Варианты отправки запросов на дополнительные конечные точки HTTP

{
  "name": string,
  "logoUrl": string,
  "layoutProperties": {
    object (LayoutProperties)
  },
  "addOnWidgetSet": {
    object (AddOnWidgetSet)
  },
  "useLocaleFromApp": boolean,
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "universalActions": [
    {
      object (UniversalActionExtensionPoint)
    }
  ],
  "openLinkUrlPrefixes": array
}

string

Необходимый. Отображаемое имя дополнения.

string

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

object ( LayoutProperties )

Общие свойства макета для дополнительных карт.

object ( AddOnWidgetSet )

Виджеты, используемые в дополнении. Если это поле не указано, используется набор по умолчанию.

boolean

Передавать ли информацию о локали из хост-приложения.

object ( HomepageExtensionPoint )

Определяет конечную точку, которая будет выполняться в любом контексте и на любом хосте. Любые карточки, созданные этой функцией, всегда будут доступны пользователю, но могут быть затмены контекстным контентом, когда это дополнение объявляет более целевые триггеры.

object ( UniversalActionExtensionPoint )

Определяет список точек расширения в универсальном меню действий, которое служит меню настроек дополнения. Точкой расширения может быть URL-адрес ссылки для открытия или конечная точка для выполнения при отправке формы.

array ( ListValue format)

Действие OpenLink может использовать только URL-адрес со схемой HTTPS , MAILTO или TEL . Для ссылок HTTPS URL-адрес также должен соответствовать одному из префиксов, указанных в белом списке. Если в префиксе отсутствует схема, предполагается HTTPS . HTTP ссылки автоматически перезаписываются в HTTPS ссылки.

{
  "primaryColor": string,
  "secondaryColor": string,
  "useNewMaterialDesign": boolean
}

string

Основной цвет дополнения. Он устанавливает цвет панели инструментов. Если основной цвет не установлен, используется значение по умолчанию, предоставленное платформой.

string

Вторичный цвет дополнения. Он устанавливает цвет кнопок. Если основной цвет установлен, но не задан дополнительный цвет, дополнительный цвет совпадает с основным цветом. Если ни основной, ни вторичный цвет не заданы, используется значение по умолчанию, предоставленное платформой.

boolean

Включает материальный дизайн для карточек.

{
  "usedWidgets": [
    enum (WidgetType)
  ]
}

enum ( WidgetType )

Список виджетов, используемых в дополнении.

{
  "runFunction": string,
  "enabled": boolean
}

string

Необходимый. Конечная точка, которая будет выполняться при активации этой точки расширения.

boolean

Необязательный. Если установлено значение false , деактивируется просмотр домашней страницы в этом контексте.

По умолчанию true , если не установлено.

Если пользовательский вид домашней страницы надстройки отключен, вместо этого пользователям предоставляется общая обзорная карточка.

{
  "label": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}

string

Необходимый. Видимый пользователю текст, описывающий действие, выполняемое при активации этой точки расширения, например «Добавить новый контакт».

string

URL-адрес, который будет открыт UniversalAction.

string

Конечная точка, которую будет запускать UniversalAction.

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "authorizationCheckFunction": string
}

object ( HomepageExtensionPoint )

Определяет конечную точку, которая будет выполняться в контекстах, не соответствующих объявленному контекстному триггеру. Любые карточки, созданные этой функцией, всегда будут доступны пользователю, но могут быть затмены контекстным контентом, когда это дополнение объявляет более целевые триггеры.

Если он присутствует, он переопределяет конфигурацию из addons.common.homepageTrigger .

object ( ContextualTrigger )

Определяет набор условий, которые запускают надстройку.

object ( UniversalAction )

Определяет набор универсальных действий для дополнения. Пользователь запускает универсальные действия из меню панели инструментов надстройки.

object ( ComposeTrigger )

Определяет триггер времени создания для надстройки времени создания. Это триггер, который заставляет надстройку выполнять действие, когда пользователь составляет электронное письмо. Все надстройки времени создания должны иметь область действия gmail.addons.current.action.compose даже если они не могут редактировать черновик.

string

Имя конечной точки, которая проверяет наличие у надстройки всех необходимых сторонних авторизаций путем проверки сторонних API. Если проверка не удалась, функция должна выдать исключение, чтобы инициировать поток авторизации. Эта функция вызывается перед каждым вызовом надстройки, чтобы обеспечить удобство работы пользователя.

{
  "onTriggerFunction": string,

  // Union field trigger can be only one of the following:
  "unconditional": {
    object (UnconditionalTrigger)
  }
  // End of list of possible types for union field trigger.
}

string

Необходимый. Имя конечной точки для вызова, когда сообщение соответствует триггеру.

object ( UnconditionalTrigger )

Безусловные триггеры выполняются при открытии любого почтового сообщения.

{
  "text": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}

string

Необходимый. Видимый пользователю текст, описывающий действие, например «Добавить новый контакт».

string

Ссылка, которая открывается Gmail, когда пользователь запускает действие.

string

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

{
  "actions": [
    {
      object (MenuItemExtensionPoint)
    }
  ],
  "draftAccess": enum (DraftAccess)
}

object ( MenuItemExtensionPoint )

Определяет набор действий для надстройки времени создания. Это действия, которые пользователи могут запускать в надстройке времени создания сообщения.

enum ( DraftAccess )

Определяет уровень доступа к данным при запуске надстройки времени создания.

{
  "runFunction": string,
  "label": string,
  "logoUrl": string
}

string

Необходимый. Конечная точка, которая будет выполняться при активации этой точки расширения.

string

Необходимый. Видимый пользователю текст, описывающий действие, предпринятое при активации этой точки расширения. Например, «Вставить счет».

string

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

Если этот параметр не установлен, по умолчанию используется основной URL-адрес логотипа надстройки.

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onItemsSelectedTrigger": {
    object (DriveExtensionPoint)
  }
}

object ( HomepageExtensionPoint )

Если он присутствует, он переопределяет конфигурацию из addons.common.homepageTrigger .

object ( DriveExtensionPoint )

Соответствует поведению, которое выполняется при выборе элементов в соответствующем представлении Диска, например в списке документов «Мой диск».

{
  "runFunction": string
}

string

Необходимый. Конечная точка, которая будет выполняться при активации точки расширения.

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "createSettingsUrlFunction": string,
  "eventOpenTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventUpdateTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventAttachmentTrigger": {
    object (MenuItemExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}

object ( HomepageExtensionPoint )

Определяет конечную точку, которая выполняется в контекстах, не соответствующих объявленному контекстному триггеру. Любые карточки, созданные этой функцией, всегда будут доступны пользователю, но могут быть затмены контекстным контентом, когда это дополнение объявляет более целевые триггеры.

Если он присутствует, он переопределяет конфигурацию из addons.common.homepageTrigger .

object ( ConferenceSolution )

Определяет решения для конференций, предоставляемые этим дополнением. Сторонние надстройки для конференц-связи можно создавать только в Apps Script .

string

Конечная точка для выполнения, которая создает URL-адрес страницы настроек надстройки.

object ( CalendarExtensionPoint )

Конечная точка, которая срабатывает, когда событие открывается для просмотра или редактирования.

object ( CalendarExtensionPoint )

Конечная точка, которая срабатывает при обновлении события открытия.

object ( MenuItemExtensionPoint )

Конфигурация контекстного триггера, который срабатывает, когда пользователь щелкает поставщика дополнительных вложений в раскрывающемся меню «Календарь».

enum ( EventAccess )

Определяет уровень доступа к данным при запуске надстройки события.

{
  "onCreateFunction": string,
  "id": string,
  "name": string,
  "logoUrl": string
}

string

Необходимый. Конечная точка для вызова при создании данных конференции.

string

Необходимый. Идентификаторы должны быть уникальными для всех решений конференц-связи в рамках одной надстройки, в противном случае при запуске надстройки может использоваться неправильное решение конференц-связи. Хотя вы можете изменить отображаемое имя надстройки, идентификатор менять не следует.

string

Необходимый. Отображаемое имя решения для конференции.

string

Необходимый. URL-адрес логотипа решения для конференций.

{
  "runFunction": string
}

string

Необходимый. Конечная точка, которая будет выполняться при активации этой точки расширения.

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (DocsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ],
  "createActionTriggers": [
    {
      object (CreateActionExtensionPoint)
    }
  ]
}

object ( HomepageExtensionPoint )

Если он присутствует, он переопределяет конфигурацию из addons.common.homepageTrigger .

object ( DocsExtensionPoint )

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

object ( LinkPreviewExtensionPoint )

Список точек расширения для предварительного просмотра ссылок в документе Google Docs. Подробности см. в разделе Предварительный просмотр ссылок со смарт-чипами .

object ( CreateActionExtensionPoint )

Список точек расширения для создания сторонних ресурсов из приложений Google Workspace. Дополнительные сведения см. в разделе Создание сторонних ресурсов из меню @ .

{
  "runFunction": string
}

string

Необходимый. Конечная точка, которая будет выполняться при активации этой точки расширения.

{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "patterns": [
    {
      object (UriPattern)
    }
  ],
  "runFunction": string,
  "logoUrl": string
}

string

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

map (key: string, value: string)

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

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

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

object ( UriPattern )

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

string

Необходимый. Конечная точка для выполнения при запуске предварительного просмотра ссылки.

string

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

{
  "hostPattern": string,
  "pathPrefix": string
}

string

Требуется для предварительного просмотра каждого шаблона URL. Домен шаблона URL. Надстройка просматривает ссылки, содержащие этот домен в URL-адресе. Чтобы просмотреть ссылки для определенного субдомена, например subdomain.example.com , включите субдомен. Чтобы просмотреть ссылки для всего домена, укажите в качестве поддомена подстановочный знак со звездочкой ( * ).

Например, *.example.com соответствует subdomain.example.com another.subdomain.example.com .

string

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

Например, если шаблон хоста URL-адреса — support.example.com , чтобы сопоставить URL-адреса обращений, размещенных по адресу support.example.com/cases/ , введите cases .

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

{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string
}

string

Необходимый. Уникальный идентификатор, позволяющий отличить эту точку расширения. Идентификатор может содержать до 64 символов и должен быть в формате [a-zA-Z0-9-]+ .

string

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

map (key: string, value: string)

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

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

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

string

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

string

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

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SheetsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}

object ( HomepageExtensionPoint )

Если он присутствует, он переопределяет конфигурацию из addons.common.homepageTrigger .

object ( SheetsExtensionPoint )

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

object ( LinkPreviewExtensionPoint )

Список точек расширения для предварительного просмотра ссылок в документе Google Таблиц. Подробности см. в разделе Предварительный просмотр ссылок со смарт-чипами .

{
  "runFunction": string
}

string

Необходимый. Конечная точка, которая будет выполняться при активации этой точки расширения.

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SlidesExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}

object ( HomepageExtensionPoint )

Если он присутствует, он переопределяет конфигурацию из addons.common.homepageTrigger .

object ( SlidesExtensionPoint )

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

object ( LinkPreviewExtensionPoint )

Список точек расширения для предварительного просмотра ссылок в документе Google Slides. Подробности см. в разделе Предварительный просмотр ссылок со смарт-чипами .

{
  "runFunction": string
}

string

Необходимый. Конечная точка, которая будет выполняться при активации этой точки расширения.

{
  "authorizationHeader": enum (HttpAuthorizationHeader)
}

enum ( HttpAuthorizationHeader )

Конфигурация токена, отправленного в заголовке HTTP авторизации.

{
  "name": string,
  "oauthScopes": [
    string
  ],
  "addOns": {
    object (AddOns)
  },
  "etag": string
}

string

Имя ресурса развертывания. Пример: projects/123/deployments/my_deployment .

string

Список областей Google OAuth, для которых запрашивается согласие конечного пользователя перед выполнением конечной точки надстройки.

object ( AddOns )

Конфигурация надстройки Google Workspace.

string

Это значение вычисляется сервером на основе версии развертывания в хранилище и может отправляться в запросах на обновление и удаление, чтобы убедиться, что клиент имеет актуальное значение, прежде чем продолжить.

{
  "common": {
    object (CommonAddOnManifest)
  },
  "gmail": {
    object (GmailAddOnManifest)
  },
  "drive": {
    object (DriveAddOnManifest)
  },
  "calendar": {
    object (CalendarAddOnManifest)
  },
  "docs": {
    object (DocsAddOnManifest)
  },
  "sheets": {
    object (SheetsAddOnManifest)
  },
  "slides": {
    object (SlidesAddOnManifest)
  },
  "httpOptions": {
    object (HttpOptions)
  }
}

object ( CommonAddOnManifest )

Конфигурация, общая для всех дополнений Google Workspace.

object ( GmailAddOnManifest )

Конфигурация дополнения Gmail.

object ( DriveAddOnManifest )

Конфигурация надстройки диска.

object ( CalendarAddOnManifest )

Настройка дополнения календаря.

object ( DocsAddOnManifest )

Конфигурация дополнения «Документы».

object ( SheetsAddOnManifest )

Конфигурация надстройки Таблиц.

object ( SlidesAddOnManifest )

Конфигурация надстройки слайдов.

object ( HttpOptions )

Варианты отправки запросов на дополнительные конечные точки HTTP

{
  "name": string,
  "logoUrl": string,
  "layoutProperties": {
    object (LayoutProperties)
  },
  "addOnWidgetSet": {
    object (AddOnWidgetSet)
  },
  "useLocaleFromApp": boolean,
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "universalActions": [
    {
      object (UniversalActionExtensionPoint)
    }
  ],
  "openLinkUrlPrefixes": array
}

string

Необходимый. Отображаемое имя дополнения.

string

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

object ( LayoutProperties )

Общие свойства макета для дополнительных карт.

object ( AddOnWidgetSet )

Виджеты, используемые в дополнении. Если это поле не указано, используется набор по умолчанию.

boolean

Передавать ли информацию о локали из хост-приложения.

object ( HomepageExtensionPoint )

Определяет конечную точку, которая будет выполняться в любом контексте и на любом хосте. Любые карточки, созданные этой функцией, всегда будут доступны пользователю, но могут быть затмены контекстным контентом, когда это дополнение объявляет более целевые триггеры.

object ( UniversalActionExtensionPoint )

Определяет список точек расширения в универсальном меню действий, которое служит меню настроек дополнения. Точкой расширения может быть URL-адрес ссылки для открытия или конечная точка для выполнения при отправке формы.

array ( ListValue format)

Действие OpenLink может использовать только URL-адрес со схемой HTTPS , MAILTO или TEL . Для ссылок HTTPS URL-адрес также должен соответствовать одному из префиксов, указанных в белом списке. Если в префиксе отсутствует схема, предполагается HTTPS . HTTP ссылки автоматически перезаписываются в HTTPS ссылки.

{
  "primaryColor": string,
  "secondaryColor": string,
  "useNewMaterialDesign": boolean
}

string

Основной цвет дополнения. Он устанавливает цвет панели инструментов. Если основной цвет не установлен, используется значение по умолчанию, предоставленное платформой.

string

Вторичный цвет дополнения. Он устанавливает цвет кнопок. Если основной цвет установлен, но не задан дополнительный цвет, дополнительный цвет совпадает с основным цветом. Если ни основной, ни вторичный цвет не заданы, используется значение по умолчанию, предоставленное платформой.

boolean

Включает материальный дизайн для карточек.

{
  "usedWidgets": [
    enum (WidgetType)
  ]
}

enum ( WidgetType )

Список виджетов, используемых в дополнении.

{
  "runFunction": string,
  "enabled": boolean
}

string

Необходимый. Конечная точка, которая будет выполняться при активации этой точки расширения.

boolean

Необязательный. Если установлено значение false , деактивируется просмотр домашней страницы в этом контексте.

По умолчанию true , если не установлено.

Если пользовательский вид домашней страницы надстройки отключен, вместо этого пользователям предоставляется общая обзорная карточка.

{
  "label": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}

string

Необходимый. Видимый пользователю текст, описывающий действие, выполняемое при активации этой точки расширения, например «Добавить новый контакт».

string

URL-адрес, который будет открыт UniversalAction.

string

Конечная точка, которую будет запускать UniversalAction.

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "authorizationCheckFunction": string
}

object ( HomepageExtensionPoint )

Определяет конечную точку, которая будет выполняться в контекстах, не соответствующих объявленному контекстному триггеру. Любые карточки, созданные этой функцией, всегда будут доступны пользователю, но могут быть затмены контекстным контентом, когда это дополнение объявляет более целевые триггеры.

Если он присутствует, он переопределяет конфигурацию из addons.common.homepageTrigger .

object ( ContextualTrigger )

Определяет набор условий, которые запускают надстройку.

object ( UniversalAction )

Определяет набор универсальных действий для дополнения. Пользователь запускает универсальные действия из меню панели инструментов надстройки.

object ( ComposeTrigger )

Определяет триггер времени создания для надстройки времени создания. Это триггер, который заставляет надстройку выполнять действие, когда пользователь составляет электронное письмо. Все надстройки времени создания должны иметь область действия gmail.addons.current.action.compose даже если они не могут редактировать черновик.

string

Имя конечной точки, которая проверяет наличие у надстройки всех необходимых сторонних авторизаций путем проверки сторонних API. Если проверка не удалась, функция должна выдать исключение, чтобы инициировать поток авторизации. Эта функция вызывается перед каждым вызовом надстройки, чтобы обеспечить удобство работы пользователя.

{
  "onTriggerFunction": string,

  // Union field trigger can be only one of the following:
  "unconditional": {
    object (UnconditionalTrigger)
  }
  // End of list of possible types for union field trigger.
}

string

Необходимый. Имя конечной точки для вызова, когда сообщение соответствует триггеру.

object ( UnconditionalTrigger )

Безусловные триггеры выполняются при открытии любого почтового сообщения.

{
  "text": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}

string

Необходимый. Видимый пользователю текст, описывающий действие, например «Добавить новый контакт».

string

Ссылка, которая открывается Gmail, когда пользователь запускает действие.

string

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

{
  "actions": [
    {
      object (MenuItemExtensionPoint)
    }
  ],
  "draftAccess": enum (DraftAccess)
}

object ( MenuItemExtensionPoint )

Определяет набор действий для надстройки времени создания. Это действия, которые пользователи могут запускать в надстройке времени создания сообщения.

enum ( DraftAccess )

Определяет уровень доступа к данным при запуске надстройки времени создания.

{
  "runFunction": string,
  "label": string,
  "logoUrl": string
}

string

Необходимый. Конечная точка, которая будет выполняться при активации этой точки расширения.

string

Необходимый. Видимый пользователю текст, описывающий действие, предпринятое при активации этой точки расширения. Например, «Вставить счет».

string

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

Если этот параметр не установлен, по умолчанию используется основной URL-адрес логотипа надстройки.

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onItemsSelectedTrigger": {
    object (DriveExtensionPoint)
  }
}

object ( HomepageExtensionPoint )

Если он присутствует, он переопределяет конфигурацию из addons.common.homepageTrigger .

object ( DriveExtensionPoint )

Соответствует поведению, которое выполняется при выборе элементов в соответствующем представлении Диска, например в списке документов «Мой диск».

{
  "runFunction": string
}

string

Необходимый. Конечная точка, которая будет выполняться при активации точки расширения.

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "createSettingsUrlFunction": string,
  "eventOpenTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventUpdateTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventAttachmentTrigger": {
    object (MenuItemExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}

object ( HomepageExtensionPoint )

Определяет конечную точку, которая выполняется в контекстах, не соответствующих объявленному контекстному триггеру. Любые карточки, созданные этой функцией, всегда будут доступны пользователю, но могут быть затмены контекстным контентом, когда это дополнение объявляет более целевые триггеры.

Если он присутствует, он переопределяет конфигурацию из addons.common.homepageTrigger .

object ( ConferenceSolution )

Определяет решения для конференций, предоставляемые этим дополнением. Сторонние надстройки для конференц-связи можно создавать только в Apps Script .

string

Конечная точка для выполнения, которая создает URL-адрес страницы настроек надстройки.

object ( CalendarExtensionPoint )

Конечная точка, которая срабатывает, когда событие открывается для просмотра или редактирования.

object ( CalendarExtensionPoint )

Конечная точка, которая срабатывает при обновлении события открытия.

object ( MenuItemExtensionPoint )

Конфигурация контекстного триггера, который срабатывает, когда пользователь щелкает поставщика дополнительных вложений в раскрывающемся меню «Календарь».

enum ( EventAccess )

Определяет уровень доступа к данным при запуске надстройки события.

{
  "onCreateFunction": string,
  "id": string,
  "name": string,
  "logoUrl": string
}

string

Необходимый. Конечная точка для вызова при создании данных конференции.

string

Необходимый. Идентификаторы должны быть уникальными для всех решений конференц-связи в рамках одной надстройки, в противном случае при запуске надстройки может использоваться неправильное решение конференц-связи. Хотя вы можете изменить отображаемое имя надстройки, идентификатор менять не следует.

string

Необходимый. Отображаемое имя решения для конференции.

string

Необходимый. URL-адрес логотипа решения для конференций.

{
  "runFunction": string
}

string

Необходимый. Конечная точка, которая будет выполняться при активации этой точки расширения.

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (DocsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ],
  "createActionTriggers": [
    {
      object (CreateActionExtensionPoint)
    }
  ]
}

object ( HomepageExtensionPoint )

Если он присутствует, он переопределяет конфигурацию из addons.common.homepageTrigger .

object ( DocsExtensionPoint )

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

object ( LinkPreviewExtensionPoint )

Список точек расширения для предварительного просмотра ссылок в документе Google Docs. Подробности см. в разделе Предварительный просмотр ссылок со смарт-чипами .

object ( CreateActionExtensionPoint )

Список точек расширения для создания сторонних ресурсов из приложений Google Workspace. Дополнительные сведения см. в разделе Создание сторонних ресурсов из меню @ .

{
  "runFunction": string
}

string

Необходимый. Конечная точка, которая будет выполняться при активации этой точки расширения.

{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "patterns": [
    {
      object (UriPattern)
    }
  ],
  "runFunction": string,
  "logoUrl": string
}

string

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

map (key: string, value: string)

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

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

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

object ( UriPattern )

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

string

Необходимый. Конечная точка для выполнения при запуске предварительного просмотра ссылки.

string

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

{
  "hostPattern": string,
  "pathPrefix": string
}

string

Требуется для предварительного просмотра каждого шаблона URL. Домен шаблона URL. Надстройка просматривает ссылки, содержащие этот домен в URL-адресе. Чтобы просмотреть ссылки для определенного субдомена, например subdomain.example.com , включите субдомен. Чтобы просмотреть ссылки для всего домена, укажите в качестве поддомена подстановочный знак со звездочкой ( * ).

Например, *.example.com соответствует subdomain.example.com another.subdomain.example.com .

string

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

Например, если шаблон хоста URL-адреса — support.example.com , чтобы сопоставить URL-адреса обращений, размещенных по адресу support.example.com/cases/ , введите cases .

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

{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string
}

string

Необходимый. Уникальный идентификатор, позволяющий отличить эту точку расширения. Идентификатор может содержать до 64 символов и должен быть в формате [a-zA-Z0-9-]+ .

string

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

map (key: string, value: string)

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

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

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

string

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

string

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

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SheetsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}

object ( HomepageExtensionPoint )

Если он присутствует, он переопределяет конфигурацию из addons.common.homepageTrigger .

object ( SheetsExtensionPoint )

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

object ( LinkPreviewExtensionPoint )

Список точек расширения для предварительного просмотра ссылок в документе Google Таблиц. Подробности см. в разделе Предварительный просмотр ссылок со смарт-чипами .

{
  "runFunction": string
}

string

Необходимый. Конечная точка, которая будет выполняться при активации этой точки расширения.

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SlidesExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}

object ( HomepageExtensionPoint )

Если он присутствует, он переопределяет конфигурацию из addons.common.homepageTrigger .

object ( SlidesExtensionPoint )

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

object ( LinkPreviewExtensionPoint )

Список точек расширения для предварительного просмотра ссылок в документе Google Slides. Подробности см. в разделе Предварительный просмотр ссылок со смарт-чипами .

{
  "runFunction": string
}

string

Необходимый. Конечная точка, которая будет выполняться при активации этой точки расширения.

{
  "authorizationHeader": enum (HttpAuthorizationHeader)
}

enum ( HttpAuthorizationHeader )

Конфигурация токена, отправленного в заголовке HTTP авторизации.

{
  "name": string,
  "oauthScopes": [
    string
  ],
  "addOns": {
    object (AddOns)
  },
  "etag": string
}

string

Имя ресурса развертывания. Пример: projects/123/deployments/my_deployment .

string

Список областей Google OAuth, для которых запрашивается согласие конечного пользователя перед выполнением конечной точки надстройки.

object ( AddOns )

Конфигурация надстройки Google Workspace.

string

Это значение вычисляется сервером на основе версии развертывания в хранилище и может отправляться в запросах на обновление и удаление, чтобы убедиться, что клиент имеет актуальное значение, прежде чем продолжить.

{
  "common": {
    object (CommonAddOnManifest)
  },
  "gmail": {
    object (GmailAddOnManifest)
  },
  "drive": {
    object (DriveAddOnManifest)
  },
  "calendar": {
    object (CalendarAddOnManifest)
  },
  "docs": {
    object (DocsAddOnManifest)
  },
  "sheets": {
    object (SheetsAddOnManifest)
  },
  "slides": {
    object (SlidesAddOnManifest)
  },
  "httpOptions": {
    object (HttpOptions)
  }
}

object ( CommonAddOnManifest )

Конфигурация, общая для всех дополнений Google Workspace.

object ( GmailAddOnManifest )

Конфигурация дополнения Gmail.

object ( DriveAddOnManifest )

Конфигурация надстройки диска.

object ( CalendarAddOnManifest )

Настройка дополнения календаря.

object ( DocsAddOnManifest )

Конфигурация дополнения «Документы».

object ( SheetsAddOnManifest )

Конфигурация надстройки Таблиц.

object ( SlidesAddOnManifest )

Конфигурация надстройки слайдов.

object ( HttpOptions )

Варианты отправки запросов на дополнительные конечные точки HTTP

{
  "name": string,
  "logoUrl": string,
  "layoutProperties": {
    object (LayoutProperties)
  },
  "addOnWidgetSet": {
    object (AddOnWidgetSet)
  },
  "useLocaleFromApp": boolean,
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "universalActions": [
    {
      object (UniversalActionExtensionPoint)
    }
  ],
  "openLinkUrlPrefixes": array
}

string

Необходимый. Отображаемое имя дополнения.

string

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

object ( LayoutProperties )

Общие свойства макета для дополнительных карт.

object ( AddOnWidgetSet )

Виджеты, используемые в дополнении. Если это поле не указано, используется набор по умолчанию.

boolean

Передавать ли информацию о локали из хост-приложения.

object ( HomepageExtensionPoint )

Определяет конечную точку, которая будет выполняться в любом контексте и на любом хосте. Любые карточки, созданные этой функцией, всегда будут доступны пользователю, но могут быть затмены контекстным контентом, когда это дополнение объявляет более целевые триггеры.

object ( UniversalActionExtensionPoint )

Определяет список точек расширения в универсальном меню действий, которое служит меню настроек дополнения. Точкой расширения может быть URL-адрес ссылки для открытия или конечная точка для выполнения при отправке формы.

array ( ListValue format)

Действие OpenLink может использовать только URL-адрес со схемой HTTPS , MAILTO или TEL . Для ссылок HTTPS URL-адрес также должен соответствовать одному из префиксов, указанных в белом списке. Если в префиксе отсутствует схема, предполагается HTTPS . HTTP ссылки автоматически перезаписываются в HTTPS ссылки.

{
  "primaryColor": string,
  "secondaryColor": string,
  "useNewMaterialDesign": boolean
}

string

Основной цвет дополнения. Он устанавливает цвет панели инструментов. Если основной цвет не установлен, используется значение по умолчанию, предоставленное платформой.

string

Вторичный цвет дополнения. Он устанавливает цвет кнопок. Если основной цвет установлен, но не задан дополнительный цвет, дополнительный цвет совпадает с основным цветом. Если ни основной, ни вторичный цвет не заданы, используется значение по умолчанию, предоставленное платформой.

boolean

Включает материальный дизайн для карточек.

{
  "usedWidgets": [
    enum (WidgetType)
  ]
}

enum ( WidgetType )

Список виджетов, используемых в дополнении.

{
  "runFunction": string,
  "enabled": boolean
}

string

Необходимый. Конечная точка, которая будет выполняться при активации этой точки расширения.

boolean

Необязательный. Если установлено значение false , деактивируется просмотр домашней страницы в этом контексте.

По умолчанию true , если не установлено.

Если пользовательский вид домашней страницы надстройки отключен, вместо этого пользователям предоставляется общая обзорная карточка.

{
  "label": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}

string

Необходимый. Видимый пользователю текст, описывающий действие, выполняемое при активации этой точки расширения, например «Добавить новый контакт».

string

URL-адрес, который будет открыт UniversalAction.

string

Конечная точка, которую будет запускать UniversalAction.

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "authorizationCheckFunction": string
}

object ( HomepageExtensionPoint )

Определяет конечную точку, которая будет выполняться в контекстах, не соответствующих объявленному контекстному триггеру. Любые карточки, созданные этой функцией, всегда будут доступны пользователю, но могут быть затмены контекстным контентом, когда это дополнение объявляет более целевые триггеры.

Если он присутствует, он переопределяет конфигурацию из addons.common.homepageTrigger .

object ( ContextualTrigger )

Определяет набор условий, которые запускают надстройку.

object ( UniversalAction )

Определяет набор универсальных действий для дополнения. Пользователь запускает универсальные действия из меню панели инструментов надстройки.

object ( ComposeTrigger )

Определяет триггер времени создания для надстройки времени создания. Это триггер, который заставляет надстройку выполнять действие, когда пользователь составляет электронное письмо. Все надстройки времени создания должны иметь область действия gmail.addons.current.action.compose даже если они не могут редактировать черновик.

string

Имя конечной точки, которая проверяет наличие у надстройки всех необходимых сторонних авторизаций путем проверки сторонних API. Если проверка не удалась, функция должна выдать исключение, чтобы инициировать поток авторизации. Эта функция вызывается перед каждым вызовом надстройки, чтобы обеспечить удобство работы пользователя.

{
  "onTriggerFunction": string,

  // Union field trigger can be only one of the following:
  "unconditional": {
    object (UnconditionalTrigger)
  }
  // End of list of possible types for union field trigger.
}

string

Необходимый. Имя конечной точки для вызова, когда сообщение соответствует триггеру.

object ( UnconditionalTrigger )

Безусловные триггеры выполняются при открытии любого почтового сообщения.

{
  "text": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}

string

Необходимый. Видимый пользователю текст, описывающий действие, например «Добавить новый контакт».

string

Ссылка, которая открывается Gmail, когда пользователь запускает действие.

string

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

{
  "actions": [
    {
      object (MenuItemExtensionPoint)
    }
  ],
  "draftAccess": enum (DraftAccess)
}

object ( MenuItemExtensionPoint )

Определяет набор действий для надстройки времени создания. Это действия, которые пользователи могут запускать в надстройке времени создания сообщения.

enum ( DraftAccess )

Определяет уровень доступа к данным при запуске надстройки времени создания.

{
  "runFunction": string,
  "label": string,
  "logoUrl": string
}

string

Необходимый. Конечная точка, которая будет выполняться при активации этой точки расширения.

string

Необходимый. Видимый пользователю текст, описывающий действие, предпринятое при активации этой точки расширения. Например, «Вставить счет».

string

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

Если этот параметр не установлен, по умолчанию используется основной URL-адрес логотипа надстройки.

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onItemsSelectedTrigger": {
    object (DriveExtensionPoint)
  }
}

object ( HomepageExtensionPoint )

Если он присутствует, он переопределяет конфигурацию из addons.common.homepageTrigger .

object ( DriveExtensionPoint )

Соответствует поведению, которое выполняется при выборе элементов в соответствующем представлении Диска, например в списке документов «Мой диск».

{
  "runFunction": string
}

string

Необходимый. Конечная точка, которая будет выполняться при активации точки расширения.

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "createSettingsUrlFunction": string,
  "eventOpenTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventUpdateTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventAttachmentTrigger": {
    object (MenuItemExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}

object ( HomepageExtensionPoint )

Определяет конечную точку, которая выполняется в контекстах, не соответствующих объявленному контекстному триггеру. Любые карточки, созданные этой функцией, всегда будут доступны пользователю, но могут быть затмены контекстным контентом, когда это дополнение объявляет более целевые триггеры.

Если он присутствует, он переопределяет конфигурацию из addons.common.homepageTrigger .

object ( ConferenceSolution )

Определяет решения для конференций, предоставляемые этим дополнением. Сторонние надстройки для конференц-связи можно создавать только в Apps Script .

string

Конечная точка для выполнения, которая создает URL-адрес страницы настроек надстройки.

object ( CalendarExtensionPoint )

Конечная точка, которая срабатывает, когда событие открывается для просмотра или редактирования.

object ( CalendarExtensionPoint )

Конечная точка, которая срабатывает при обновлении события открытия.

object ( MenuItemExtensionPoint )

Конфигурация контекстного триггера, который срабатывает, когда пользователь щелкает поставщика дополнительных вложений в раскрывающемся меню «Календарь».

enum ( EventAccess )

Определяет уровень доступа к данным при запуске надстройки события.

{
  "onCreateFunction": string,
  "id": string,
  "name": string,
  "logoUrl": string
}

string

Необходимый. Конечная точка для вызова при создании данных конференции.

string

Необходимый. Идентификаторы должны быть уникальными для всех решений конференц-связи в рамках одной надстройки, в противном случае при запуске надстройки может использоваться неправильное решение конференц-связи. Хотя вы можете изменить отображаемое имя надстройки, идентификатор менять не следует.

string

Необходимый. Отображаемое имя решения для конференции.

string

Необходимый. URL-адрес логотипа решения для конференций.

{
  "runFunction": string
}

string

Необходимый. Конечная точка, которая будет выполняться при активации этой точки расширения.

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (DocsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ],
  "createActionTriggers": [
    {
      object (CreateActionExtensionPoint)
    }
  ]
}

object ( HomepageExtensionPoint )

Если он присутствует, он переопределяет конфигурацию из addons.common.homepageTrigger .

object ( DocsExtensionPoint )

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

object ( LinkPreviewExtensionPoint )

Список точек расширения для предварительного просмотра ссылок в документе Google Docs. Подробности см. в разделе Предварительный просмотр ссылок со смарт-чипами .

object ( CreateActionExtensionPoint )

Список точек расширения для создания сторонних ресурсов из приложений Google Workspace. Дополнительные сведения см. в разделе Создание сторонних ресурсов из меню @ .

{
  "runFunction": string
}

string

Необходимый. Конечная точка, которая будет выполняться при активации этой точки расширения.

{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "patterns": [
    {
      object (UriPattern)
    }
  ],
  "runFunction": string,
  "logoUrl": string
}

string

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

map (key: string, value: string)

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

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

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

object ( UriPattern )

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

string

Необходимый. Конечная точка для выполнения при запуске предварительного просмотра ссылки.

string

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

{
  "hostPattern": string,
  "pathPrefix": string
}

string

Требуется для предварительного просмотра каждого шаблона URL. Домен шаблона URL. Надстройка просматривает ссылки, содержащие этот домен в URL-адресе. Чтобы просмотреть ссылки для определенного субдомена, например subdomain.example.com , включите субдомен. Чтобы просмотреть ссылки для всего домена, укажите в качестве поддомена подстановочный знак со звездочкой ( * ).

Например, *.example.com соответствует subdomain.example.com another.subdomain.example.com .

string

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

Например, если шаблон хоста URL-адреса — support.example.com , чтобы сопоставить URL-адреса обращений, размещенных по адресу support.example.com/cases/ , введите cases .

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

{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string
}

string

Необходимый. Уникальный идентификатор, позволяющий отличить эту точку расширения. Идентификатор может содержать до 64 символов и должен быть в формате [a-zA-Z0-9-]+ .

string

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

map (key: string, value: string)

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

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

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

string

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

string

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

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SheetsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}

object ( HomepageExtensionPoint )

Если он присутствует, он переопределяет конфигурацию из addons.common.homepageTrigger .

object ( SheetsExtensionPoint )

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

object ( LinkPreviewExtensionPoint )

Список точек расширения для предварительного просмотра ссылок в документе Google Таблиц. Подробности см. в разделе Предварительный просмотр ссылок со смарт-чипами .

{
  "runFunction": string
}

string

Необходимый. Конечная точка, которая будет выполняться при активации этой точки расширения.

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SlidesExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}

object ( HomepageExtensionPoint )

Если он присутствует, он переопределяет конфигурацию из addons.common.homepageTrigger .

object ( SlidesExtensionPoint )

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

object ( LinkPreviewExtensionPoint )

Список точек расширения для предварительного просмотра ссылок в документе Google Slides. Подробности см. в разделе Предварительный просмотр ссылок со смарт-чипами .

{
  "runFunction": string
}

string

Необходимый. Конечная точка, которая будет выполняться при активации этой точки расширения.

{
  "authorizationHeader": enum (HttpAuthorizationHeader)
}

enum ( HttpAuthorizationHeader )

Конфигурация токена, отправленного в заголовке HTTP авторизации.

{
  "name": string,
  "oauthScopes": [
    string
  ],
  "addOns": {
    object (AddOns)
  },
  "etag": string
}

string

Имя ресурса развертывания. Пример: projects/123/deployments/my_deployment .

string

Список областей Google OAuth, для которых запрашивается согласие конечного пользователя перед выполнением конечной точки надстройки.

object ( AddOns )

Конфигурация надстройки Google Workspace.

string

Это значение вычисляется сервером на основе версии развертывания в хранилище и может отправляться в запросах на обновление и удаление, чтобы убедиться, что клиент имеет актуальное значение, прежде чем продолжить.

{
  "common": {
    object (CommonAddOnManifest)
  },
  "gmail": {
    object (GmailAddOnManifest)
  },
  "drive": {
    object (DriveAddOnManifest)
  },
  "calendar": {
    object (CalendarAddOnManifest)
  },
  "docs": {
    object (DocsAddOnManifest)
  },
  "sheets": {
    object (SheetsAddOnManifest)
  },
  "slides": {
    object (SlidesAddOnManifest)
  },
  "httpOptions": {
    object (HttpOptions)
  }
}

object ( CommonAddOnManifest )

Конфигурация, общая для всех дополнений Google Workspace.

object ( GmailAddOnManifest )

Конфигурация дополнения Gmail.

object ( DriveAddOnManifest )

Конфигурация надстройки диска.

object ( CalendarAddOnManifest )

Настройка дополнения календаря.

object ( DocsAddOnManifest )

Конфигурация дополнения «Документы».

object ( SheetsAddOnManifest )

Конфигурация надстройки Таблиц.

object ( SlidesAddOnManifest )

Конфигурация надстройки слайдов.

object ( HttpOptions )

Варианты отправки запросов на дополнительные конечные точки HTTP

{
  "name": string,
  "logoUrl": string,
  "layoutProperties": {
    object (LayoutProperties)
  },
  "addOnWidgetSet": {
    object (AddOnWidgetSet)
  },
  "useLocaleFromApp": boolean,
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "universalActions": [
    {
      object (UniversalActionExtensionPoint)
    }
  ],
  "openLinkUrlPrefixes": array
}

string

Необходимый. Отображаемое имя дополнения.

string

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

object ( LayoutProperties )

Общие свойства макета для дополнительных карт.

object ( AddOnWidgetSet )

Виджеты, используемые в дополнении. Если это поле не указано, используется набор по умолчанию.

boolean

Передавать ли информацию о локали из хост-приложения.

object ( HomepageExtensionPoint )

Определяет конечную точку, которая будет выполняться в любом контексте и на любом хосте. Любые карточки, созданные этой функцией, всегда будут доступны пользователю, но могут быть затмены контекстным контентом, когда это дополнение объявляет более целевые триггеры.

object ( UniversalActionExtensionPoint )

Определяет список точек расширения в универсальном меню действий, которое служит меню настроек дополнения. Точкой расширения может быть URL-адрес ссылки для открытия или конечная точка для выполнения при отправке формы.

array ( ListValue format)

Действие OpenLink может использовать только URL-адрес со схемой HTTPS , MAILTO или TEL . Для ссылок HTTPS URL-адрес также должен соответствовать одному из префиксов, указанных в белом списке. Если в префиксе отсутствует схема, предполагается HTTPS . HTTP ссылки автоматически перезаписываются в HTTPS ссылки.

{
  "primaryColor": string,
  "secondaryColor": string,
  "useNewMaterialDesign": boolean
}

string

Основной цвет дополнения. Он устанавливает цвет панели инструментов. Если основной цвет не установлен, используется значение по умолчанию, предоставленное платформой.

string

Вторичный цвет дополнения. Он устанавливает цвет кнопок. Если основной цвет установлен, но не задан дополнительный цвет, дополнительный цвет совпадает с основным цветом. Если ни основной, ни вторичный цвет не заданы, используется значение по умолчанию, предоставленное платформой.

boolean

Включает материальный дизайн для карточек.

{
  "usedWidgets": [
    enum (WidgetType)
  ]
}

enum ( WidgetType )

Список виджетов, используемых в дополнении.

{
  "runFunction": string,
  "enabled": boolean
}

string

Необходимый. Конечная точка, которая будет выполняться при активации этой точки расширения.

boolean

Необязательный. Если установлено значение false , деактивируется просмотр домашней страницы в этом контексте.

По умолчанию true , если не установлено.

Если пользовательский вид домашней страницы надстройки отключен, вместо этого пользователям предоставляется общая обзорная карточка.

{
  "label": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}

string

Необходимый. Видимый пользователю текст, описывающий действие, выполняемое при активации этой точки расширения, например «Добавить новый контакт».

string

URL-адрес, который будет открыт UniversalAction.

string

Конечная точка, которую будет запускать UniversalAction.

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "authorizationCheckFunction": string
}

object ( HomepageExtensionPoint )

Определяет конечную точку, которая будет выполняться в контекстах, не соответствующих объявленному контекстному триггеру. Любые карточки, созданные этой функцией, всегда будут доступны пользователю, но могут быть затмены контекстным контентом, когда это дополнение объявляет более целевые триггеры.

Если он присутствует, он переопределяет конфигурацию из addons.common.homepageTrigger .

object ( ContextualTrigger )

Определяет набор условий, которые запускают надстройку.

object ( UniversalAction )

Определяет набор универсальных действий для дополнения. Пользователь запускает универсальные действия из меню панели инструментов надстройки.

object ( ComposeTrigger )

Определяет триггер времени создания для надстройки времени создания. Это триггер, который заставляет надстройку выполнять действие, когда пользователь составляет электронное письмо. Все надстройки времени создания должны иметь область действия gmail.addons.current.action.compose даже если они не могут редактировать черновик.

string

Имя конечной точки, которая проверяет наличие у надстройки всех необходимых сторонних авторизаций путем проверки сторонних API. Если проверка не удалась, функция должна выдать исключение, чтобы инициировать поток авторизации. Эта функция вызывается перед каждым вызовом надстройки, чтобы обеспечить удобство работы пользователя.

{
  "onTriggerFunction": string,

  // Union field trigger can be only one of the following:
  "unconditional": {
    object (UnconditionalTrigger)
  }
  // End of list of possible types for union field trigger.
}

string

Необходимый. Имя конечной точки для вызова, когда сообщение соответствует триггеру.

object ( UnconditionalTrigger )

Безусловные триггеры выполняются при открытии любого почтового сообщения.

{
  "text": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}

string

Необходимый. Видимый пользователю текст, описывающий действие, например «Добавить новый контакт».

string

Ссылка, которая открывается Gmail, когда пользователь запускает действие.

string

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

{
  "actions": [
    {
      object (MenuItemExtensionPoint)
    }
  ],
  "draftAccess": enum (DraftAccess)
}

object ( MenuItemExtensionPoint )

Определяет набор действий для надстройки времени создания. Это действия, которые пользователи могут запускать в надстройке времени создания сообщения.

enum ( DraftAccess )

Определяет уровень доступа к данным при запуске надстройки времени создания.

{
  "runFunction": string,
  "label": string,
  "logoUrl": string
}

string

Необходимый. Конечная точка, которая будет выполняться при активации этой точки расширения.

string

Необходимый. Видимый пользователю текст, описывающий действие, предпринятое при активации этой точки расширения. Например, «Вставить счет».

string

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

Если этот параметр не установлен, по умолчанию используется основной URL-адрес логотипа надстройки.