REST Resource: projects.deployments

Recurso: Deployment

Una implementación de complemento de Google Workspace

Representación JSON
{
  "name": string,
  "oauthScopes": [
    string
  ],
  "addOns": {
    object (AddOns)
  },
  "etag": string
}
Campos
name

string

Es el nombre del recurso de la implementación. Ejemplo: projects/123/deployments/my_deployment.

oauthScopes[]

string

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

object (AddOns)

Es la configuración del complemento de Google Workspace.

etag

string

El servidor calcula este valor en función de la versión de la implementación en el almacenamiento 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

Es una configuración de complemento de Google Workspace.

Representación JSON
{
  "common": {
    object (CommonAddOnManifest)
  },
  "gmail": {
    object (GmailAddOnManifest)
  },
  "drive": {
    object (DriveAddOnManifest)
  },
  "calendar": {
    object (CalendarAddOnManifest)
  },
  "docs": {
    object (DocsAddOnManifest)
  },
  "meet": {
    object (MeetAddOnManifest)
  },
  "sheets": {
    object (SheetsAddOnManifest)
  },
  "slides": {
    object (SlidesAddOnManifest)
  },
  "httpOptions": {
    object (HttpOptions)
  }
}
Campos
common

object (CommonAddOnManifest)

Es la configuración común en todos los complementos de Google Workspace.

gmail

object (GmailAddOnManifest)

Configuración del complemento de Gmail.

drive

object (DriveAddOnManifest)

Configuración del complemento de Drive.

calendar

object (CalendarAddOnManifest)

Configuración del complemento de Calendario.

docs

object (DocsAddOnManifest)

Configuración del complemento de Documentos.

meet

object (MeetAddOnManifest)

Configuración del complemento de Meet.

sheets

object (SheetsAddOnManifest)

Configuración del complemento de Hojas de cálculo.

slides

object (SlidesAddOnManifest)

Configuración del complemento de Presentaciones.

httpOptions

object (HttpOptions)

Opciones para enviar solicitudes a extremos HTTP de complementos

CommonAddOnManifest

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

Representación JSON
{
  "name": string,
  "logoUrl": string,
  "layoutProperties": {
    object (LayoutProperties)
  },
  "addOnWidgetSet": {
    object (AddOnWidgetSet)
  },
  "useLocaleFromApp": boolean,
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "universalActions": [
    {
      object (UniversalActionExtensionPoint)
    }
  ],
  "openLinkUrlPrefixes": array
}
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

object (LayoutProperties)

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

addOnWidgetSet

object (AddOnWidgetSet)

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

useLocaleFromApp

boolean

Indica si se debe pasar la información de configuración regional de la app host.

homepageTrigger

