- Recurso: Implementación
- AddOns
- 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: Deployment
Una implementación de complemento de Google Workspace
Representación JSON |
---|
{
"name": string,
"oauthScopes": [
string
],
"addOns": {
object ( |
Campos | |
---|---|
name |
El nombre del recurso de implementación. Ejemplo: |
oauthScopes[] |
Es la lista de permisos de OAuth de Google para los que se solicita el consentimiento del usuario final antes de ejecutar un extremo de complemento. |
addOns |
La configuración del complemento de Google Workspace |
etag |
El servidor calcula este valor según la versión de la implementación almacenada, y se puede enviar 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 a 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. |
httpOptions |
Opciones para enviar solicitudes a extremos HTTP complementarios |
CommonAddOnManifest
Configuración de complementos que se comparte entre todas las aplicaciones de host del complemento
Representación JSON |
---|
{ "name": string, "logoUrl": string, "layoutProperties": { object ( |
Campos | |
---|---|
name |
Obligatorio. Es el nombre visible del complemento. |
logoUrl |
Obligatorio. La URL de la imagen del logotipo que se muestra en la barra de herramientas del complemento. |
layoutProperties |
Propiedades de diseño comunes para las tarjetas de complementos |
addOnWidgetSet |
Los widgets que se usan en el complemento. Si no se especifica este campo, se usa el conjunto predeterminado. |
useLocaleFromApp |
Determina si se debe pasar información de configuración regional desde la app host. |
homepageTrigger |
Define un extremo que se ejecutará en cualquier contexto y en cualquier host. Las tarjetas que genere 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. |
universalActions[] |
Define una lista de puntos de extensión en el menú de acciones universales que sirve como menú de configuración para el complemento. El punto de extensión puede ser una URL de vínculo para abrir o un extremo que se ejecutará como envío de formulario. |
openLinkUrlPrefixes |
Una acción de OpenLink solo puede usar una URL con un esquema |
LayoutProperties
Propiedades de diseño de tarjetas compartidas en todas las aplicaciones de host de complementos
Representación JSON |
---|
{ "primaryColor": string, "secondaryColor": string, "useNewMaterialDesign": boolean } |
Campos | |
---|---|
primaryColor |
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. |
secondaryColor |
El color secundario del complemento Establece el color de los botones. Si se configura el color principal, pero no el secundario, el secundario es el mismo que el principal. Si no se establecen un color primario ni un color secundario, se usa el valor predeterminado proporcionado por el framework. |
useNewMaterialDesign |
Habilita material design para las tarjetas. |
AddOnWidgetSet
El subconjunto de widgets que usa un complemento.
Representación JSON |
---|
{
"usedWidgets": [
enum ( |
Campos | |
---|---|
usedWidgets[] |
Es la lista de widgets que se usan en un complemento. |
WidgetType
El tipo de widget WIDGET_TYPE_UNSPECIFIED
es el conjunto de widgets básicos.
Enumeradores | |
---|---|
WIDGET_TYPE_UNSPECIFIED |
Es el widget predeterminado establecido. |
DATE_PICKER |
El selector de fecha. |
STYLED_BUTTONS |
Los botones con estilo incluyen botones rellenos y botones desactivados. |
PERSISTENT_FORMS |
Los formularios persistentes permiten conservar valores de formulario durante las acciones. |
FIXED_FOOTER |
Pie de página fijo en una tarjeta. |
UPDATE_SUBJECT_AND_RECIPIENTS |
Actualizar 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 | |
---|---|
runFunction |
Obligatorio. 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 la vista personalizada de la página principal de un complemento está inhabilitada, se proporcionará una tarjeta genérica de resumen para los usuarios. |
UniversalActionExtensionPoint
Formato para declarar un punto de extensión de un elemento del menú de acciones 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 activa este punto de extensión; por ejemplo, "Agregar un contacto nuevo". |
Campo de unión action_type . Obligatorio. El tipo de acción admitido en un elemento del menú de acciones 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: |
|
openLink |
URL que abrirá la UniversalAction. |
runFunction |
Extremo que ejecuta UniversalAction. |
GmailAddOnManifest
Propiedades que personalizan el aspecto y la ejecución de un complemento de Gmail
Representación JSON |
---|
{ "homepageTrigger": { object ( |
Campos | |
---|---|
homepageTrigger |
Define un extremo que se ejecutará en contextos que no coinciden con un activador contextual declarado. Las tarjetas que genere esta función siempre estarán disponibles para el usuario, pero el contenido contextual podría reemplazarlas cuando este complemento declare activadores más segmentados. Si está presente, anula la configuración de |
contextualTriggers[] |
Define el conjunto de condiciones que activan el complemento. |
universalActions[] |
Define un conjunto de acciones universales para el complemento. El usuario activa acciones universales desde el menú de la barra de herramientas del complemento. |
composeTrigger |
Define el activador de hora de redacción para un complemento de hora de redacción. Este es el activador que hace que un complemento realice acciones cuando el usuario redacta un correo electrónico. Todos los complementos de tiempo de redacción deben tener el alcance |
authorizationCheckFunction |
Es el nombre de un extremo que verifica que el complemento cuente con todas las autorizaciones de terceros requeridas mediante un sondeo en las APIs de terceros. Si el sondeo falla, la función debe arrojar 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 el activador se activa, ejecuta un extremo específico, por lo general, para crear tarjetas nuevas y actualizar la IU.
Representación JSON |
---|
{ "onTriggerFunction": string, // Union field |
Campos | |
---|---|
onTriggerFunction |
Obligatorio. 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 un mensaje de correo electrónico. |
UnconditionalTrigger
Este tipo no tiene campos.
Un activador que se activa cuando se abre un mensaje de correo electrónico.
UniversalAction
Una acción que siempre está disponible en el menú de la barra de herramientas de complementos, independientemente del contexto del mensaje.
Representación JSON |
---|
{ "text": string, // Union field |
Campos | |
---|---|
text |
Obligatorio. 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 invoca la acción. Las direcciones (action_type ) solo pueden ser una de las siguientes opciones: |
|
openLink |
Un vínculo que Gmail abre cuando el usuario activa la acción. |
runFunction |
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 hora de redacción. Son acciones que los usuarios pueden activar en un complemento de hora de redacción. |
draftAccess |
Define el nivel de acceso a los datos cuando se activa un complemento de hora de redacción. |
MenuItemExtensionPoint
Formato común para declarar un botón o elemento de menú que aparece dentro de una app host.
Representación JSON |
---|
{ "runFunction": string, "label": string, "logoUrl": string } |
Campos | |
---|---|
runFunction |
Obligatorio. 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ó al activar este punto de extensión. Por ejemplo, "Insertar factura". |
logoUrl |
La URL de la imagen del logotipo que se muestra en la barra de herramientas del complemento. Si no la estableces, la configuración predeterminada será 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 Compose.
Enumeradores | |
---|---|
UNSPECIFIED |
Valor predeterminado cuando no se configura ninguna opción para draftaccess. |
NONE |
El activador de redacción no puede acceder a ningún dato del borrador cuando se activa un complemento de redacción. |
METADATA |
Otorga al activador de redacción el permiso para acceder a los metadatos del borrador cuando se activa un complemento de redacción. Esto incluye la lista de público, como la lista de Para y Cc de un borrador de mensaje. |
DriveAddOnManifest
Propiedades que personalizan el aspecto y la ejecución de un complemento de Drive
Representación JSON |
---|
{ "homepageTrigger": { object ( |
Campos | |
---|---|
homepageTrigger |
Si está presente, anula la configuración de |
onItemsSelectedTrigger |
Corresponde al comportamiento que se ejecuta cuando se seleccionan elementos en la vista de Drive en cuestión, 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 | |
---|---|
runFunction |
Obligatorio. 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 | |
---|---|
homepageTrigger |
Define un extremo que se ejecuta en contextos que no coinciden con un activador contextual declarado. Las tarjetas que genere 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, anula la configuración de |
conferenceSolution[] |
Define las soluciones de conferencia que proporciona este complemento. |
createSettingsUrlFunction |
Un extremo que se ejecutará y que crea una URL a la página de configuración del complemento |
eventOpenTrigger |
Un extremo que se activa cuando se abre un evento para verlo o editarlo. |
eventUpdateTrigger |
Un extremo que se activa cuando se actualiza el evento abierto. |
currentEventAccess |
Define el nivel de acceso a los datos cuando se activa un complemento de evento. |
ConferenceSolution
Define los valores relacionados con la conferencia.
Representación JSON |
---|
{ "onCreateFunction": string, "id": string, "name": string, "logoUrl": string } |
Campos | |
---|---|
onCreateFunction |
Obligatorio. El extremo al que se debe llamar cuando se deben crear los datos de la conferencia. |
id |
Obligatorio. Los IDs deben asignarse de manera única a todas las soluciones de conferencias dentro de un complemento; de lo contrario, se podría utilizar 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. El nombre visible de la solución de conferencia. |
logoUrl |
Obligatorio. La URL de la imagen del logotipo de la solución de conferencias. |
CalendarExtensionPoint
Formato común para declarar los activadores de un complemento de calendario
Representación JSON |
---|
{ "runFunction": string } |
Campos | |
---|---|
runFunction |
Obligatorio. El extremo que se ejecutará cuando se active este punto de extensión. |
EventAccess
Una enumeración que defina el nivel de activadores de eventos de acceso a los datos que requieren.
Enumeradores | |
---|---|
UNSPECIFIED |
El valor predeterminado cuando no se configura nada para eventAccess. |
METADATA |
Otorga permiso a los activadores de eventos para acceder a los metadatos de los eventos, como el ID de evento y el ID de calendario. |
READ |
Otorga a los activadores de eventos acceso a todos los campos de evento proporcionados, incluidos los metadatos, los asistentes y los datos de la conferencia. |
WRITE |
Otorga a los activadores de eventos acceso a los metadatos de los eventos y la posibilidad de realizar todas las acciones, como agregar asistentes y configurar datos de la conferencia. |
READ_WRITE |
Otorga a los activadores de eventos acceso a todos los campos de evento proporcionados, incluidos los datos de metadatos, asistentes y conferencias, y la capacidad de realizar todas las acciones. |
DocsAddOnManifest
Propiedades que personalizan el aspecto y la ejecución de un complemento de Documentos de Google
Representación JSON |
---|
{ "homepageTrigger": { object ( |
Campos | |
---|---|
homepageTrigger |
Si está presente, anula la configuración de |
onFileScopeGrantedTrigger |
Extremo que se ejecuta cuando se otorga la autorización de alcance de archivo para este par de documento/usuario. |
linkPreviewTriggers[] |
Una lista de puntos de extensión para obtener una vista previa de los vínculos en un documento de Documentos de Google. Si quieres conocer los detalles, consulta Cómo obtener una vista previa de vínculos con chips inteligentes. |
createActionTriggers[] |
Una lista de puntos de extensión para crear recursos de terceros desde 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 | |
---|---|
runFunction |
Obligatorio. El extremo que se ejecutará cuando se active este punto de extensión. |
LinkPreviewExtensionPoint
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 | |
---|---|
labelText |
Obligatorio. Es el texto de un chip inteligente de ejemplo que solicita a los usuarios que obtengan una vista previa del vínculo, como |
localizedLabelText |
Opcional. Mapa de Si la configuración regional de un usuario está presente en las claves del mapa, este verá la versión localizada de Es un objeto que contiene una lista de pares |
patterns[] |
Obligatorio. Un array de patrones de URL que activan el complemento para obtener una vista previa de los vínculos. |
runFunction |
Obligatorio. Extremo que se ejecuta cuando se activa la vista previa de un vínculo. |
logoUrl |
Opcional. El ícono que se muestra en el chip inteligente y en la tarjeta de vista previa. Si se omite, el complemento usa el ícono de la barra de herramientas, |
UriPattern
La configuración para cada patrón de URL que activa una vista previa del vínculo.
Representación JSON |
---|
{ "hostPattern": string, "pathPrefix": string } |
Campos | |
---|---|
hostPattern |
Es obligatorio para cada patrón de URL para la que se debe obtener una vista previa. Indica el dominio del patrón de URL. El complemento ofrece 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, |
pathPrefix |
Opcional. La ruta de acceso que agrega el dominio de Por ejemplo, si el patrón de host de URL es Para que todas las URL del dominio del patrón de host coincidan, deja |
CreateActionExtensionPoint
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 Crea 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 |
labelText |
Obligatorio. El texto que se muestra junto a un ícono para el punto de entrada de creación de recursos, como |
localizedLabelText |
Opcional. Mapa de Si la configuración regional de un usuario está presente en las claves del mapa, este verá la versión localizada de Es un objeto que contiene una lista de pares |
runFunction |
Obligatorio. Extremo que se ejecuta cuando se activa un flujo de trabajo de creación de recursos para crear un vínculo. |
logoUrl |
Opcional. Ícono que se muestra para el punto de entrada de creación de recursos. Si se omite, el menú usará el ícono de la barra de herramientas de tu complemento, |
SheetsAddOnManifest
Propiedades que personalizan el aspecto y la ejecución de un complemento de Hojas de cálculo de Google
Representación JSON |
---|
{ "homepageTrigger": { object ( |
Campos | |
---|---|
homepageTrigger |
Si está presente, anula la configuración de |
onFileScopeGrantedTrigger |
Extremo que se ejecuta cuando se otorga la autorización de alcance de archivo para este par de documento/usuario. |
linkPreviewTriggers[] |
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. Si quieres conocer los detalles, consulta Cómo obtener una vista previa de vínculos con chips inteligentes. |
SheetsExtensionPoint
Formato común para declarar los activadores de un complemento de Hojas de cálculo.
Representación JSON |
---|
{ "runFunction": string } |
Campos | |
---|---|
runFunction |
Obligatorio. El extremo que se ejecutará cuando se active este punto de extensión. |
SlidesAddOnManifest
Propiedades que personalizan el aspecto y la ejecución de un complemento de Presentaciones de Google
Representación JSON |
---|
{ "homepageTrigger": { object ( |
Campos | |
---|---|
homepageTrigger |
Si está presente, anula la configuración de |
onFileScopeGrantedTrigger |
Extremo que se ejecuta cuando se otorga la autorización de alcance de archivo para este par de documento/usuario. |
linkPreviewTriggers[] |
Una lista de puntos de extensión para obtener una vista previa de los vínculos en un documento de Presentaciones de Google. Si quieres conocer los detalles, consulta Cómo obtener una vista previa de vínculos con chips inteligentes. |
SlidesExtensionPoint
Formato común para declarar los activadores de un complemento de Presentaciones
Representación JSON |
---|
{ "runFunction": string } |
Campos | |
---|---|
runFunction |
Obligatorio. El extremo que se ejecutará cuando se active este punto de extensión. |
HttpOptions
Opciones para enviar solicitudes a extremos HTTP
adicionales.
Representación JSON |
---|
{
"authorizationHeader": enum ( |
Campos | |
---|---|
authorizationHeader |
Configuración del token enviado en el encabezado de autorización |
HttpAuthorizationHeader
Encabezado de autorización enviado en solicitudes HTTP
de complemento.
Enumeradores | |
---|---|
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED |
Valor predeterminado, que equivale 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ífico 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 dado. |
|
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 realizar pruebas. |
|
Enumera 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. |