Package google.apps.script.type

Índice

AddOnWidgetSet

Es el subconjunto de widgets que usa un complemento.

Campos
usedWidgets[]

WidgetType

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.

Enums
WIDGET_TYPE_UNSPECIFIED Es el conjunto de widgets predeterminado.
DATE_PICKER Es el selector de fecha.
STYLED_BUTTONS Los botones con diseño incluyen botones con relleno y botones desactivados.
PERSISTENT_FORMS Los formularios persistentes permiten conservar los valores del formulario durante las acciones.
UPDATE_SUBJECT_AND_RECIPIENTS Actualiza el asunto y los destinatarios de un borrador.
GRID_WIDGET Es el widget de cuadrícula.
ADDON_COMPOSE_UI_ACTION Es una acción del complemento de Gmail que se aplica a la IU de redacción del complemento.

CommonAddOnManifest

Es la configuración del complemento que se comparte en todas las aplicaciones host del complemento.

Campos
name

string

Obligatorio. Es el nombre visible del complemento.
logoUrl

string

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

LayoutProperties

Son propiedades de diseño comunes para las tarjetas de complementos.
addOnWidgetSet

AddOnWidgetSet

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

bool

Indica si se debe pasar la 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 podrían quedar eclipsadas por el contenido contextual cuando este complemento declare activadores más segmentados.
universalActions[]

UniversalActionExtensionPoint

Define una lista de puntos de extensión en el menú de acción universal 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. 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 como 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. Es un mapa de labelText para localizar en otros idiomas. Formatea el idioma en ISO 639 y el país o la 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, 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. Ícono que se muestra para el punto de entrada de creación de recursos. Si se omite, el menú usa el ícono de la barra de herramientas del complemento, logoUrl.

GranularOauthPermissionSupport

Indica si el complemento habilitó el consentimiento detallado de OAuth.

Enums
GRANULAR_OAUTH_PERMISSION_SUPPORT_UNSPECIFIED Es un valor predeterminado que no se debe usar.
OPT_IN El complemento está habilitado para el consentimiento detallado de OAuth.
OPT_OUT El complemento no participa del consentimiento detallado de OAuth.

HomepageExtensionPoint

Es el 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 configura en false, se desactiva la vista de la página principal en este contexto.

El valor predeterminado es true si no se configura.

Si se inhabilita la vista personalizada de la página principal de un complemento, se proporciona a los usuarios una tarjeta de descripción general genérica.

HttpAuthorizationHeader

Es el encabezado de autorización que se envía en las solicitudes HTTP del complemento.

Enums
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ífico del proyecto (opción predeterminada).
USER_ID_TOKEN Envía un token de ID para el usuario final.
NONE No envíes un encabezado de autenticación.

HttpOptions

Son las opciones para enviar solicitudes a los extremos HTTP del complemento.

Campos
authorizationHeader

HttpAuthorizationHeader

Es la configuración del token enviado en el encabezado de autorización HTTP.
granularOauthPermissionSupport

GranularOauthPermissionSupport

Indica si el complemento habilitó el consentimiento detallado de OAuth.

LayoutProperties

Son las propiedades de diseño de tarjetas que se comparten en todas las aplicaciones host del complemento.

Campos
primaryColor

string

Es el color principal del complemento. Establece el color de la barra de herramientas. Si no se establece un color principal, se usa el valor predeterminado que proporciona el framework.
secondaryColor

string

Es el color secundario del complemento. Establece el color de los botones. Si se configura el color principal, pero no el secundario, el color secundario será el mismo que el principal. Si no se configuran el color principal ni el secundario, se usa el valor predeterminado que proporciona el framework.
useNewMaterialDesign
(deprecated)

bool

Habilita el diseño de Material para las 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 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 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. Es un mapa de labelText para localizar en otros idiomas. Formatea el idioma en ISO 639 y el país o la 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, 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. Es el extremo que se ejecutará cuando se active una vista previa del vínculo.
logoUrl

string

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

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

Campos
runFunction

string

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

string

Obligatorio. Es el 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 configura, se establece de forma predeterminada la URL del logotipo principal del complemento.

UniversalActionExtensionPoint

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

Campos
label

string

Obligatorio. Es el texto visible para el usuario que describe la acción que se realiza cuando se activa 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 del vínculo.

Campos
hostPattern

string

Se requiere para cada patrón de URL que se quiera obtener una vista previa. 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, incluye el subdominio. 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 la URL es support.example.com, para que coincida con las URLs de los casos alojados en support.example.com/cases/, ingresa cases.

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