object (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 específicos.

universalActions[]

object (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 un envío de formulario.

openLinkUrlPrefixes

array (ListValue format)

Una acción 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.

LayoutProperties

Son las propiedades de diseño de tarjetas que se comparten en todas las aplicaciones alojadas de complementos.

Representación JSON
{
  "primaryColor": string,
  "secondaryColor": string,
  "useNewMaterialDesign": boolean
}
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 establece el color principal, pero no el secundario, este último será igual al principal. Si no se establece el color principal ni el secundario, se usa el valor predeterminado que proporciona el framework.

useNewMaterialDesign
(deprecated)

boolean

Habilita Material Design para las tarjetas.

AddOnWidgetSet

Es el subconjunto de widgets que usa un complemento.

Representación JSON
{
  "usedWidgets": [
    enum (WidgetType)
  ]
}
Campos
usedWidgets[]

enum (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ásico.

Enums
WIDGET_TYPE_UNSPECIFIED Es 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 Actualiza 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.

HomepageExtensionPoint

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

Representación JSON
{
  "runFunction": string,
  "enabled": boolean
}
Campos
runFunction

string

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

enabled

boolean

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

Si no se establece, el valor predeterminado es true.

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

UniversalActionExtensionPoint

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

Representación JSON
{
  "label": string,

  "openLink": string,
  "runFunction": string
}
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".

Obligatorio. Es el tipo de acción que se admite en un elemento de menú de acción universal. Puede ser un vínculo para abrir o un extremo para ejecutar. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
runFunction

string

Es el extremo que ejecutará UniversalAction.

Fin de los campos mutuamente excluyentes.

GmailAddOnManifest

Son propiedades que personalizan la apariencia y la ejecución de un complemento de Gmail.

Representación JSON
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "authorizationCheckFunction": string
}
Campos
homepageTrigger

object (HomepageExtensionPoint)

Define un extremo que se ejecutará en contextos que no coincidan con un activador contextual declarado. Todas 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 específicos.

Si está presente, anula la configuración de addons.common.homepageTrigger.

contextualTriggers[]

object (ContextualTrigger)

Define el conjunto de condiciones que activan el complemento.

universalActions[]

object (UniversalAction)

Define un conjunto de acciones universales para el complemento. El usuario activa las acciones universales desde el menú de la barra de herramientas del complemento.

composeTrigger

object (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 una acción cuando el usuario redacta un correo electrónico. Todos los complementos de tiempo de redacción deben tener el permiso gmail.addons.current.action.compose, aunque no editen el borrador.

authorizationCheckFunction

string

Es el nombre de un extremo que verifica que el complemento tenga todas las autorizaciones de terceros requeridas, para lo que sondea las APIs de terceros. 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 se activa el activador, se ejecuta un extremo específico, por lo general, para crear tarjetas nuevas y actualizar la IU.

Representación JSON
{
  "onTriggerFunction": string,

  "unconditional": {
    object (UnconditionalTrigger)
  }
}
Campos
onTriggerFunction

string

Obligatorio. Es el nombre del extremo al que se llamará cuando un mensaje coincida con el activador.

El tipo de activador determina las condiciones que usa Gmail para mostrar el complemento. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
unconditional

object (UnconditionalTrigger)

Los activadores incondicionales se ejecutan cuando se abre cualquier mensaje de correo.

Fin de los campos mutuamente excluyentes.

UnconditionalTrigger

Este tipo no tiene campos.

Un activador que se activa cuando se abre cualquier mensaje de correo electrónico.

UniversalAction

Es una acción que siempre está disponible en el menú de la barra de herramientas del complemento, independientemente del contexto del mensaje.

Representación JSON
{
  "text": string,

  "openLink": string,
  "runFunction": string
}
Campos
text

string

Obligatorio. Es el texto visible para el usuario que describe la acción, por ejemplo, "Agregar un contacto nuevo".

El tipo de acción determina el comportamiento de Gmail cuando el usuario invoca la acción. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
runFunction

string

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

Fin de los campos mutuamente excluyentes.

ComposeTrigger

Es un activador que se activa cuando el usuario redacta un correo electrónico.

Representación JSON
{
  "actions": [
    {
      object (MenuItemExtensionPoint)
    }
  ],
  "draftAccess": enum (DraftAccess)
}
Campos
actions[]

object (MenuItemExtensionPoint)

Define el conjunto de acciones para un complemento de tiempo de redacción. Estas son acciones que los usuarios pueden activar en un complemento de tiempo de redacción.

draftAccess

enum (DraftAccess)

Define el nivel de acceso a los datos cuando se activa un complemento de tiempo de redacción.

DraftAccess

Es un enum que define el nivel de acceso a los datos que requiere el activador de redacción.

Enums
UNSPECIFIED Es el valor predeterminado cuando no se establece nada 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

Son propiedades que personalizan la apariencia y la ejecución de un complemento de Drive.

Representación JSON
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onItemsSelectedTrigger": {
    object (DriveExtensionPoint)
  }
}
Campos
homepageTrigger

object (HomepageExtensionPoint)

Si está presente, anula la configuración de addons.common.homepageTrigger.

onItemsSelectedTrigger

object (DriveExtensionPoint)

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

Es el formato común para declarar los activadores de un complemento de Drive.

Representación JSON
{
  "runFunction": string
}
Campos
runFunction

string

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

CalendarAddOnManifest

Son propiedades que personalizan la apariencia y la ejecución de un complemento de Calendario.

Representación JSON
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "createSettingsUrlFunction": string,
  "eventOpenTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventUpdateTrigger": {
    object (CalendarExtensionPoint)
  },
  "calendarNotificationTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventAttachmentTrigger": {
    object (MenuItemExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}
Campos
homepageTrigger

object (HomepageExtensionPoint)

Opcional. 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 específicos.

Si está presente, anula la configuración de addons.common.homepageTrigger.

conferenceSolution[]

object (ConferenceSolution)

Opcional. Define las soluciones para videoconferencias que proporciona este complemento.

createSettingsUrlFunction

string

Un extremo para ejecutar que crea una URL a la página de configuración del complemento.

eventOpenTrigger

object (CalendarExtensionPoint)

Es un extremo que se activa cuando se abre un evento para verlo o editarlo.

eventUpdateTrigger

object (CalendarExtensionPoint)

Es un extremo que se activa cuando se actualiza el evento de apertura.

calendarNotificationTrigger

object (CalendarExtensionPoint)

Opcional. Se activa cuando se crea o actualiza un evento en un calendario al que se suscribió el usuario. Solo se aplica a los activadores creados por HTTP endpoints con CalendarSubscriptionActionMarkup.

Para evitar bucles de notificaciones recurrentes, cuando un complemento modifica un evento de Calendario de Google con la API de Calendario y las credenciales de autenticación del mismo proyecto de Google Cloud que aloja la implementación del complemento, la plataforma suprime las notificaciones de modificación. No se admite la activación automática de las llamadas a la API de Calendario de tu propio proyecto.

No se aplica a Apps Script add-ons ni a Apps Script installable triggers.

eventAttachmentTrigger

object (MenuItemExtensionPoint)

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

currentEventAccess

enum (EventAccess)

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

string

Obligatorio. Es el extremo al que se debe llamar cuando se deben crear datos de conferencia.

id

string

Obligatorio. Los IDs deben asignarse de forma única en las soluciones para videoconferencias dentro de un complemento; de lo contrario, es posible que se use la solución para videoconferencias incorrecta cuando se active el complemento. Si bien puedes cambiar el nombre visible de un complemento, no debes cambiar el ID.

name

string

Obligatorio. Es el nombre visible de la solución para conferencias.

logoUrl

string

Obligatorio. Es la URL de la imagen del logotipo de la solución para conferencias.

CalendarExtensionPoint

Es el formato común para declarar los activadores de un complemento de calendario.

Representación JSON
{
  "runFunction": string
}
Campos
runFunction

string

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

EventAccess

Es un enum que define el nivel de acceso a los datos que requieren los activadores de eventos.

Enums
UNSPECIFIED Es el valor predeterminado cuando no se establece nada para eventAccess.
METADATA Otorga a los activadores de eventos el permiso para acceder a los metadatos de los eventos, como el ID del evento y el ID del calendario.
READ Otorga a los activadores de eventos acceso a todos los campos de eventos proporcionados, incluidos los metadatos, los asistentes y los datos de la videoconferencia.
WRITE Otorga a los activadores de eventos acceso a los metadatos de los eventos y la capacidad de realizar todas las acciones, como agregar asistentes y establecer datos de videoconferencias.
READ_WRITE Otorga a los activadores de eventos acceso a todos los campos de eventos proporcionados, incluidos los metadatos, los asistentes y los datos de la conferencia, y la capacidad de realizar todas las acciones.

DocsAddOnManifest

Son propiedades que personalizan la apariencia y la ejecución de un complemento de Documentos de Google.

Representación JSON
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (DocsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ],
  "createActionTriggers": [
    {
      object (CreateActionExtensionPoint)
    }
  ]
}
Campos
homepageTrigger

object (HomepageExtensionPoint)

Si está presente, anula la configuración de addons.common.homepageTrigger.

onFileScopeGrantedTrigger

object (DocsExtensionPoint)

Es el extremo que se ejecutará cuando se otorgue la autorización del permiso de archivo para este par de documento y usuario.

linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Es una lista de puntos de extensión para obtener una vista previa de los vínculos en un documento de Documentos de Google. Para obtener más información, consulta Vínculos de vista previa con chips inteligentes.

createActionTriggers[]

object (CreateActionExtensionPoint)

Es 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 Cómo crear 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

string

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

LinkPreviewExtensionPoint

Es la configuración de un activador que se ejecuta 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 (UriPattern)
    }
  ],
  "runFunction": string,
  "logoUrl": string
}
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 (key: string, value: string)

