Cómo configurar una integración de IU de Drive

Para mostrar tu app en Google Drive cuando un usuario crea o abre un archivo, primero debes configurar una integración de la interfaz de usuario (IU) de Drive. La configuración también es necesaria para incluir tu app en Google Workspace Marketplace.

Habilita la API de Drive

Antes de usar las API de Google, debes activarlas en un proyecto de Google Cloud. Puedes activar una o más API en un solo proyecto de Google Cloud.

Para comenzar a integrar la IU de Google Drive, debes habilitar la API de Drive. Esto te brinda acceso a la API y a las características de integración de la IU.

• En Google Cloud Console, habilita la API de Google Drive.

  Habilitar la API

Cómo configurar la integración de la IU de Drive

1. En la Consola de API de Google, ve a Menú menu > API y servicios > API y servicios habilitados.

   Ir a API y servicios habilitados

2. En la parte inferior del panel API y servicios, haga clic en API de Google Drive. Aparecerá la página de configuración de la API de Google Drive.
3. Seleccione la pestaña Integración con la IU de Drive.
4. (Opcional) Ingresa un nombre en el campo Nombre de la aplicación. El nombre de la aplicación se muestra a los usuarios en la pestaña Administrar aplicaciones en la configuración de Drive.
5. Ingresa una descripción breve de una línea en el campo Descripción breve (opcional). La descripción breve se muestra a los usuarios en la pestaña Administrar apps en la configuración de Drive.
6. (Opcional) Ingresa una descripción completa en el campo Descripción larga.

7. Sube uno o más íconos de aplicación para que se muestren en la lista de aplicaciones conectadas de Drive del usuario y en el menú contextual "Abrir con". Los íconos deben estar en formato PNG con fondo transparente. Los íconos pueden tardar hasta 24 horas en aparecer en Drive.

8. Para usar el elemento del menú "Abrir con" de la IU de Drive, ingresa la URL de tu app en el campo Abrir URL. El menú contextual "Abrir con" usa esta URL.

   • Esta URL debe contener un nombre de dominio completo; localhost no funciona.
   • Debes verificar la propiedad de esta URL para poder incluir tu aplicación en Google Workspace Marketplace.
   • De forma predeterminada, se agrega un parámetro de búsqueda state a esta URL para pasar datos desde la IU de Drive a tu app. Si deseas obtener información sobre el contenido del parámetro state, consulta Parámetro state.

9. (Opcional) Ingresa los tipos de MIME predeterminados y las extensiones de archivo en los campos Tipos de MIME predeterminados y Extensiones de archivos predeterminadas. Los tipos de MIME y las extensiones de archivo predeterminados representan archivos que tu app está diseñada para abrirse de forma única. Por ejemplo, tu app puede abrir un formato integrado para superponer y editar imágenes. Incluye solo tipos de medios estándar y asegúrate de que no contengan errores ortográficos ni ortográficos. Si tu app solo abre archivos de acceso directo de terceros o de acceso directo, puedes dejar el tipo de MIME en blanco.

10. (Opcional) Ingresa los tipos de MIME secundarios y las extensiones de archivo en los campos Tipos de MIME secundarios y Extensiones de archivos secundarios. Los tipos de MIME secundarios y las extensiones de archivo representan archivos que tu app puede abrir, pero que no son específicos de tu app. Por ejemplo, tu app puede ser una app de edición de imágenes que abre imágenes PNG y JPG. Incluye solo tipos de medios estándar y asegúrate de que no contengan errores ortográficos ni ortográficos. Si tu app solo abre archivos de acceso directo de terceros o de acceso directo, puedes dejar el tipo de MIME en blanco.

