REST Resource: projects.deployments

{
  "name": string,
  "oauthScopes": [
    string
  ],
  "addOns": {
    object (AddOns)
  },
  "etag": string
}

string

El nombre del recurso de implementación. Ejemplo: projects/123/deployments/my_deployment.

string

Es la lista de permisos de Google OAuth para los cuales se debe solicitar el consentimiento del usuario final antes de ejecutar un extremo complementario.

object (AddOns)

La configuración del complemento de Google Workspace

string

El servidor calcula este valor en función de la versión de la implementación en el almacenamiento y se puede enviar cuando se solicitan actualizaciones y eliminaciones para garantizar que el cliente tenga un valor actualizado antes de continuar.

{
  "common": {
    object (CommonAddOnManifest)
  },
  "gmail": {
    object (GmailAddOnManifest)
  },
  "drive": {
    object (DriveAddOnManifest)
  },
  "calendar": {
    object (CalendarAddOnManifest)
  },
  "docs": {
    object (DocsAddOnManifest)
  },
  "sheets": {
    object (SheetsAddOnManifest)
  },
  "slides": {
    object (SlidesAddOnManifest)
  },
  "httpOptions": {
    object (HttpOptions)
  }
}

object (CommonAddOnManifest)

Configuración que es común en todos los complementos de Google Workspace.

object (GmailAddOnManifest)

Configuración del complemento de Gmail

object (DriveAddOnManifest)

Configuración del complemento de Drive

object (CalendarAddOnManifest)

Configuración del complemento de Calendario

object (DocsAddOnManifest)

Configuración del complemento de Documentos

object (SheetsAddOnManifest)

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

object (SlidesAddOnManifest)

Configuración del complemento de Presentaciones.

object (HttpOptions)

Opciones para enviar solicitudes a extremos HTTP de complementos

{
  "name": string,
  "logoUrl": string,
  "layoutProperties": {
    object (LayoutProperties)
  },
  "addOnWidgetSet": {
    object (AddOnWidgetSet)
  },
  "useLocaleFromApp": boolean,
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "universalActions": [
    {
      object (UniversalActionExtensionPoint)
    }
  ],
  "openLinkUrlPrefixes": array
}

string

Obligatorio. El nombre visible del complemento.

string

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

object (LayoutProperties)

Propiedades de diseño comunes para las tarjetas de complementos

object (AddOnWidgetSet)

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

boolean

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

object (HomepageExtensionPoint)

Define un extremo que se ejecutará en cualquier contexto y en cualquier host. Todas las tarjetas generadas por 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.

object (UniversalActionExtensionPoint)

Define una lista de puntos de extensiones en el menú de acciones universales, que sirve como menú de configuración del 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.

array (ListValue format)

Una acción de OpenLink solo puede usar una URL con un esquema HTTPS, MAILTO o TEL. Para 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 vuelven a escribir automáticamente en los vínculos HTTPS.

{
  "primaryColor": string,
  "secondaryColor": string,
  "useNewMaterialDesign": boolean
}

string

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.

string

El color secundario del complemento Establece el color de los botones. Si se configuró el color principal, pero no se configuró ningún color secundario, el color secundario será el mismo que el principal. Si no se establecen el color principal ni el secundario, se usa el valor predeterminado que proporciona el framework.

boolean

Habilita Material Design para tarjetas.

{
  "usedWidgets": [
    enum (WidgetType)
  ]
}

enum (WidgetType)

La lista de widgets que se usan en un complemento.

{
  "runFunction": string,
  "enabled": boolean
}

string

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

boolean

Opcional. Si se configura como 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 personalizada de la página principal de un complemento, se proporcionará a los usuarios una tarjeta de descripción general genérica.

{
  "label": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}

string

Obligatorio. Texto visible para el usuario que describe la acción que se realiza al activar este punto de extensión, por ejemplo, "Agregar un contacto nuevo".

string

URL que abrirá UniversalAction.

string

Extremo que ejecutará UniversalAction.

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

object (HomepageExtensionPoint)

Define un extremo que se ejecutará en contextos que no coinciden con un activador contextual declarado. Todas las tarjetas generadas por esta función siempre estarán disponibles para el usuario, pero el contenido contextual las puede eclipsar cuando este complemento declare activadores más segmentados.

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

object (ContextualTrigger)

Define el conjunto de condiciones que activan el complemento.

object (UniversalAction)

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

object (ComposeTrigger)

Define el activador del tiempo de redacción para un complemento de tiempo de redacción. Este es el activador que genera la acción de un complemento cuando el usuario redacta un correo electrónico. Todos los complementos de redacción deben tener el permiso gmail.addons.current.action.compose, aunque podría no editar el borrador.

string

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

