Recurso del manifiesto de Gmail

La configuración de recursos que se usa para definir el contenido y el comportamiento del complemento de Google Workspace en Gmail. Los manifiestos del complemento de Google Workspace deben tener todos los componentes marcados como Obligatorios si extienden Gmail.

Gmail

La configuración del manifiesto del complemento de Google Workspace para las extensiones de Gmail Consulta Cómo extender Gmail con complementos de Google Workspace para obtener más información.

Representación JSON
{
  "authorizationCheckFunction": string,
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "homepageTrigger": {
    object (HomepageTrigger)
  }
}
Campos
authorizationCheckFunction

string

Obsoleto. Es el nombre de una función de Apps Script que realiza verificaciones de requisitos de autorización de terceros. Se llama a esta función antes de cada invocación del complemento de Google Workspace.

Esta función dejó de estar disponible para evitar una latencia de ejecución innecesaria. En cambio, el complemento debe arrojar una excepción desde la invocación principal, como se muestra en este ejemplo.

composeTrigger

object (ComposeTrigger)

Obligatorio para las acciones de redacción. Define el conjunto de IUs disponibles para el usuario mientras redactas un correo electrónico.

Consulta Cómo extender la IU de redacción con acciones de redacción para obtener más detalles.

contextualTriggers[]

object (ContextualTrigger)

Obligatorio. Una lista de activadores que se activan cuando se abre un mensaje en Gmail. Cuando se activa el activador, ejecuta una función específica de Apps Script, por lo general, para crear tarjetas nuevas y actualizar la IU.
homepageTrigger

object (HomepageTrigger)

Especificación de la función del activador para crear la página principal del complemento en el host de Gmail. Esto anula addOns.common.homepageTrigger.

ComposeTrigger

Es la configuración de una acción de composición. Consulta Cómo extender la IU de Compose para obtener más información.

Representación JSON
{
  "draftAccess": string,
  "selectActions": [
    {
      object (SelectAction)
    }
  ]
}
Campos
draftAccess

string

Define el nivel de acceso a datos disponible para una función del activador de Compose. Las opciones válidas son las siguientes:

  • NONE es el parámetro de configuración predeterminado. Esto hace que el objeto de evento que se pasó a la función del activador de Compose esté casi vacío.
  • METADATA, que propaga el objeto de evento que se pasó a la función del activador de redacción con las listas de destinatarios del mensaje Esta configuración requiere que el complemento incluya el permiso gmail.addons.current.message.metadata.
selectActions[]

object (SelectAction)

Es una lista de acciones de Compose que crean IUs de Compose. Sin embargo, esta lista está limitada a una sola acción por complemento. La acción de redacción tiene un ícono correspondiente que se presenta en la ventana de redacción de Gmail. El ícono se especifica mediante gmail.logoUrl.

ContextualTrigger

Es la configuración de un activador que se activa cuando el usuario abre un mensaje de Gmail y ese mensaje cumple con ciertos criterios. Consulta Cómo extender la IU del mensaje para obtener más información.

Representación JSON
{
  "onTriggerFunction": string,
  "unconditional": {},
}
Campos
onTriggerFunction

string

Obligatorio para cada activador contextual. Es el nombre de la función de Apps Script que se ejecuta cuando se activa el activador.

Consulta Función de activador contextual para obtener detalles sobre cómo definir esta función.

unconditional

object

Obligatorio para cada activador contextual. Se usa para especificar que el activador contextual se active para todos los mensajes de Gmail cuando se abren. Por el momento, esta es la única opción, por lo que siempre debería ser un objeto vacío.

SelectAction

La configuración de la acción de composición que define qué función se ejecutará cuando el usuario seleccione la acción de redacción.

Representación JSON
{
  "runFunction": string,
  "text": string
}
Campos
runFunction

string

Obligatorio para las acciones de redacción. Es el nombre de la función de Apps Script que se ejecuta cuando se selecciona esta acción de redacción. Esta función del activador de Compose compila la IU de Compose del complemento.

Consulta Función del activador de Compose para obtener más detalles.

text

string

Obligatorio para las acciones de redacción. Es una descripción textual breve de esta acción de redacción.