11. Para usar el botón "Nuevo" de la IU de Drive y hacer que los usuarios creen un archivo con la app, marca la casilla Crear archivos. Aparecerán los campos URL nueva y Nombre del documento opcionales.

    • Esta URL debe contener un nombre de dominio completo; localhost no funciona.
    • Debes verificar la propiedad de esta URL para poder incluir tu aplicación en Google Workspace Marketplace.
    • De forma predeterminada, se agrega un parámetro de búsqueda state a esta URL para pasar datos desde la IU de Drive a tu app. Si deseas obtener información sobre el contenido del parámetro state, consulta Parámetro state.

12. Ingrese una URL en el campo URL nueva. El botón "Nuevo" usa esta URL para redireccionar al usuario a tu aplicación.

13. (Opcional) Si deseas que tu app abra archivos compatibles con Google Workspace, marca la casilla Importación.

14. Si tu app debe administrar archivos de unidades compartidas, marca la casilla Compatibilidad con unidades compartidas (opcional). Para obtener más información sobre cómo admitir unidades compartidas en tu app, consulta Cómo implementar la compatibilidad con unidades compartidas.

15. Haz clic en Enviar.

Solicita el permiso drive.install

Para permitir que las apps aparezcan como una opción en el menú "Abrir con" o "Nuevo", solicita el permiso https://www.googleapis.com/auth/drive.install a fin de integrarlas a la IU de Drive. Cuando se solicita este alcance, los usuarios reciben un diálogo similar al siguiente:

Para obtener más información sobre los alcances que puedes solicitar para las aplicaciones de Drive y cómo solicitarlos, consulta Información de autorización y autenticación específicas de la API.

El parámetro state

De forma predeterminada, se agrega un parámetro state a la URL abierta y a la URL nueva para pasar datos desde la IU de Drive a la app. Este parámetro contiene una string codificada en JSON con variables de plantilla y datos sobre la solicitud a la app. Las variables incluidas dependen del tipo de URL que se use (URL abierta o URL nueva):

Variable de plantilla	Descripción	Aplicación de URL
{ids}	Una lista separada por comas de ID de archivos que se abren.	Abrir URL
{exportIds}	Una lista separada por comas de los ID de archivos que se exportan (que se usan solo cuando se abren los documentos integrados de Google).	Abrir URL
{resourceKeys}	Un diccionario JSON de ID de archivos asignados a sus respectivas claves de recursos.	Abrir URL
{folderId}	El ID de la carpeta superior.	URL nueva
{folderResourceKey}	La clave de recurso de la carpeta superior.	URL nueva
{userId}	El ID de perfil que identifica al usuario.	Abrir URL y URL nueva
{action}	La acción que se está realizando. El valor es open cuando se usa una URL abierta, o create cuando se usa una URL nueva.	Abrir URL y URL nueva

El parámetro state está codificado como URL, por lo que tu app debe controlar los caracteres de escape y analizarlos como JSON. Las apps pueden detectar el valor create en el parámetro state a fin de verificar una solicitud para crear un archivo.

Ejemplo de información de estado en JSON para una URL nueva

La información de state de una URL nueva es la siguiente:

{
  "action":"create",
  "folderId":"FOLDER_ID",
  "folderResourceKey":"FOLDER_RESOURCE_KEY",
  "userId":"USER_ID"
}

Ejemplo de información de estado en JSON para una URL abierta

La información de state para una URL abierta es la siguiente:

{
  "ids": ["ID"],
  "resourceKeys":{"RESOURCE_KEYS":"RESOURCE_KEYS"},
  "action":"open",
  "userId":"USER_ID"
}

Los ID y las claves de recursos se usan para recuperar metadatos de archivo y descargar su contenido. Una vez que tu app tenga el ID y el token de acceso, podrá verificar los permisos, recuperar los metadatos y descargar el contenido como se describe en el método files.get.

Temas relacionados

Una app instalada debe poder crear, administrar y abrir acciones iniciadas desde la IU de Drive. Si deseas obtener más información, consulta Cómo integrar el botón "Nuevo" de la IU de Drive o Cómo integrar el menú contextual "Abrir con" de la IU de Drive.