Package google.apps.script.type

Índice

AddOnWidgetSet

Es el subconjunto de widgets que usa un complemento.

Campos
usedWidgets[]

WidgetType

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.

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.
UPDATE_SUBJECT_AND_RECIPIENTS Actualizar el asunto y los destinatarios de un borrador
GRID_WIDGET El widget de cuadrícula
ADDON_COMPOSE_UI_ACTION Es una acción de complemento de Gmail que se aplica a la IU de redacción del complemento.

CommonAddOnManifest

Configuración del complemento que se comparte en todas las aplicaciones host del complemento.

Campos
name

string

Obligatorio. El nombre visible del complemento.
logoUrl

string

Obligatorio. La URL de la imagen del logotipo que se muestra en la barra de herramientas de complementos.
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

Establece 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 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.
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 para 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. Para los vínculos 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 HTTPS. Los vínculos HTTP se vuelven a escribir automáticamente en vínculos HTTPS.

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

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. Es 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. Un mapa de labelText para localizar a otros idiomas. Usa el formato ISO 639 para el idioma y el país o región según la norma 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, el usuario verá la versión localizada de labelText.
runFunction

string

Obligatorio. Es el extremo que se ejecutará cuando se active un flujo de trabajo de creación de recursos para crear un vínculo.
logoUrl

string

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

HomepageExtensionPoint

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

Campos
runFunction

string

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

BoolValue

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

Si no la estableces, el valor predeterminado es true.

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.

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ífico del proyecto (predeterminada).
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 los extremos HTTP de complementos.

Campos
authorizationHeader

HttpAuthorizationHeader

Configuración del token que se envía en el encabezado de autorización HTTP.

LayoutProperties

Propiedades de diseño de tarjeta que se comparten en todas las aplicaciones 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 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.
useNewMaterialDesign

bool

Habilita Material Design para tarjetas.

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.

Campos
labelText

string

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 Example: Support case. Este texto es estático y se muestra antes de que los usuarios ejecuten el complemento.
localizedLabelText

map<string, string>

Opcional. Un mapa de labelText para localizar a otros idiomas. Usa el formato ISO 639 para el idioma y el país o región según la norma 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, el usuario verá la versión localizada de labelText.
patterns[]

UriPattern

Obligatorio. Es 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 ejecutará cuando se active una vista previa del vínculo.
logoUrl

string

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

Es un formato común para declarar un elemento de menú o un botón que aparece en 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 realiza cuando se activa este punto de extensión. Por ejemplo, "Insertar factura".
logoUrl

string

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.

UniversalActionExtensionPoint

Es el formato para declarar un punto de extensión de elemento de menú de acción universal.

Campos
label

string

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

string

Es el extremo que ejecutará UniversalAction.

UriPattern

Es la configuración de cada patrón de URL que activa una vista previa de un vínculo.

Campos
hostPattern

string

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

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

string

Opcional. Es la ruta de acceso que agrega el dominio de hostPattern.

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

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