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, puedes primero debes configurar una integración en la interfaz de usuario (IU) de Drive. También se requiere la configuración para que tu app aparezca en la Google Workspace Marketplace

Habilita la API de Drive

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

Para comenzar la integración con la IU de Google Drive, debes habilitar el API de Drive Esto te da acceso a la API y a la integración de la IU atributos.

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

  Habilitar la API

Configura la integración de la IU de Drive

1. En la Consola de APIs de Google, ve a Menú . > APIs y Servicios > APIs habilitadas y Google Cloud.

   Ir a APIs habilitadas y servicios

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

7. Sube uno o más Íconos de aplicación para que se muestren en la lista de elementos de un usuario en las apps de Drive conectadas y en la pestaña menú contextual. Los íconos deben estar en formato PNG con fondo transparente. Los iconos pueden tardar hasta 24 horas en aparecer en Drive.

   Nota: Los íconos de documentos dejaron de estar disponibles. El ícono de tu aplicación aparecerá a continuación a archivos de atajos de terceros y de terceros. Se usa un conjunto de íconos estándar para otros tipos de archivos.

8. Para usar la función Abrir con menú item, ingresa la URL de tu app en la Campo Abrir URL. Esta URL se utiliza en la sección "Abrir con" menú contextual.

   • Esta URL debe contener un nombre de dominio completo. localhost no el trabajo.
   • Los usuarios previstos de tu aplicación deben poder acceder a la URL. Si tienes varias versiones de la aplicación, como una para la versión pública lanzamiento y uno para el lanzamiento restringido a determinados usuarios, cada versión debe usar una URL única. Luego, puedes crear diferentes parámetros de configuración para cada versión.
   • Debes verificar la propiedad de esta URL para publicar tu app en Google Workspace Marketplace.
   • De forma predeterminada, se agrega un parámetro de consulta state a esta URL para pasar datos de la IU de Drive a tu app. Para obtener información sobre el contenido del parámetro state; consulta la state parámetro.
   Advertencia: La opción para mostrar automáticamente la pantalla de consentimiento de OAuth 2.0 es obsoleto. No marques esta casilla. La aplicación debe iniciar todas las autorizaciones solicitudes.

9. (Opcional) Ingresa los tipos de MIME y las extensiones de archivo predeterminados en la Campos Tipos de MIME predeterminados y Extensiones de archivo predeterminadas MIME predeterminado Los tipos y las extensiones de archivo representan los archivos para los que tu app está creada de manera única. abiertos. Por ejemplo, tu app podría abrir un formato integrado para superponer y editar imágenes. Incluir solo contenido multimedia estándar tipos y asegúrate de que no contengan errores ortográficos ni errores ortográficos. Si la app solo abre o de terceros, puedes dejar el tipo de MIME en blanco.

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

    Nota: Si un usuario instala varias apps de Drive que pueden abrir una se utiliza la última aplicación instalada hasta que el usuario elige otra

11. Para usar los elementos “Nuevo” de la IU de Drive y pídeles a los usuarios que creen un archivo con tu app, marca la casilla Crear archivos. La URL nueva y los campos opcionales Aparecerán los campos Nombre del documento.

    • Esta URL debe contener un nombre de dominio completo. localhost no el trabajo.
    • Debes verificar la propiedad de esta URL para publicar tu app en Google Workspace Marketplace.
    • De forma predeterminada, se agrega un parámetro de consulta state a esta URL para pasar datos de la IU de Drive a tu app. Para obtener información sobre el contenido del parámetro state; consulta la state parámetro.

12. Ingresa una URL en el campo URL nueva. Los "Nuevos" utilizan esta URL botón para redireccionar al usuario a tu aplicación.

    Nota: Deja el campo Nombre del documento en blanco. Este campo ya no se utiliza.

13. (Opcional) Si quieres que tu app abra archivos compatibles con Google Workspace, Marca la casilla Importando.

14. (Opcional) Si tu app debe administrar archivos en unidades compartidas, revisa el Compatibilidad con unidades compartidas. Para obtener más información unidades compartidas en tu app, consulta Cómo implementar unidades compartidas asistencia.

15. Haz clic en Enviar.

Solicita el permiso drive.install

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

Figura 1: Diálogo de instalación cuando se usan los permisos para la IU de Drive.

Para más información sobre los permisos que puede solicitar en las aplicaciones de Drive, y cómo solicitarlas, consulta Autorización y autenticación específicas de la API información.

Nota: Si publicas tu app de Drive en Google Workspace Marketplace, los usuarios y administradores de dominios pueden busca e instala la aplicación directamente desde la Google Workspace Marketplace.

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 de la IU de Drive a tu app. Este parámetro contiene una cadena codificada en JSON con variables de plantilla y datos sobre el a la app. Las variables incluidas dependen del tipo de URL utilizado (Abrir URL o URL nueva):

Variable de plantilla	Descripción	Solicitud de URL
{ids}	Una lista separada por comas de los ID de archivo que se abren.	Abrir URL
{exportIds}	Una lista separada por comas de los ID de archivo que se están exportando (solo se usan al abrir un documento de Google integrado).	Abrir URL
{resourceKeys}	Un diccionario JSON de IDs de archivo asignados a su recurso respectivo claves.	Abrir URL
{folderId}	El ID de la carpeta superior.	URL nueva
{folderResourceKey}	La clave del recurso de la carpeta superior.	URL nueva
{userId}	Es el ID de perfil que identifica al usuario.	Abrir URL y URL nueva
{action}	Indica la acción que se realiza. El valor es open cuando se usa una URL abierta o create cuando uses una URL nueva.	Abrir URL y URL nueva

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

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

La información de state para 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 IDs y las claves de recursos se usan para recuperar metadatos del archivo y descargar archivos contenido. Una vez que tu app tenga el ID de archivo y un token de acceso, podrá verificar permisos, recuperar los metadatos del archivo y descargar el contenido del archivo como se describe En el método files.get

Nota: Todas las apps, incluidas las que abren archivos desde accesos directos y archivos de terceros atajos, debe llamar al files.get para verificar los permisos de un usuario en un documento. Las apps deben advertir usuarios con acceso de lectura cuando abren un archivo que no pueden editar ni guardar (en lugar de lo que les permite dedicar tiempo a editar y, luego, mostrar un error al guardar).

Temas relacionados

Una app instalada debe poder crear, administrar y abrir acciones iniciadas desde la IU de Drive. Para obtener más información, consulta Integra con "Nuevo" de la IU de Drive o Integración con la función “Abrir con” de la IU de Drive contexto en el menú desplegable.