- 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 debe solicitar 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 en el almacenamiento y puede enviarse en 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. |
httpOptions |
Opciones para enviar solicitudes a extremos HTTP de complementos |
CommonAddOnManifest
Configuración del complemento que se comparte en todas las aplicaciones host de los complementos.
Representación JSON |
---|
{ "name": string, "logoUrl": string, "layoutProperties": { object ( |
Campos | |
---|---|
name |
Obligatorio. El nombre visible del complemento. |
logoUrl |
Obligatorio. La URL de la imagen del logotipo que se muestra en la barra de herramientas de complementos. |
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 |
Establece 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. 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. |
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 para 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 tarjeta que se comparten en todas las aplicaciones 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 establece el color primario, pero no se establece un color secundario, el color secundario es 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. |
useNewMaterialDesign |
Habilita Material Design para tarjetas. |
AddOnWidgetSet
El subconjunto de widgets que usa un complemento.
Representación JSON |
---|
{
"usedWidgets": [
enum ( |
Campos | |
---|---|
usedWidgets[] |
La lista de widgets que se usan en un complemento. |
WidgetType
El tipo de widget. WIDGET_TYPE_UNSPECIFIED
es el conjunto básico de widgets.
Enumeraciones | |
---|---|
WIDGET_TYPE_UNSPECIFIED |
El conjunto de widgets predeterminado. |
DATE_PICKER |
El selector de fecha. |
STYLED_BUTTONS |
Los botones con estilo incluyen botones con relleno y botones desactivados. |
PERSISTENT_FORMS |
Los formularios persistentes permiten la persistencia de los valores de formulario 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 | |
---|---|
runFunction |
Obligatorio. El extremo que se ejecutará cuando se active este punto de extensión. |
enabled |
Opcional. Si se establece en Si no la estableces, el valor predeterminado es Si la vista de la página principal personalizada de un complemento está inhabilitada, se les mostrará a los usuarios una tarjeta de resumen genérica. |
UniversalActionExtensionPoint
Es el formato para declarar un punto de extensión de elementos 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 activó 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á UniversalAction. |
runFunction |
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 | |
---|---|
homepageTrigger |
Define un extremo que se ejecutará 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 se eclipsen por el contenido contextual si este complemento declara activadores más orientados. Si está presente, esta opción 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 de complementos. |
composeTrigger |
Define el activador de tiempo de redacción para un complemento de tiempo 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 hora de redacción deben tener el permiso |
authorizationCheckFunction |
El nombre de un extremo que sondea las APIs de terceros para verificar que el complemento tenga todas las autorizaciones de terceros requeridas. Si el sondeo falla, la función debería 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 Gmail utiliza para mostrar el complemento. Las direcciones (trigger ) solo pueden ser una de las siguientes opciones: |
|
unconditional |
Los activadores incondicionales se ejecutan cuando se abre cualquier 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. 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 invoca la acción. Las direcciones (action_type ) solo pueden ser una de las siguientes opciones: |
|
openLink |
Es 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 tiempo de redacción. Son acciones que los usuarios pueden activar en un complemento de tiempo de redacción. |
draftAccess |
Define el nivel de acceso a los datos cuando se activa un complemento de tiempo de redacció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 | |
---|---|
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ó cuando se activó 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 de complementos. Si no la estableces, se utilizará de forma predeterminada 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 redacción no puede acceder a ningún dato del borrador cuando se activa un complemento de redacción. |
METADATA |
Otorga al activador de composición el permiso para acceder a los metadatos del borrador cuando se activa un complemento de Compose. Esto incluye la lista de público, como la lista 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, esta opción anula la configuración de |
onItemsSelectedTrigger |
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 | |
---|---|
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. 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 |
conferenceSolution[] |
Define las soluciones de conferencia que proporciona este complemento. |
createSettingsUrlFunction |
Un extremo para ejecutar 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 su visualización o edición. |
eventUpdateTrigger |
Un extremo que se activa cuando se actualiza el evento abierto |
eventAttachmentTrigger |
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. |
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 deben crearse los datos de la conferencia. |
id |
Obligatorio. Los IDs deben asignarse de forma única en las soluciones de conferencia de un complemento. De lo contrario, podría usarse una solución de conferencia 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 conferencia. |
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 define el nivel de nivel de requisitos que requieren los activadores de eventos de acceso a los datos.
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 evento acceso a todos los campos del evento 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 el aspecto y la ejecución de un complemento de Documentos de Google
Representación JSON |
---|
{ "homepageTrigger": { object ( |
Campos | |
---|---|
homepageTrigger |
Si está presente, esta opción anula la configuración de |
onFileScopeGrantedTrigger |
Extremo que se ejecutará cuando se otorgue autorización de alcance de archivo para este par 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. Para conocer más 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 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 | |
---|---|
runFunction |
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 de terceros 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 ejemplo de chip inteligente que les solicita a los usuarios una vista previa del vínculo, como |
localizedLabelText |
Opcional. Un mapa de Si la configuración regional de un usuario está presente en las claves del mapa, este verá la versión localizada del 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. |
runFunction |
Obligatorio. Extremo que se ejecutará cuando se active una vista previa del vínculo. |
logoUrl |
Opcional. El ícono que se muestra en el chip inteligente y la tarjeta de vista previa. Si se omite, el complemento usa el ícono de la barra de herramientas, |
UriPattern
La configuración de cada patrón de URL que activa una vista previa del vínculo.
Representación JSON |
---|
{ "hostPattern": string, "pathPrefix": string } |
Campos | |
---|---|
hostPattern |
Obligatorio para cada patrón de URL de vista previa. Es el dominio del patrón de URL. El complemento obtiene 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. 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 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. Un mapa de Si la configuración regional de un usuario está presente en las claves del mapa, este verá la versión localizada del Es un objeto que contiene una lista de pares |
runFunction |
Obligatorio. Extremo que se ejecutará cuando se active un flujo de trabajo de creación de recursos para crear un vínculo. |
logoUrl |
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
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, esta opción anula la configuración de |
onFileScopeGrantedTrigger |
Extremo que se ejecutará cuando se otorgue autorización de alcance de archivo para este par 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. Para conocer más 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, esta opción anula la configuración de |
onFileScopeGrantedTrigger |
Extremo que se ejecutará cuando se otorgue autorización de alcance de archivo para este par 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. Para conocer más 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
de complementos.
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.
Enumeraciones | |
---|---|
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED |
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 Authentication. |
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 realizar pruebas. |
|
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. |