{
  "onTriggerFunction": string,

  // Union field trigger can be only one of the following:
  "unconditional": {
    object (UnconditionalTrigger)
  }
  // End of list of possible types for union field trigger.
}

string

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

object (UnconditionalTrigger)

Los activadores incondicionales se ejecutan cuando se abre un mensaje de correo electrónico.

{
  "text": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}

string

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

string

Es un vínculo que se abre en Gmail cuando el usuario activa la acción.

string

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.

{
  "actions": [
    {
      object (MenuItemExtensionPoint)
    }
  ],
  "draftAccess": enum (DraftAccess)
}

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 redacción.

enum (DraftAccess)

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

{
  "runFunction": string,
  "label": string,
  "logoUrl": string
}

string

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

string

Obligatorio. Texto visible para el usuario que describe la acción que se realiza al activar este punto de extensión. Por ejemplo, "Insertar factura".

string

La URL de la imagen del logotipo que se muestra en la barra de herramientas de complementos

Si no está configurado, se establece de forma predeterminada en la URL del logotipo principal del complemento.

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onItemsSelectedTrigger": {
    object (DriveExtensionPoint)
  }
}

object (HomepageExtensionPoint)

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

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.

{
  "runFunction": string
}

string

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

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "createSettingsUrlFunction": string,
  "eventOpenTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventUpdateTrigger": {
    object (CalendarExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}

object (HomepageExtensionPoint)

Define un extremo que se ejecuta en contextos que no coinciden con un activador contextual declarado. Todas las tarjetas generadas por 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.

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

object (ConferenceSolution)

Define las soluciones de conferencia que proporciona este complemento.

string

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

object (CalendarExtensionPoint)

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

object (CalendarExtensionPoint)

Un extremo que se activa cuando se actualiza el evento abierto

enum (EventAccess)

Define el nivel de acceso a los datos cuando se activa un complemento de evento.

{
  "onCreateFunction": string,
  "id": string,
  "name": string,
  "logoUrl": string
}

string

Obligatorio. El extremo al que se llamará cuando se deben crear datos de conferencia.

string

Obligatorio. Los ID deben asignarse de forma única entre las soluciones de conferencia de un complemento; de lo contrario, podría usarse la solución de conferencia incorrecta cuando se activa el complemento. Si bien puede cambiar el nombre visible de un complemento, el ID no se debe cambiar.

string

Obligatorio. El nombre visible de la solución de la conferencia.

string

Obligatorio. URL de la imagen del logotipo de la solución de conferencia.

{
  "runFunction": string
}

string

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

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (DocsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}

object (HomepageExtensionPoint)

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

object (DocsExtensionPoint)

Extremo que se ejecutará cuando se otorgue autorización de alcance de archivo para este par de documento/usuario.

object (LinkPreviewExtensionPoint)

Una lista de puntos de extensiones para obtener vistas previas de vínculos en un archivo de Documentos de Google. Para obtener más información, consulta Cómo obtener vistas previas de vínculos con chips inteligentes.

{
  "runFunction": string
}

string

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

{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "patterns": [
    {
      object (UriPattern)
    }
  ],
  "runFunction": string,
  "logoUrl": string
}

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.

map (key: string, value: string)

Opcional. Mapa de labeltext para localizar a otros idiomas Usa el formato 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 del usuario está presente en las claves del mapa, este verá la versión localizada de labeltext.

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

object (UriPattern)

Obligatorio. Es un array de patrones de URL que activan el complemento para obtener vistas previas de vínculos.

string

Obligatorio. Extremo para ejecutar cuando se activa una vista previa del vínculo.

string

Opcional. Ícono que se muestra en el chip inteligente Si se omite, el chip usará el ícono de la barra de herramientas del complemento, logourl.

{
  "hostPattern": string,
  "pathPrefix": string
}

string

Obligatorio para cada patrón de URL de vista previa. Es el dominio del patrón de URL. Los vínculos de vistas previas del complemento 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.

string

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

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

Para que todas las URLs coincidan con el patrón del host, deja pathprefix vacío.

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SheetsExtensionPoint)
  }
}

object (HomepageExtensionPoint)

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

object (SheetsExtensionPoint)

Extremo que se ejecutará cuando se otorgue autorización de alcance de archivo para este par de documento/usuario.

{
  "runFunction": string
}

string

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

{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SlidesExtensionPoint)
  }
}

object (HomepageExtensionPoint)

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

object (SlidesExtensionPoint)

Extremo que se ejecutará cuando se otorgue autorización de alcance de archivo para este par de documento/usuario.

{
  "runFunction": string
}

string

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

{
  "authorizationHeader": enum (HttpAuthorizationHeader)
}

enum (HttpAuthorizationHeader)

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