Opcional. Un mapa de labeltext para localizar en otros idiomas. Asigna el formato de idioma en ISO 639 y el de 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, el usuario verá la versión localizada de labeltext.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

patterns[]

object (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 de vínculo.

logoUrl

string

Opcional. Es el ícono que se muestra en el chip inteligente y la tarjeta de vista previa. Si se omite, el complemento usa su ícono de barra de herramientas, logourl.

UriPattern

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

Representación JSON
{
  "hostPattern": string,
  "pathPrefix": string
}
Campos
hostPattern

string

Es obligatorio para cada patrón de URL que se quiera obtener una 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 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.

CreateActionExtensionPoint

Es la configuración de un activador que se ejecuta 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 Cómo crear recursos de terceros desde el menú @.

Representación JSON
{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string
}
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 con 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 (key: string, value: string)

Opcional. Un mapa de labeltext para localizar en otros idiomas. Asigna el formato de idioma en ISO 639 y el de 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, el usuario verá la versión localizada de labeltext.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

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. Es el í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.

MeetAddOnManifest

Manifiesto del complemento de Meet.

Representación JSON
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "web": {
    object (Web)
  },
  "supportsCollaboration": boolean,
  "termsUri": string
}
Campos
homepageTrigger

object (HomepageExtensionPoint)

