Cómo compilar interfaces de Google Drive

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

Cómo acceder a la IU del complemento

Puedes abrir un complemento de Google Workspace en Google Drive si su ícono aparece en la columna de íconos del lado derecho de la interfaz de usuario de Drive. Un complemento de Google Workspace puede definir una interfaz de 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, este ejecuta la función drive.homepageTrigger correspondiente (si está presente). Esta función compila y muestra una tarjeta de la página principal en Google Drive. Si no se define una 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 Google Drive y, luego, hace clic en el ícono del complemento o selecciona elementos mientras el complemento está abierto, este ejecuta la función contextual correspondiente de drive.onItemsSelectedTrigger (si está presente). Esta función compila la interfaz contextual "elementos seleccionados" de Google Drive del complemento y la muestra en Google Drive.

Cómo compilar la interfaz de Drive del complemento

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 cuando el usuario seleccione 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 alcances 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 de Google Workspace.
  4. Si proporcionas una interfaz de selección de elementos contextuales de Drive, debes implementar una función de activador contextual drive.onItemsSelectedTrigger para compilar esta interfaz. Consulta Interfaz contextual de Drive para los elementos seleccionados para obtener más información.
  5. Implementa las funciones de devolución de llamada asociadas necesarias para responder a las interacciones del usuario con la IU, como los clics en los botones.

Páginas principales de Drive

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

Como alternativa, agrega un elemento 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 de activador de la página principal en el proyecto de secuencia de comandos de tu complemento. Se llama automáticamente a esta función para compilar la página principal de Drive cuando sea necesario. Debes implementar esta función para compilar y mostrar un solo objeto Card o un array de objetos Card que conforman la página principal. A la función del activador de la página principal se le pasa 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 adaptar 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 qué interfaz (si la hay) se mostrará cuando el usuario seleccione uno o más elementos de Google Drive. Cuando se activa el activador, se ejecuta la función de activador contextual especificada por el campo drive.onItemsSelectedTrigger.runFunction en el manifiesto del complemento.

Para crear una interfaz de selección de elementos contextuales para Drive, debes hacer lo siguiente:

  1. Asegúrate de que el manifiesto del complemento incluya el alcance 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 que se nombra en el campo drive.onItemsSelectedTrigger. Esta función acepta un objeto de evento como argumento y debe mostrar un solo objeto Card o un array de objetos Card.

  4. Al igual que con cualquier tarjeta, debes implementar las funciones de devolución de llamada que se usan para proporcionar la interactividad del widget para la interfaz. Por ejemplo, si incluyes un botón en la interfaz, este debe tener una acción 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 activación drive.homepageTrigger o drive.onItemsSelectedTrigger cuando se las llama. La función del activador puede usar la información de este objeto de evento para determinar cómo construir tarjetas de complementos o controlar de otra manera su comportamiento.

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

Los objetos de eventos de Drive contextuales para los activadores de selección de elementos incluyen información sobre los elementos que el usuario seleccionó cuando se activó el activador. Cuando un usuario selecciona más de un elemento en Drive, se considera que uno de ellos es de interés principal; este elemento se conoce como el elemento de 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"
          },
          ...
        ]
      },
      ...
    }