Los complementos de Google Workspace pueden brindar o interfaces de usuario cuando el usuario usa Google Drive. Esto te permite brindar al usuario con información relevante adicional, automatizar las tareas y conectar sistemas a Google Drive.
Accede a la IU del complemento
Puedes abrir un complemento de Google Workspace en Google Drive si el ícono aparece en el a la derecha de la interfaz de usuario de Drive. R el complemento de Google Workspace puede definir una interfaz de página de inicio, una interfaz de selección de elementos o ambas:
- Si un usuario hace clic en el ícono del complemento mientras está en Google Drive,
se ejecuta el complemento
el
drive.homepageTrigger
correspondiente (si está presente). Esta función Compila y muestra una tarjeta de página principal. a Google Drive para mostrar. Si la respuesta es nodrive.homepageTrigger
se define una función, en su lugar se muestra una tarjeta genérica de la página principal. - Si el usuario selecciona uno o más elementos en Google Drive y, luego, hace clic en el complemento.
o selecciona elementos mientras el complemento está abierto, este ejecuta la ejecución
drive.onItemsSelectedTrigger
función contextual (si está presente). Esta función compila la unidad de Google Drive del complemento contextuales “elementos seleccionados” y lo devuelve a Google Drive para mostrarlo.
Cómo compilar la interfaz de los complementos de Drive
Puedes crear interfaces que extiendan Google Drive siguiendo estas instrucciones pasos:
- Decide si quieres que tu complemento tenga una versión específica de Drive página principal. Además, decide si quieres proporcionar una interfaz contextual para cuando el usuario selecciona elementos de Drive.
- Agrega las
addOns.common
yaddOns.drive
campos para el proyecto de secuencia de comandos del complemento manifiesto, lo que incluye cualquier permiso de Drive requerido. - Si proporcionas una página principal específica de Drive,
implementar el
drive.homepageTrigger
para compilar esta interfaz. También puedes usar lacommon.homepageTrigger
para múltiples hosts de Google Workspace. - Si proporcionas una interfaz de selección de elementos contextuales de Drive, debes
implementa un
drive.onItemsSelectedTrigger
activador contextual para compilar esta interfaz. Consulta Interfaz contextual de Drive para elementos seleccionados) para conocer los detalles. - Implementa las funciones de devolución de llamada asociadas necesarias para responder al mensaje Las interacciones de la IU, como los clics en botones.
Páginas principales de Drive
Google Drive admite mostrar el complemento de Google Workspace
páginas principales.
Para mostrar la página principal común de tu complemento en Google Drive, solo asegúrate de que
es un campo addOns.drive
en el manifiesto del complemento.
Como alternativa, puedes agregar
drive.homepageTrigger
al manifiesto del complemento para proporcionar una página principal específica de Drive.
En cualquier caso, debes proporcionar el nombre de una función activadora de página principal en tu
proyecto de secuencia de comandos del complemento. Esta función se llama automáticamente para compilar la
Página principal de Drive cuando sea necesario Debes implementar esta función para compilar y
devolver un solo
Card
o un array de
Card
que conforman la página de inicio. A la función de activación de la página de inicio se le pasa un
objeto de evento
como un parámetro que contiene información general, como la configuración
plataforma. Puedes usar los datos del objeto de evento para personalizar la construcción del objeto
página principal.
Interfaz contextual de Drive para los elementos seleccionados
Google Drive usa un activador contextual para determinar qué interfaz
(si corresponde) para que se muestren cuando el usuario seleccione uno o más elementos de Google Drive. Cuando
activadores, ejecuta la función de activación contextual especificada por el
drive.onItemsSelectedTrigger.runFunction
en el manifiesto del complemento.
Para crear una interfaz de selección de elementos contextuales para Drive, debes hacer lo siguiente: lo siguiente:
Asegúrate de que el manifiesto del complemento incluya la función
https://www.googleapis.com/auth/drive.addons.metadata.readonly
alcanceAsegúrate de que el manifiesto incluya
drive.onItemsSelectedTrigger
sección.Implementa la función nombrada en
drive.onItemsSelectedTrigger
. Esta función acepta un objeto de evento como argumento. y debe mostrar un soloCard
o un array deCard
.Al igual que con cualquier tarjeta, debes implementar las funciones de devolución de llamada interactividad de widgets para la interfaz. Por ejemplo, si incluyes un botón en la interfaz, debe tener un archivo adjunto Acción y una función de devolución de llamada implementada que se ejecuta cuando se hace clic en el botón.
Objetos de evento
Se crea y pasa un objeto de evento.
a la drive.homepageTrigger
o drive.onItemsSelectedTrigger
función de activador cuando se las llama. La función de activación puede usar
la información de este objeto de evento para determinar cómo crear tarjetas de complementos
o controlar el comportamiento de los complementos.
La estructura completa de los objetos de evento se describe en Objetos de evento. Cuando Drive es la aplicación host del complemento, los objetos de eventos contextuales incluyen el Objeto de evento de Drive campo que contiene información específica del cliente de Drive.
Los objetos de eventos contextuales de Drive para activadores de selección de elementos incluyen información. sobre los elementos que el usuario seleccionó cuando se activa el activador Cuando un usuario selecciona más de un elemento en Drive, uno de ellos se considera uno de interés principal; este elemento se denomina elemento de cursor activo.
En el siguiente ejemplo, se muestra un
Objeto de evento de Drive
que se pasa a un
drive.onItemsSelectedTrigger
función:
{
"commonEventObject": { ... },
"drive": {
"activeCursorItem":{
"addonHasFileScopePermission": true,
"id":"0B_sX1fXRRU6Ac3RhcnRlcl9maWxl",
"iconUrl": "https://drive-thirdparty.googleusercontent.com...",
"mimeType":"application/pdf",
"title":"How to get started with Drive"
},
"selectedItems": [
{
"addonHasFileScopePermission": true,
"id":"0B_sX1fXRRU6Ac3RhcnRlcl9maWxl",
"iconUrl":"https://drive-thirdparty.googleusercontent.com...",
"mimeType":"application/pdf",
"title":"How to get started with Drive"
},
...
]
},
...
}