Si está presente, anula la configuración de addons.common.homepageTrigger.

web

object (Web)

Son los detalles de los complementos que mejoran el cliente web de Meet.

supportsCollaboration

boolean

Indica si el complemento admite la colaboración o la invitación de otras personas a la experiencia del complemento.

termsUri

string

Un vínculo a las condiciones del servicio del complemento, si se debe mostrar alguna.

Web

Son los detalles de los complementos que mejoran el cliente web de Meet.

Representación JSON
{
  "sidePanelUri": string,
  "sidePanelUrl": string,
  "mainStageUri": string,
  "supportsScreenSharing": boolean,
  "supportsCollaboration": boolean,
  "supportsPopOut": boolean,
  "hostOrigins": [
    string
  ],
  "addOnOrigins": [
    string
  ],
  "openState": enum (State),
  "supportsCollaborationHostControls": boolean,
  "logoUrl": string,
  "darkModeLogoUrl": string,
  "displayFlow": enum (DisplayFlow)
}
Campos
sidePanelUri
(deprecated)

string

Es el URI del iframe del panel lateral.

sidePanelUrl

string

Es la URL del iframe del panel lateral.

mainStageUri
(deprecated)

string

Es el URI del iframe de la "etapa principal".

supportsScreenSharing

boolean

Indica si el complemento admite compartir pantalla en el escenario principal.

supportsCollaboration
(deprecated)

boolean

Indica si el complemento admite la colaboración o la invitación de otras personas a la experiencia del complemento. Este campo dejó de estar disponible. Usa el campo de nivel superior en MeetAddOnManifest.

supportsPopOut

boolean

Indica si el complemento admite la apertura de una experiencia de PIP en el navegador.

hostOrigins[]
(deprecated)

string

Nombre heredado y obsoleto. Son los orígenes que se deben agregar a la propiedad frame-src del iframe que contiene el sitio de terceros. En su lugar, usa addonorigins.

addOnOrigins[]

string

Son los orígenes que se deben agregar a la propiedad frame-src del iframe que contiene el sitio de terceros.

openState

enum (State)

Es el estado inicial cuando se abre el complemento.

supportsCollaborationHostControls

boolean

Indica si el complemento de colaboración admite controles del organizador.

logoUrl

string

