Package google.apps.script.type

Índice

AddOnWidgetSet

El subconjunto de widgets que usa un complemento.

Campos
usedWidgets[]

WidgetType

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.
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.

CommonAddOnManifest

Configuración de complementos que se comparte entre todas las aplicaciones de host del complemento

Campos
name

string

Obligatorio. Es el nombre visible del complemento.
logoUrl

string

Obligatorio. La URL de la imagen del logotipo que se muestra en la barra de herramientas del complemento.
layoutProperties

LayoutProperties

Propiedades de diseño comunes para las tarjetas de complementos
addOnWidgetSet

AddOnWidgetSet

Los widgets que se usan en el complemento. Si no se especifica este campo, se usa el conjunto predeterminado.
useLocaleFromApp

bool

Determina si se debe pasar información de configuración regional desde la app host.
homepageTrigger

HomepageExtensionPoint

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[]

UniversalActionExtensionPoint

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

ListValue

Una acción de OpenLink solo puede usar una URL con un esquema HTTPS, MAILTO o TEL. En el caso de los vínculos de HTTPS, la URL también debe coincidir con uno de los prefijos especificados en la lista de entidades permitidas. Si el prefijo omite el esquema, se supone que es HTTPS. Los vínculos HTTP se reescriben automáticamente en vínculos HTTPS.

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ú @.

Campos
id

string

Obligatorio. Es el ID único para diferenciar este punto de extensión. El ID puede tener hasta 64 caracteres y debe tener el formato [a-zA-Z0-9-]+.
labelText

string

Obligatorio. El texto que se muestra junto a un ícono para el punto de entrada de creación de recursos, como Create support case. Este texto es estático y se muestra antes de que los usuarios ejecuten el complemento.
localizedLabelText

map<string, string>

Opcional. Mapa de labelText para localizar a otros idiomas. Aplica formato al idioma en ISO 639 y al país o región en ISO 3166, separados por un guion -. Por ejemplo, en-US.

Si la configuración regional de un usuario está presente en las claves del mapa, este verá la versión localizada de labelText.
runFunction

string

Obligatorio. Extremo que se ejecuta cuando se activa un flujo de trabajo de creación de recursos para crear un vínculo.
logoUrl

string

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, logoUrl.

HomepageExtensionPoint

Formato común para declarar la vista de la página principal de un complemento.

Campos
runFunction

string

Obligatorio. El extremo que se ejecutará cuando se active este punto de extensión.
enabled

BoolValue

Opcional. Si se establece en false, desactiva la vista de la página principal en este contexto.

Si no se establece, el valor predeterminado es true.

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.

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.

HttpOptions

Opciones para enviar solicitudes a extremos HTTP adicionales.

Campos
authorizationHeader

HttpAuthorizationHeader

Configuración del token enviado en el encabezado de autorización HTTP.

LayoutProperties

Propiedades de diseño de tarjetas compartidas en todas las aplicaciones de host de complementos

Campos
primaryColor

string

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

string

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

bool

Habilita material design para las tarjetas.

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.

Campos
labelText

string

Obligatorio. Es el texto de un chip inteligente de ejemplo que solicita a los usuarios que obtengan una vista previa del vínculo, como Example: Support case. Este texto es estático y se muestra antes de que los usuarios ejecuten el complemento.
localizedLabelText

map<string, string>

Opcional. Mapa de labelText para localizar a otros idiomas. Aplica formato al idioma en ISO 639 y al país o región en ISO 3166, separados por un guion -. Por ejemplo, en-US.

Si la configuración regional de un usuario está presente en las claves del mapa, este verá la versión localizada de labelText.
patterns[]

UriPattern

Obligatorio. Un array de patrones de URL que activan el complemento para obtener una vista previa de los vínculos.
runFunction

string

Obligatorio. Extremo que se ejecuta cuando se activa la vista previa de un vínculo.
logoUrl

string

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, logoUrl.

Formato común para declarar un botón o elemento de menú que aparece dentro de una app host.

Campos
runFunction

string

Obligatorio. El extremo que se ejecutará cuando se active este punto de extensión.
label

string

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

string

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.

UniversalActionExtensionPoint

Formato para declarar un punto de extensión de un elemento del menú de acciones universal.

Campos
label

string

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:
runFunction

string

Extremo que ejecuta UniversalAction.

UriPattern

La configuración para cada patrón de URL que activa una vista previa del vínculo.

Campos
hostPattern

string

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 subdomain.example.com, incluye el subdominio. Para obtener una vista previa de los vínculos de todo el dominio, especifica un carácter comodín y un asterisco (*) como subdominio.

Por ejemplo, *.example.com coincide con subdomain.example.com y another.subdomain.example.com.
pathPrefix

string

Opcional. La ruta de acceso que agrega el dominio de hostPattern.

Por ejemplo, si el patrón de host de URL es support.example.com, ingresa cases para que coincida con las URLs de los casos alojados en support.example.com/cases/.

Para que todas las URL del dominio del patrón de host coincidan, deja pathPrefix vacío.