- Recurso: Implementación
- Complementos
- CommonAddOnManifest
- LayoutProperties
- AddOnWidgetSet
- WidgetType
- HomepageExtensionPoint
- UniversalActionExtensionPoint
- GmailAddOnManifest
- ContextualTrigger
- UnconditionalTrigger
- UniversalAction
- ComposeTrigger
- MenuItemExtensionPoint
- DraftAccess
- DriveAddOnManifest
- DriveExtensionPoint
- CalendarAddOnManifest
- ConferenceSolution
- CalendarExtensionPoint
- EventAccess
- DocsAddOnManifest
- DocsExtensionPoint
- LinkPreviewExtensionPoint
- UriPattern
- CreateActionExtensionPoint
- SheetsAddOnManifest
- SheetsExtensionPoint
- SlidesAddOnManifest
- SlidesExtensionPoint
- HttpOptions
- HttpAuthorizationHeader
- Métodos
Recurso: Implementación
Una implementación de complemento de Google Workspace
Representación JSON |
---|
{
"name": string,
"oauthScopes": [
string
],
"addOns": {
object ( |
Campos | |
---|---|
name |
Es el nombre del recurso de implementación. Ejemplo: |
oauth |
Es la lista de permisos de OAuth de Google para los que se debe solicitar el consentimiento del usuario final antes de ejecutar un extremo de complemento. |
add |
La configuración del complemento de Google Workspace |
etag |
El servidor calcula este valor en función de la versión de la implementación en el almacenamiento y es posible que se envíe en las solicitudes de actualización y eliminación para garantizar que el cliente tenga un valor actualizado antes de continuar. |
AddOns
Una configuración de complemento de Google Workspace
Representación JSON |
---|
{ "common": { object ( |
Campos | |
---|---|
common |
Configuración común en todos los complementos de Google Workspace. |
gmail |
Configuración del complemento de Gmail. |
drive |
Configuración del complemento de Drive. |
calendar |
Configuración del complemento de Calendario. |
docs |
Configuración del complemento de Documentos. |
sheets |
Configuración del complemento de Hojas de cálculo. |
slides |
Configuración del complemento de Presentaciones. |
http |
Opciones para enviar solicitudes a extremos HTTP de complementos |
CommonAddOnManifest
Configuración del complemento que se comparte en todas las aplicaciones host del complemento.
Representación JSON |
---|
{ "name": string, "logoUrl": string, "layoutProperties": { object ( |
Campos | |
---|---|
name |
Obligatorio. El nombre visible del complemento. |
logo |
Obligatorio. La URL de la imagen del logotipo que se muestra en la barra de herramientas de complementos. |
layout |
Propiedades de diseño comunes para las tarjetas de complementos |
add |
Los widgets que se usan en el complemento Si no se especifica este campo, se usa el conjunto predeterminado. |
use |
Establece si se debe pasar información de configuración regional desde la app host. |
homepage |
Define un extremo que se ejecutará en cualquier contexto y en cualquier host. Cualquier tarjeta que genere esta función siempre estará disponible para el usuario, pero es posible que el contenido contextual las eclipse si este complemento declara activadores más específicos. |
universal |
Define una lista de puntos de extensión en el menú de acciones universales que sirve como menú de configuración del complemento. El punto de extensión puede ser una URL de vínculo para abrir o un extremo para ejecutar como envío de formulario. |
open |
Una acción de OpenLink solo puede usar una URL con un esquema |
LayoutProperties
Propiedades del diseño de la tarjeta que se comparten en todas las aplicaciones host del complemento
Representación JSON |
---|
{ "primaryColor": string, "secondaryColor": string, "useNewMaterialDesign": boolean } |
Campos | |
---|---|
primary |
Es el color principal del complemento. Establece el color de la barra de herramientas. Si no se establece un color primario, se usa el valor predeterminado que proporciona el framework. |
secondary |
El color secundario del complemento. Establece el color de los botones. Si se establece el color primario, pero no se establece el color secundario, este será el mismo que el color primario. Si no se establece el color primario ni el secundario, se usa el valor predeterminado que proporciona el framework. |
use |
Habilita Material Design para tarjetas. |
AddOnWidgetSet
Es el subconjunto de widgets que usa un complemento.
Representación JSON |
---|
{
"usedWidgets": [
enum ( |
Campos | |
---|---|
used |
Es la lista de widgets que se usan en un complemento. |
WidgetType
Es el tipo de widget. WIDGET_TYPE_UNSPECIFIED
es el conjunto de widgets básicos.
Enumeraciones | |
---|---|
WIDGET_TYPE_UNSPECIFIED |
El conjunto de widgets predeterminado. |
DATE_PICKER |
El selector de fecha. |
STYLED_BUTTONS |
Los botones con diseño incluyen botones rellenos y botones desactivados. |
PERSISTENT_FORMS |
Los formularios persistentes permiten conservar los valores de los formularios durante las acciones. |
FIXED_FOOTER |
Pie de página fijo de una tarjeta. |
UPDATE_SUBJECT_AND_RECIPIENTS |
Actualiza el asunto y los destinatarios de un borrador. |
GRID_WIDGET |
El widget de cuadrícula |
ADDON_COMPOSE_UI_ACTION |
Una acción del complemento de Gmail que se aplica a la IU de redacción del complemento. |
HomepageExtensionPoint
Formato común para declarar la vista de la página principal de un complemento.
Representación JSON |
---|
{ "runFunction": string, "enabled": boolean } |
Campos | |
---|---|
run |
Obligatorio. Es el extremo que se ejecutará cuando se active este punto de extensión. |
enabled |
Opcional. Si se establece en Si no se establece, el valor predeterminado es Si se inhabilita la vista de la página principal personalizada de un complemento, se proporciona una tarjeta de descripción general genérica para los usuarios. |
UniversalActionExtensionPoint
Es el formato para declarar un punto de extensión de elemento de menú de acción universal.
Representación JSON |
---|
{ "label": string, // Union field |
Campos | |
---|---|
label |
Obligatorio. Es un texto visible para el usuario que describe la acción que se realizó cuando se activó este punto de extensión, por ejemplo, "Agregar un contacto nuevo". |
Campo de unión action_type . Obligatorio. Es el tipo de acción admitido en un elemento de menú de acción universal. Puede ser un vínculo para abrir o un extremo para ejecutar. Las direcciones (action_type ) solo pueden ser una de las siguientes opciones: |
|
open |
URL que abrirá UniversalAction. |
run |
Es el extremo que ejecutará UniversalAction. |
GmailAddOnManifest
Propiedades que personalizan el aspecto y la ejecución de un complemento de Gmail
Representación JSON |
---|
{ "homepageTrigger": { object ( |
Campos | |
---|---|
homepage |
Define un extremo que se ejecutará en contextos que no coincidan con un activador contextual declarado. Las tarjetas que genera esta función siempre estarán disponibles para el usuario, pero es posible que el contenido contextual las eclipse cuando este complemento declare activadores más segmentados. Si está presente, esta opción anula la configuración de |
contextual |
Define el conjunto de condiciones que activan el complemento. |
universal |
Define un conjunto de acciones universales para el complemento. El usuario activa acciones universales desde el menú de la barra de herramientas del complemento. |
compose |
Define el activador de tiempo de composición para un complemento de tiempo de composición. Este es el activador que hace que un complemento realice acciones cuando el usuario redacta un correo electrónico. Todos los complementos de hora de redacción deben tener el permiso |
authorization |
Es el nombre de un extremo que verifica que el complemento tenga todas las autorizaciones de terceros necesarias a través de la comprobación de las APIs de terceros. Si la prueba falla, la función debe generar una excepción para iniciar el flujo de autorización. Se llama a esta función antes de cada invocación del complemento para garantizar una experiencia del usuario fluida. |
ContextualTrigger
Define un activador que se activa cuando el correo electrónico abierto cumple con un criterio específico. Cuando se activa el activador, se ejecuta un extremo específico, por lo general, para crear tarjetas nuevas y actualizar la IU.
Representación JSON |
---|
{ "onTriggerFunction": string, // Union field |
Campos | |
---|---|
on |
Obligatorio. Es el nombre del extremo al que se debe llamar cuando un mensaje coincide con el activador. |
Campo de unión trigger . El tipo de activador determina las condiciones que usa Gmail para mostrar el complemento. Las direcciones (trigger ) solo pueden ser una de las siguientes opciones: |
|
unconditional |
Los activadores no condicionales se ejecutan cuando se abre cualquier mensaje de correo electrónico. |
UnconditionalTrigger
Este tipo no tiene campos.
Es un activador que se activa cuando se abre cualquier mensaje de correo electrónico.
UniversalAction
Es una acción que siempre está disponible en el menú de la barra de herramientas del complemento, independientemente del contexto del mensaje.
Representación JSON |
---|
{ "text": string, // Union field |
Campos | |
---|---|
text |
Obligatorio. Es un texto visible para el usuario que describe la acción, por ejemplo, "Agregar un contacto nuevo". |
Campo de unión action_type . El tipo de acción determina el comportamiento de Gmail cuando el usuario la invoca. Las direcciones (action_type ) solo pueden ser una de las siguientes opciones: |
|
open |
Es un vínculo que Gmail abre cuando el usuario activa la acción. |
run |
Un extremo al que se llama cuando el usuario activa la acción. Consulta la guía de acciones universales para obtener más detalles. |
ComposeTrigger
Un activador que se activa cuando el usuario redacta un correo electrónico.
Representación JSON |
---|
{ "actions": [ { object ( |
Campos | |
---|---|
actions[] |
Define el conjunto de acciones para un complemento de tiempo de composición. Estas son acciones que los usuarios pueden activar en un complemento de tiempo de composición. |
draft |
Define el nivel de acceso a los datos cuando se activa un complemento de tiempo de composición. |
MenuItemExtensionPoint
Formato común para declarar un elemento de menú o un botón que aparece dentro de una app host.
Representación JSON |
---|
{ "runFunction": string, "label": string, "logoUrl": string } |
Campos | |
---|---|
run |
Obligatorio. Es el extremo que se ejecutará cuando se active este punto de extensión. |
label |
Obligatorio. Es un texto visible para el usuario que describe la acción que se realizó cuando se activó este punto de extensión. Por ejemplo, "Insertar factura". |
logo |
Es la URL de la imagen del logotipo que se muestra en la barra de herramientas del complemento. Si no se establece, se establece de forma predeterminada en la URL del logotipo principal del complemento. |
DraftAccess
Una enumeración que define el nivel de acceso a los datos que requiere el activador de composición
Enumeraciones | |
---|---|
UNSPECIFIED |
Valor predeterminado cuando no hay nada configurado para draftaccess. |
NONE |
El activador de composición no puede acceder a ningún dato del borrador cuando se activa un complemento de composición. |
METADATA |
Otorga al activador de composición el permiso para acceder a los metadatos del borrador cuando se activa un complemento de composición. Esto incluye la lista de público, como la lista Para y Cc de un borrador de mensaje. |
DriveAddOnManifest
Son propiedades que personalizan la apariencia y la ejecución de un complemento de Drive.
Representación JSON |
---|
{ "homepageTrigger": { object ( |
Campos | |
---|---|
homepage |
Si está presente, anula la configuración de |
on |
Corresponde al comportamiento que se ejecuta cuando se seleccionan elementos en la vista de Drive relevante, como la lista de documentos de Mi unidad. |
DriveExtensionPoint
Formato común para declarar los activadores de un complemento de Drive.
Representación JSON |
---|
{ "runFunction": string } |
Campos | |
---|---|
run |
Obligatorio. Es el extremo que se ejecutará cuando se active el punto de extensión. |
CalendarAddOnManifest
Propiedades que personalizan el aspecto y la ejecución de un complemento de Calendario.
Representación JSON |
---|
{ "homepageTrigger": { object ( |
Campos | |
---|---|
homepage |
Define un extremo que se ejecuta en contextos que no coinciden con un activador contextual declarado. Cualquier tarjeta que genere esta función siempre estará disponible para el usuario, pero es posible que el contenido contextual las eclipse si este complemento declara activadores más específicos. Si está presente, esta opción anula la configuración de |
conference |
Define las soluciones de conferencias que proporciona este complemento. Los complementos de conferencias de terceros solo se pueden compilar en Apps Script. |
create |
Un extremo para ejecutar que crea una URL a la página de configuración del complemento. |
event |
Un extremo que se activa cuando se abre un evento para su visualización o edición. |
event |
Es un extremo que se activa cuando se actualiza el evento abierto. |
event |
Es una configuración para un activador contextual que se activa cuando el usuario hace clic en el proveedor de archivos adjuntos del complemento en el menú desplegable Calendario. |
current |
Define el nivel de acceso a los datos cuando se activa un complemento de evento. |
ConferenceSolution
Define los valores relacionados con la conferencia. Los complementos de conferencias de terceros solo se pueden compilar en Apps Script.
Representación JSON |
---|
{ "onCreateFunction": string, "id": string, "name": string, "logoUrl": string } |
Campos | |
---|---|
on |
Obligatorio. El extremo al que se debe llamar cuando deben crearse los datos de la conferencia. |
id |
Obligatorio. Los IDs deben asignarse de forma única en las soluciones de conferencias dentro de un complemento. De lo contrario, es posible que se use la solución de conferencias incorrecta cuando se active el complemento. Si bien puedes cambiar el nombre visible de un complemento, no se debe cambiar el ID. |
name |
Obligatorio. Es el nombre visible de la solución de conferencias. |
logo |
Obligatorio. Es la URL de la imagen del logotipo de la solución de la conferencia. |
CalendarExtensionPoint
Formato común para declarar los activadores de un complemento de Calendario.
Representación JSON |
---|
{ "runFunction": string } |
Campos | |
---|---|
run |
Obligatorio. El extremo que se ejecutará cuando se active este punto de extensión. |
EventAccess
Es una enumeración que define el nivel de acceso a los datos que requieren los activadores de eventos.
Enumeraciones | |
---|---|
UNSPECIFIED |
Valor predeterminado cuando no hay nada configurado para eventAccess. |
METADATA |
Otorga a los activadores de eventos el permiso para acceder a sus metadatos, como el ID de evento y el ID de calendario. |
READ |
Otorga a los activadores de eventos acceso a todos los campos de eventos proporcionados, incluidos los metadatos, los asistentes y los datos de la conferencia. |
WRITE |
Otorga a los activadores de eventos acceso a sus metadatos y la capacidad de realizar todas las acciones, como agregar asistentes y configurar datos de conferencias. |
READ_WRITE |
Otorga a los activadores de evento acceso a todos los campos del evento proporcionados, incluidos los metadatos, los asistentes y los datos de la conferencia, además de la capacidad de realizar todas las acciones. |
DocsAddOnManifest
Propiedades que personalizan la apariencia y la ejecución de un complemento de Documentos de Google.
Representación JSON |
---|
{ "homepageTrigger": { object ( |
Campos | |
---|---|
homepage |
Si está presente, anula la configuración de |
on |
Extremo que se ejecutará cuando se otorgue la autorización de ámbito de archivo para este par de documento/usuario. |
link |
Es una lista de puntos de extensión para obtener vistas previas de vínculos en un documento de Documentos de Google. Para obtener más información, consulta Vínculos de vista previa con chips inteligentes. |
create |
Es una lista de puntos de extensión para crear recursos de terceros desde las aplicaciones de Google Workspace. Para obtener más información, consulta Crea recursos de terceros desde el menú @. |
DocsExtensionPoint
Formato común para declarar los activadores de un complemento de Documentos.
Representación JSON |
---|
{ "runFunction": string } |
Campos | |
---|---|
run |
Obligatorio. El extremo que se ejecutará cuando se active este punto de extensión. |
LinkPreviewExtensionPoint
Es la configuración de un activador que se activa cuando un usuario escribe o pega un vínculo de un servicio de terceros o que no es de Google en un archivo de Documentos, Hojas de cálculo o Presentaciones de Google.
Representación JSON |
---|
{
"labelText": string,
"localizedLabelText": {
string: string,
...
},
"patterns": [
{
object ( |
Campos | |
---|---|
label |
Obligatorio. Es el texto de un chip inteligente de ejemplo que les solicita a los usuarios que obtengan una vista previa del vínculo, como |
localized |
Opcional. Un mapa de Si la configuración regional de un usuario está presente en las claves del mapa, el usuario verá la versión localizada de Es un objeto que contiene una lista de pares |
patterns[] |
Obligatorio. Es un array de patrones de URL que activan el complemento para obtener una vista previa de los vínculos. |
run |
Obligatorio. Es el extremo que se ejecutará cuando se active una vista previa de vínculo. |
logo |
Opcional. Es el ícono que se muestra en el chip inteligente y la tarjeta de vista previa. Si se omite, el complemento usará su ícono de barra de herramientas, |
UriPattern
Es la configuración de cada patrón de URL que activa una vista previa de un vínculo.
Representación JSON |
---|
{ "hostPattern": string, "pathPrefix": string } |
Campos | |
---|---|
host |
Es obligatorio para que se muestre una vista previa de cada patrón de URL. Es el dominio del patrón de URL. El complemento muestra una vista previa de los vínculos que contienen este dominio en la URL. Para obtener una vista previa de los vínculos de un subdominio específico, como Por ejemplo, |
path |
Opcional. Es la ruta de acceso que agrega el dominio de Por ejemplo, si el patrón de host de URL es Para que coincidan todas las URLs en el dominio del patrón de host, deja |
CreateActionExtensionPoint
Es la configuración de un activador que se activa cuando un usuario invoca el flujo de trabajo de creación de recursos en una aplicación de Google Workspace. Para obtener más información, consulta Cómo crear recursos de terceros desde el menú @.
Representación JSON |
---|
{ "id": string, "labelText": string, "localizedLabelText": { string: string, ... }, "runFunction": string, "logoUrl": string } |
Campos | |
---|---|
id |
Obligatorio. Es el ID único para diferenciar este punto de extensión. El ID puede tener hasta 64 caracteres y debe tener el formato de |
label |
Obligatorio. El texto que se muestra junto a un ícono para el punto de entrada de creación de recursos, como |
localized |
Opcional. Un mapa de Si la configuración regional de un usuario está presente en las claves del mapa, el usuario verá la versión localizada de Es un objeto que contiene una lista de pares |
run |
Obligatorio. Extremo que se ejecutará cuando se active un flujo de trabajo de creación de recursos para crear un vínculo. |
logo |
Opcional. El ícono que se muestra para el punto de entrada de creación del recurso. Si se omite, el menú usará el ícono de la barra de herramientas de tu complemento, |
SheetsAddOnManifest
Son propiedades que personalizan la apariencia y la ejecución de un complemento de Hojas de cálculo de Google.
Representación JSON |
---|
{ "homepageTrigger": { object ( |
Campos | |
---|---|
homepage |
Si está presente, anula la configuración de |
on |
Extremo que se ejecutará cuando se otorgue la autorización de ámbito de archivo para este par de documento/usuario. |
link |
Una lista de puntos de extensión para obtener una vista previa de los vínculos en un documento de Hojas de cálculo de Google. Para conocer más detalles, consulta Cómo obtener una vista previa de vínculos con chips inteligentes. |
SheetsExtensionPoint
Es un formato común para declarar los activadores de un complemento de Hojas de cálculo.
Representación JSON |
---|
{ "runFunction": string } |
Campos | |
---|---|
run |
Obligatorio. Es el extremo que se ejecutará cuando se active este punto de extensión. |
SlidesAddOnManifest
Son propiedades que personalizan el aspecto y la ejecución de un complemento de Presentaciones de Google.
Representación JSON |
---|
{ "homepageTrigger": { object ( |
Campos | |
---|---|
homepage |
Si está presente, anula la configuración de |
on |
Extremo que se ejecutará cuando se otorgue la autorización de ámbito de archivo para este par de documento/usuario. |
link |
Es una lista de puntos de extensión para obtener vistas previas de vínculos en un documento de Presentaciones de Google. Para conocer más detalles, consulta Cómo obtener una vista previa de vínculos con chips inteligentes. |
SlidesExtensionPoint
Es un formato común para declarar los activadores de un complemento de Presentaciones.
Representación JSON |
---|
{ "runFunction": string } |
Campos | |
---|---|
run |
Obligatorio. Es el extremo que se ejecutará cuando se active este punto de extensión. |
HttpOptions
Opciones para enviar solicitudes a los extremos HTTP
de complementos.
Representación JSON |
---|
{
"authorizationHeader": enum ( |
Campos | |
---|---|
authorization |
Configuración del token que se envía en el encabezado de autorización |
HttpAuthorizationHeader
Encabezado de autorización enviado en solicitudes HTTP
de complemento.
Enumeraciones | |
---|---|
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED |
Es el valor predeterminado, equivalente a SYSTEM_ID_TOKEN . |
SYSTEM_ID_TOKEN |
Envía un token de ID para la cuenta de servicio del sistema del complemento de Google Workspace específica del proyecto (predeterminado). |
USER_ID_TOKEN |
Envía un token de ID para el usuario final. |
NONE |
No envíes un encabezado de autenticación. |
Métodos |
|
---|---|
|
Crea una implementación con el nombre y la configuración especificados. |
|
Borra la implementación con el nombre determinado. |
|
Obtiene la implementación con el nombre especificado. |
|
Obtiene el estado de instalación de una implementación de prueba. |
|
Instala una implementación en tu cuenta para probarla. |
|
Muestra una lista de todas las implementaciones de un proyecto en particular. |
|
Crea o reemplaza una implementación con el nombre especificado. |
|
Desinstala una implementación de prueba de la cuenta del usuario. |