Es la URL del logotipo que se mostrará para el complemento. Si no se especifica, el logotipo predeterminado es el que se encuentra en la sección común del manifiesto.

darkModeLogoUrl

string

Es una versión en modo oscuro de la URL del logotipo.

displayFlow
(deprecated)

enum (DisplayFlow)

Es el flujo de visualización que seguirá el complemento cuando se inicie.

Estado

Es un enum para especificar el estado de apertura inicial del complemento.

Enums
STATE_UNSPECIFIED No se especificó el estado inicial con el complemento.
SIDE_PANEL_ONLY El complemento se abre solo con el panel lateral activo.
MAIN_STAGE_ONLY El complemento se abre solo con la escena principal activa.
SIDE_PANEL_AND_MAIN_STAGE El complemento se abre con el panel lateral y la escena principal activos.

DisplayFlow

Es un enum para especificar el flujo de visualización que seguirá el complemento cuando se inicie.

Enums
DISPLAY_FLOW_UNSPECIFIED No se especificó el flujo de visualización.
FOCUS El complemento debería iniciarse en el flujo de visualización "focus".
AUGMENT El complemento se debe iniciar en el flujo de visualización "augment".

SheetsAddOnManifest

Son propiedades que personalizan la apariencia y la ejecución de un complemento de Hojas de cálculo de Google.

Representación JSON
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SheetsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
Campos
homepageTrigger

object (HomepageExtensionPoint)

Si está presente, anula la configuración de addons.common.homepageTrigger.

onFileScopeGrantedTrigger

object (SheetsExtensionPoint)

Es el extremo que se ejecutará cuando se otorgue la autorización del permiso de archivo para este par de documento y usuario.

linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Es 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 obtener más información, consulta Vínculos de vista previa con chips inteligentes.

SheetsExtensionPoint

Es el formato común para declarar los activadores de un complemento de Hojas de cálculo.

Representación JSON
{
  "runFunction": string
}
Campos
runFunction

string

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

SlidesAddOnManifest

Son propiedades que personalizan la apariencia y la ejecución de un complemento de Presentaciones de Google.

Representación JSON
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SlidesExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
Campos
homepageTrigger

object (HomepageExtensionPoint)

Si está presente, anula la configuración de addons.common.homepageTrigger.

onFileScopeGrantedTrigger

object (SlidesExtensionPoint)

Es el extremo que se ejecutará cuando se otorgue la autorización del permiso de archivo para este par de documento y usuario.

linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Es una lista de puntos de extensión para obtener una vista previa de los vínculos en un documento de Presentaciones de Google. Para obtener más información, consulta Vínculos de vista previa con chips inteligentes.

SlidesExtensionPoint

Es el formato común para declarar los activadores de un complemento de Presentaciones.

Representación JSON
{
  "runFunction": string
}
Campos
runFunction

string

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

HttpOptions

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

Representación JSON
{
  "authorizationHeader": enum (HttpAuthorizationHeader),
  "granularOauthPermissionSupport": enum (GranularOauthPermissionSupport)
}
Campos
authorizationHeader

enum (HttpAuthorizationHeader)

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

granularOauthPermissionSupport

enum (GranularOauthPermissionSupport)

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

HttpAuthorizationHeader

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

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

GranularOauthPermissionSupport

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

Enums
GRANULAR_OAUTH_PERMISSION_SUPPORT_UNSPECIFIED Es el valor predeterminado que no se debe usar.
OPT_IN El complemento habilitó el consentimiento detallado de OAuth.
OPT_OUT El complemento inhabilitó el consentimiento detallado de OAuth.

Métodos

create

Crea una implementación con el nombre y la configuración especificados.

delete

Borra la implementación con el nombre proporcionado.

get

Obtiene la implementación con el nombre especificado.

getInstallStatus

Obtiene el estado de instalación de una implementación de prueba.

install

Instala una implementación en tu cuenta para realizar pruebas.

list

Enumera todas las implementaciones de un proyecto en particular.

replaceDeployment

Crea o reemplaza una implementación con el nombre especificado.

uninstall

Desinstala una implementación de prueba de la cuenta del usuario.