Compila interfaces de Google Drive

Los complementos deGoogle Workspace pueden proporcionar interfaces personalizadas cuando el usuario usa Google Drive. Esto te permite proporcionarle al usuario información adicional relevante, automatizar tareas y conectar sistemas de terceros a Google Drive.

Accede a la IU del complemento

Puedes abrir un Google Workspace complemento en Google Drive si su ícono aparece en la columna de íconos del lado derecho de la interfaz de usuario de Drive. UnGoogle Workspace complemento puede definir una interfaz de la página principal, una interfaz de selección de elementos o ambas:

  • Si un usuario hace clic en el ícono del complemento mientras está en Google Drive, el complemento ejecuta la función drive.homepageTrigger correspondiente (si está presente). Esta función compila y muestra una tarjeta de página principal en Google Drive para mostrarla. Si no se define ninguna función drive.homepageTrigger, se mostrará una tarjeta genérica de la página principal.
  • Si el usuario selecciona uno o más elementos en Drive y, luego, hace clic en el ícono de complemento o selecciona elementos mientras el complemento está abierto, el complemento ejecuta la función contextual drive.onItemsSelectedTrigger correspondiente (si está presente). Esta función compila la interfaz de elementos contextuales de Drive y la muestra en Google Drive para su visualización.

Cómo compilar la interfaz de Drive

Para compilar interfaces que extiendan Google Drive, sigue estos pasos generales:

  1. Decide si quieres que tu complemento tenga una página principal específica de Drive. También decide si deseas proporcionar una interfaz contextual para el momento en que el usuario selecciona elementos de Drive.
  2. Agrega los campos addOns.common y addOns.drive adecuados al manifiesto del proyecto de secuencia de comandos del complemento, incluidos los permisos de Drive necesarios.
  3. Si proporcionas una página principal específica de Drive, implementa la función drive.homepageTrigger para compilar esta interfaz. También puedes usar la interfaz common.homepageTrigger para varios hosts Google Workspace .
  4. Si proporcionas una interfaz de selección de elementos contextuales de Drive, debes implementar una función de activador contextual de drive.onItemsSelectedTrigger para compilar esta interfaz. Consulta Interfaz contextual de Drive para los elementos seleccionados) si deseas obtener más detalles.
  5. Implementa las funciones de devolución de llamada asociadas necesarias para responder a las interacciones de la IU del usuario, como los clics en botones.

Páginas principales de Drive

Google Drive admite la visualización de Google Workspace páginas principales complementarias. Para mostrar la página principal común de tu complemento en Google Drive, simplemente asegúrate de que haya un campo addOns.drive en el manifiesto del complemento.

Como alternativa, agrega un drive.homepageTrigger al manifiesto del complemento para proporcionar una página principal específica de Drive.

En cualquier caso, debes proporcionar el nombre de la función activadora de la página principal en el proyecto de secuencia de comandos del complemento. Esta función se llama automáticamente para compilar la página principal de Drive cuando es necesario. Debes implementar esta función para compilar y mostrar una sola Card o un arreglo de objetos Card que conforman la página principal. La función de activador de la página principal recibe un objeto de evento como un parámetro que contiene información general, como la plataforma del cliente. Puedes usar los datos del objeto de evento para personalizar la construcción de la página principal.

Interfaz contextual de Drive para los elementos seleccionados

Google Drive se basa en un activador contextual para determinar la interfaz (si corresponde) que se mostrará cuando el usuario seleccione uno o más elementos de Drive. Cuando el activador se activa, ejecuta la función de activador contextual especificada por el campo drive.onItemsSelectedTrigger.runFunction en el manifiesto del complemento.

A fin de crear una interfaz de selección contextual de elementos para Drive, debes hacer lo siguiente:

  1. Asegúrate de que el manifiesto del complemento incluya el alcance de https://www.googleapis.com/auth/drive.addons.metadata.readonly

  2. Asegúrate de que el manifiesto incluya una sección drive.onItemsSelectedTrigger.

  3. Implementa la función nombrada en el campo drive.onItemsSelectedTrigger. Esta función acepta un objeto de evento como argumento y debe mostrar un solo objeto Card o un arreglo de objetos Card.

  4. Al igual que con cualquier tarjeta, debes implementar cualquier función de devolución de llamada que se use para proporcionar interactividad del widget en la interfaz. Por ejemplo, si incluyes un botón en la interfaz, debería tener una Action adjunta y una función de devolución de llamada implementada que se ejecute cuando se haga clic en el botón.

Objetos de eventos

Se crea un objeto de evento y se pasa a la función de activador drive.homepageTrigger o drive.onItemsSelectedTrigger cuando se llama a esas funciones. La función activadora puede usar la información de este objeto de evento para determinar cómo construir tarjetas de complementos o controlar su comportamiento.

La estructura completa de los objetos de evento se describe en Objetos de evento. Cuando Drive es la app host actuante del complemento, los objetos de eventos contextuales incluyen el campo Objeto de evento de Drive que lleva la información del cliente específica de Drive.

Los objetos de eventos de Drive contextuales 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 de interés principal. Este elemento se denomina elemento del cursor activo.

En el siguiente ejemplo, se muestra un objeto de evento de Drive que se pasa a una función drive.onItemsSelectedTrigger:

    {
      "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"
          },
          ...
        ]
      },
      ...
    }