- Recurso: implantação
- Complementos
- CommonAddOnManifest
- LayoutProperties
- AddOnWidgetSet
- Tipo de widget
- HomepageExtensionPoint
- UniversalActionExtensionPoint
- GmailAddOnManifest
- ContextualTrigger
- UnconditionalTrigger (link em inglês)
- UniversalAction
- ComposeTrigger
- MenuItemExtensionPoint
- Rascunho de acesso
- DriveAddOnManifest
- DriveExtensionPoint
- CalendarAddOnManifest
- ConferenceSolution (em inglês)
- CalendarExtensionPoint
- EventAccess
- DocsAddOnManifest
- DocsExtensionPoint
- LinkPreviewExtensionPoint
- UriPattern
- PlanilhasAddOnManifest
- PlanilhasExtensionPoint
- ApresentaçõesAddOnManifest
- ApresentaçõesExtensionPoint
- HttpOptions
- HttpAuthorizationHeader (em inglês)
- Métodos
Recurso: Deployment
Uma implantação de complementos do Google Workspace
Representação JSON |
---|
{
"name": string,
"oauthScopes": [
string
],
"addOns": {
object ( |
Campos | |
---|---|
name |
O nome do recurso de implantação. Exemplo: |
oauthScopes[] |
A lista de escopos do Google OAuth para a qual você deseja solicitar o consentimento do usuário final antes de executar um endpoint de complementos. |
addOns |
A configuração do complemento do Google Workspace. |
etag |
Esse valor é calculado pelo servidor com base na versão da implantação no armazenamento e pode ser enviado em solicitações de atualização e exclusão para garantir que o cliente tenha um valor atualizado antes de prosseguir. |
Complementos
Uma configuração de complemento do Google Workspace.
Representação JSON |
---|
{ "common": { object ( |
Campos | |
---|---|
common |
Configuração comum a todos os complementos do Google Workspace. |
gmail |
Configuração de complementos do Gmail. |
drive |
Configuração de complementos do Drive. |
calendar |
Configuração de complementos do Agenda. |
docs |
Configuração de complementos do Documentos. |
sheets |
Configuração de complementos do Planilhas. |
slides |
Configuração de complementos do Apresentações. |
httpOptions |
Opções para enviar solicitações para endpoints HTTP complementares |
CommonAddOnManifest
Configuração de complementos compartilhada em todos os aplicativos host de complementos.
Representação JSON |
---|
{ "name": string, "logoUrl": string, "layoutProperties": { object ( |
Campos | |
---|---|
name |
Obrigatório. O nome de exibição do complemento. |
logoUrl |
Obrigatório. O URL da imagem do logotipo mostrada na barra de ferramentas do complemento. |
layoutProperties |
Propriedades de layout comuns para os cards de complementos. |
addOnWidgetSet |
Os widgets usados no complemento. Se este campo não for especificado, o conjunto padrão será usado. |
useLocaleFromApp |
Define se as informações de localidade serão transmitidas do app host. |
homepageTrigger |
Define um endpoint que será executado em qualquer contexto, em qualquer host. Todos os cards gerados por essa função sempre estarão disponíveis para o usuário, mas poderão ser eliminados por conteúdo contextual quando o complemento declarar acionadores mais segmentados. |
universalActions[] |
Define uma lista de pontos de extensão no menu de ação universal que serve como um menu de configurações para o complemento. O ponto de extensão pode ser um URL de link a ser aberto ou um ponto de extremidade para ser executado como um envio de formulário. |
openLinkUrlPrefixes |
Uma ação do OpenLink só pode usar um URL com um esquema |
LayoutProperties
Propriedades de layout de cartão compartilhadas entre todos os aplicativos host de complementos.
Representação JSON |
---|
{ "primaryColor": string, "secondaryColor": string, "useNewMaterialDesign": boolean } |
Campos | |
---|---|
primaryColor |
A cor principal do complemento. Define a cor da barra de ferramentas. Se nenhuma cor primária for definida, o valor padrão fornecido pela estrutura será usado. |
secondaryColor |
A cor secundária do complemento. Define a cor dos botões. Se a cor principal for definida, mas nenhuma cor secundária for definida, a cor secundária será igual à principal. Se nem a cor primária nem a secundária forem definidas, o valor padrão fornecido pela estrutura será usado. |
useNewMaterialDesign |
Ativa o Material Design para cartões. |
AddOnWidgetSet
O subconjunto de widgets usado por um complemento.
Representação JSON |
---|
{
"usedWidgets": [
enum ( |
Campos | |
---|---|
usedWidgets[] |
A lista de widgets usados em um complemento. |
Tipo de widget
O tipo de widget. WIDGET_TYPE_UNSPECIFIED
é o conjunto básico de widgets.
Enums | |
---|---|
WIDGET_TYPE_UNSPECIFIED |
O widget padrão definido. |
DATE_PICKER |
Seletor de data. |
STYLED_BUTTONS |
Os botões estilizados incluem botões preenchidos e desativados. |
PERSISTENT_FORMS |
Os formulários persistentes permitem manter valores de formulários durante ações. |
FIXED_FOOTER |
Rodapé corrigido em um card. |
UPDATE_SUBJECT_AND_RECIPIENTS |
Atualize o assunto e os destinatários de um rascunho. |
GRID_WIDGET |
O widget de grade. |
ADDON_COMPOSE_UI_ACTION |
Uma ação de complemento do Gmail que se aplica à IU do Compose. |
Página inicialExtensionPoint
Formato comum para declarar a visualização de página inicial de um complemento.
Representação JSON |
---|
{ "runFunction": string, "enabled": boolean } |
Campos | |
---|---|
runFunction |
Obrigatório. O endpoint a ser executado quando esse ponto de extensão for ativado. |
enabled |
Opcional. Se definido como Se não for definido, o padrão será Se a visualização personalizada da página inicial de um complemento for desativada, um cartão de visão geral genérico será fornecido aos usuários. |
UniversalActionExtensionPoint
Formato para declarar um ponto de extensão do item de menu de ação universal.
Representação JSON |
---|
{ "label": string, // Union field |
Campos | |
---|---|
label |
Obrigatório. Texto visível para o usuário que descreve a ação realizada pela ativação deste ponto de extensão, por exemplo, "Adicionar um novo contato". |
Campo de união action_type . Obrigatório. O tipo de ação compatível com um item de menu de ação universal. Pode ser um link a ser aberto ou um endpoint a ser executado. action_type pode ser apenas de um dos tipos a seguir: |
|
openLink |
URL a ser aberto pelo UniversalAction. |
runFunction |
Endpoint a ser executado pelo UniversalAction. |
GmailAddManifest
Propriedades que personalizam a aparência e a execução de um complemento do Gmail.
Representação JSON |
---|
{ "homepageTrigger": { object ( |
Campos | |
---|---|
homepageTrigger |
Define um endpoint que será executado em contextos que não correspondem a um acionador contextual declarado. Todos os cartões gerados por esta função sempre estarão disponíveis para o usuário, mas poderão ser esmagados pelo conteúdo contextual quando este complemento declarar acionadores mais segmentados. Se presente, modifica a configuração de |
contextualTriggers[] |
Define o conjunto de condições que acionam o complemento. |
universalActions[] |
Define um conjunto de ações universais para o complemento. O usuário aciona ações universais no menu da barra de ferramentas do complemento. |
composeTrigger |
Define o acionador de tempo de escrita para um complemento de tempo de escrita. Esse é o acionador que faz com que um complemento execute uma ação quando o usuário está escrevendo um e-mail. Todos os complementos de escrita precisam ter o escopo |
authorizationCheckFunction |
O nome de um endpoint que verifica se o complemento tem todas as autorizações de terceiros necessárias, verificando as APIs de terceiros. Se a sondagem falhar, a função gerará uma exceção para iniciar o fluxo de autorização. Essa função é chamada antes de cada invocação do complemento para garantir uma experiência do usuário tranquila. |
Acionador contextual
Define um acionador que dispara quando o e-mail aberto atende a critérios específicos. Quando o acionador dispara, ele executa um endpoint específico, geralmente para criar novos cards e atualizar a IU.
Representação JSON |
---|
{ "onTriggerFunction": string, // Union field |
Campos | |
---|---|
onTriggerFunction |
Obrigatório. O nome do endpoint a ser chamado quando uma mensagem corresponder ao acionador. |
Campo de união trigger . O tipo de acionador determina as condições que o Gmail usa para exibir o complemento. trigger pode ser apenas de um dos tipos a seguir: |
|
unconditional |
Os acionadores incondicionais são executados quando qualquer mensagem de e-mail é aberta. |
UnconditionalTrigger
Este tipo não tem campos.
Um acionador que dispara quando uma mensagem de e-mail é aberta.
Ação universal
Uma ação que está sempre disponível no menu da barra de ferramentas complementar, independentemente do contexto da mensagem.
Representação JSON |
---|
{ "text": string, // Union field |
Campos | |
---|---|
text |
Obrigatório. Texto visível para o usuário que descreve a ação, por exemplo, "Adicionar um novo contato". |
Campo de união action_type . O tipo de ação determina o comportamento do Gmail quando o usuário invoca a ação. action_type pode ser apenas de um dos tipos a seguir: |
|
openLink |
Um link que é aberto pelo Gmail quando o usuário aciona a ação. |
runFunction |
Um endpoint chamado quando o usuário aciona a ação. Consulte o guia de ações universais para ver mais detalhes. |
ComposeTrigger
Um acionador que é ativado quando o usuário está escrevendo um e-mail.
Representação JSON |
---|
{ "actions": [ { object ( |
Campos | |
---|---|
actions[] |
Define o conjunto de ações para um complemento de escrita. Essas ações podem ser acionadas pelos usuários em um complemento de escrita. |
draftAccess |
Define o nível de acesso aos dados quando um complemento de escrita é acionado. |
MenuItemExtensionPoint
Formato comum para declarar um item ou botão de menu que aparece em um app host.
Representação JSON |
---|
{ "runFunction": string, "label": string, "logoUrl": string } |
Campos | |
---|---|
runFunction |
Obrigatório. O endpoint a ser executado quando esse ponto de extensão for ativado. |
label |
Obrigatório. Texto visível para o usuário que descreve a ação realizada pela ativação deste ponto de extensão. Por exemplo, "Inserir fatura". |
logoUrl |
O URL da imagem do logotipo mostrada na barra de ferramentas do complemento. Se não for definido, o padrão é o URL do logotipo principal do complemento. |
Acesso de rascunho
Um enum que define o nível de acesso aos dados que o acionador de composição exige.
Enums | |
---|---|
UNSPECIFIED |
Valor padrão quando nada é definido para o acesso de rascunho. |
NONE |
O acionador do Compose não pode acessar os dados do rascunho quando um complemento do Compose é acionado. |
METADATA |
Concede ao acionador de composição permissão para acessar os metadados do rascunho quando um complemento de composição é acionado. Isso inclui a lista de público-alvo, como as listas "Para" e "Cc" de uma mensagem de rascunho. |
DriveAddOnManifest
Propriedades que personalizam a aparência e a execução de um complemento do Drive.
Representação JSON |
---|
{ "homepageTrigger": { object ( |
Campos | |
---|---|
homepageTrigger |
Se presente, modifica a configuração de |
onItemsSelectedTrigger |
Corresponde ao comportamento que é executado quando os itens são selecionados na visualização relevante do Drive, como a lista "Meu Drive". |
DriveExtensionPoint
Formato comum para declarar os acionadores de um complemento do Drive.
Representação JSON |
---|
{ "runFunction": string } |
Campos | |
---|---|
runFunction |
Obrigatório. O endpoint a ser executado quando o ponto de extensão for ativado. |
AgendaAddOnManifest
Propriedades que personalizam a aparência e a execução de um complemento do Agenda.
Representação JSON |
---|
{ "homepageTrigger": { object ( |
Campos | |
---|---|
homepageTrigger |
Define um endpoint que é executado em contextos que não correspondem a um acionador contextual declarado. Todos os cards gerados por essa função sempre estarão disponíveis para o usuário, mas poderão ser eliminados por conteúdo contextual quando o complemento declarar acionadores mais segmentados. Se presente, modifica a configuração de |
conferenceSolution[] |
Define soluções de conferência fornecidas por este complemento. |
createSettingsUrlFunction |
Um endpoint a ser executado que cria um URL para a página de configurações do complemento. |
eventOpenTrigger |
Um endpoint que é acionado quando um evento é aberto para visualização ou edição. |
eventUpdateTrigger |
Um endpoint que é acionado quando o evento aberto é atualizado. |
currentEventAccess |
Define o nível de acesso aos dados quando um complemento de eventos é acionado. |
Solução de videoconferência
Define os valores relacionados à conferência.
Representação JSON |
---|
{ "onCreateFunction": string, "id": string, "name": string, "logoUrl": string } |
Campos | |
---|---|
onCreateFunction |
Obrigatório. O ponto de extremidade a ser chamado quando os dados da conferência devem ser criados. |
id |
Obrigatório. Os códigos devem ser atribuídos de forma exclusiva entre soluções de conferência dentro de um complemento. Caso contrário, a solução de conferência errada pode ser usada quando o complemento é acionado. Embora seja possível alterar o nome de exibição de um complemento, o código não deve ser alterado. |
name |
Obrigatório. O nome de exibição da solução de conferência. |
logoUrl |
Obrigatório. O URL da imagem do logotipo da solução de conferência. |
AgendaExtensionPoint
Formato comum para declarar os acionadores de um complemento de agenda.
Representação JSON |
---|
{ "runFunction": string } |
Campos | |
---|---|
runFunction |
Obrigatório. O endpoint a ser executado quando esse ponto de extensão for ativado. |
Acesso ao evento
Um enum que define o nível de acionamento necessário para os eventos de acesso a dados.
Enums | |
---|---|
UNSPECIFIED |
Valor padrão quando nada é definido para eventAccess. |
METADATA |
Concede aos acionadores de eventos a permissão para acessar os metadados de eventos, como o ID do evento e o ID da agenda. |
READ |
Concede aos acionadores de eventos acesso a todos os campos de evento fornecidos, incluindo os metadados, os participantes e os dados da conferência. |
WRITE |
Dá aos acionadores de eventos acesso aos metadados de eventos e a capacidade de executar todas as ações, incluindo a adição de participantes e a configuração de dados de videoconferência. |
READ_WRITE |
Concede aos acionadores de eventos acesso a todos os campos de evento fornecidos, incluindo os metadados, os participantes e os dados da conferência, além da capacidade de executar todas as ações. |
DocumentosAddOnManifest
Propriedades que personalizam a aparência e a execução de um complemento do Documentos Google.
Representação JSON |
---|
{ "homepageTrigger": { object ( |
Campos | |
---|---|
homepageTrigger |
Se presente, modifica a configuração de |
onFileScopeGrantedTrigger |
Endpoint a ser executado quando a autorização do escopo do arquivo for concedida para este par documento/usuário. |
linkPreviewTriggers[] |
Uma lista de pontos de extensão para visualizar links em um documento do Documentos Google. Veja mais detalhes em Visualizar links com ícones inteligentes. |
DocumentosExtensionPoint
Formato comum para declarar os acionadores de um complemento do Documentos.
Representação JSON |
---|
{ "runFunction": string } |
Campos | |
---|---|
runFunction |
Obrigatório. O endpoint a ser executado quando esse ponto de extensão for ativado. |
LinkPreviewExtensionPoint
A configuração de um acionador que dispara quando um usuário digita ou cola um link de um serviço de terceiros ou de terceiros em um documento do Documentos Google.
Representação JSON |
---|
{
"labelText": string,
"localizedLabelText": {
string: string,
...
},
"patterns": [
{
object ( |
Campos | |
---|---|
labelText |
Obrigatório. O texto de um ícone inteligente de exemplo que solicita aos usuários visualizar o link, como |
localizedLabelText |
Opcional. Um mapa de Se a localidade de um usuário estiver nas chaves do mapa, o usuário verá a versão localizada do Um objeto com uma lista de pares |
patterns[] |
Obrigatório. Uma matriz de padrões de URL que acionam o complemento para visualizar links. |
runFunction |
Obrigatório. Endpoint a ser executado quando uma visualização de link for acionada. |
logoUrl |
Opcional. O ícone exibido no ícone inteligente. Se omitido, o ícone usará a barra de ferramentas do complemento, |
Padrão Uri
A configuração de cada padrão de URL que aciona uma visualização de link.
Representação JSON |
---|
{ "hostPattern": string, "pathPrefix": string } |
Campos | |
---|---|
hostPattern |
Obrigatório para cada padrão de URL a ser visualizado. O domínio do padrão de URL. O complemento visualiza os links que contêm esse domínio no URL. Para visualizar links de um subdomínio específico, como Por exemplo, |
pathPrefix |
Opcional. O caminho que anexa o domínio do Por exemplo, se o padrão do host de URL for Para corresponder a todos os URLs no domínio do padrão do host, deixe |
PlanilhasAddOnManifest
Propriedades que personalizam a aparência e a execução de um complemento do Planilhas Google.
Representação JSON |
---|
{ "homepageTrigger": { object ( |
Campos | |
---|---|
homepageTrigger |
Se presente, modifica a configuração de |
onFileScopeGrantedTrigger |
Endpoint a ser executado quando a autorização do escopo do arquivo for concedida para este par documento/usuário. |
PlanilhasExtensionPoint
Formato comum para declarar os acionadores de um complemento do Planilhas.
Representação JSON |
---|
{ "runFunction": string } |
Campos | |
---|---|
runFunction |
Obrigatório. O endpoint a ser executado quando esse ponto de extensão for ativado. |
SlidesAddOnManifest
Propriedades que personalizam a aparência e a execução de um complemento do Apresentações Google.
Representação JSON |
---|
{ "homepageTrigger": { object ( |
Campos | |
---|---|
homepageTrigger |
Se presente, modifica a configuração de |
onFileScopeGrantedTrigger |
Endpoint a ser executado quando a autorização do escopo do arquivo for concedida para este par documento/usuário. |
SlidesExtensionPoint
Formato comum para declarar os acionadores de um complemento do Apresentações.
Representação JSON |
---|
{ "runFunction": string } |
Campos | |
---|---|
runFunction |
Obrigatório. O endpoint a ser executado quando esse ponto de extensão for ativado. |
Opções de HTTP
Opções para enviar solicitações a complementos de HTTP
.
Representação JSON |
---|
{
"authorizationHeader": enum ( |
Campos | |
---|---|
authorizationHeader |
Configuração do token enviado no cabeçalho de autorização |
CabeçalhodeHttpHttp
Cabeçalho de autorização enviado em solicitações do complemento HTTP
.
Enums | |
---|---|
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED |
Valor padrão, equivalente a SYSTEM_ID_TOKEN . |
SYSTEM_ID_TOKEN |
Envie um token de ID para a conta de serviço do sistema do complemento do Google Workspace específico do projeto (padrão). |
USER_ID_TOKEN |
Envie um token de ID para o usuário final. |
NONE |
Não envie um cabeçalho de autenticação. |
Métodos |
|
---|---|
|
Cria uma implantação com o nome e a configuração especificados. |
|
Exclui a implantação com o nome fornecido. |
|
Recebe a implantação com o nome especificado. |
|
Recebe o status de instalação de uma implantação de teste. |
|
Instala uma implantação na sua conta para teste. |
|
Lista todas as implantações em um projeto específico. |
|
Cria ou substitui uma implantação com o nome especificado. |
|
Desinstala uma implantação de teste na conta do usuário. |