La API de Google Drive te permite subir datos de archivos cuando creas o actualizas un File
. Para obtener información sobre cómo crear un File
solo de metadatos, consulta Cómo crear archivos.
Existen 3 tipos de cargas que puedes realizar:
Carga simple (
uploadType=media
): Usa este tipo de carga para transferir un archivo multimedia pequeño (5 MB o menos) sin proporcionar metadatos. Para realizar una carga simple, consulta Realiza una carga simple.Carga multiparte (
uploadType=multipart
): Usa este tipo de carga para transferir un archivo pequeño (5 MB o menos) junto con metadatos que describen el archivo, en una sola solicitud. Para realizar una carga multiparte, consulta Realiza una carga multiparte.Carga reanudable (
uploadType=resumable
): Usa este tipo de carga para archivos grandes (de más de 5 MB) y cuando haya una alta probabilidad de interrupción de red, como cuando se crea un archivo desde una app para dispositivos móviles. Las cargas reanudables también son una buena opción para la mayoría de las aplicaciones, ya que también funcionan con archivos pequeños a un costo mínimo de una solicitud HTTP adicional por carga. Para realizar una carga reanudable, consulta Realiza una carga reanudable.
Las bibliotecas cliente de la API de Google implementan al menos uno de estos tipos de cargas. Consulta la documentación de la biblioteca cliente para obtener detalles adicionales sobre cómo usar cada uno de los tipos.
Usa PATCH
en comparación con PUT
A modo de repaso, el verbo HTTP PATCH
admite una actualización parcial de recursos de archivo, mientras que el verbo HTTP PUT
admite el reemplazo completo de recursos. Ten en cuenta que PUT
puede introducir cambios rotundos cuando se agrega un campo nuevo a un recurso existente.
Cuando subas un recurso de archivo, sigue estos lineamientos:
- Usa el verbo HTTP documentado en la referencia de la API para la solicitud inicial de una carga reanudable o para la única solicitud de una carga simple o multiparte.
- Usa
PUT
para todas las solicitudes posteriores de una carga reanudable una vez que se inicie la solicitud. Estas solicitudes suben contenido sin importar al método al que se llama.
Realiza una carga simple
Para realizar una carga simple, usa el método files.create con uploadType=media
.
A continuación, se muestra cómo realizar una carga simple:
HTTP
Crea una solicitud
POST
para el URI /upload del método con el parámetro de consulta deuploadType=media
:POST https://www.googleapis.com/upload/drive/v3/files?uploadType=media
Agrega los datos del archivo al cuerpo de la solicitud.
Agrega los siguientes encabezados HTTP:
Content-Type
. Se establece como el tipo de medio MIME del objeto que se sube.Content-Length
. Se establece como la cantidad de bytes que subes. Si usas la codificación de transferencia fragmentada, este encabezado no es obligatorio.
Envía la solicitud. Si la solicitud se realiza correctamente, el servidor muestra el código de estado
HTTP 200 OK
junto con los metadatos del archivo. {HTTP}
Cuando realizas una carga simple, se crean metadatos básicos y algunos atributos se infieren del archivo, como el tipo de MIME o modifiedTime
. Puedes usar una carga simple en los casos en que tus archivos y metadatos de archivos no sean importantes.
Realiza una carga multiparte
Una solicitud de carga multiparte te permite subir metadatos y datos en la misma solicitud. Usa esta opción si los datos que envías son lo suficientemente pequeños como para volver a subirlos en su totalidad si falla la conexión.
Para realizar una carga multiparte, usa el método files.create con uploadType=multipart
.
A continuación, se muestra cómo realizar una carga multiparte:
Java
Python
Node.js
PHP
.NET
HTTP
Crea una solicitud
POST
para el URI /upload del método con el parámetro de consulta deuploadType=multipart
:POST https://www.googleapis.com/upload/drive/v3/files?uploadType=multipart
Crea el cuerpo de la solicitud. Da formato al cuerpo de acuerdo con el tipo de contenido multiparte/relacionado [RFC 2387], que contiene 2 partes:
- Metadatos. Los metadatos deben ir primero y deben tener un encabezado
Content-Type
configurado comoapplication/json;
charset=UTF-8
. Agrega los metadatos del archivo en formato JSON. - Contenido multimedia. Los elementos multimedia deben ir en segundo lugar y deben tener un encabezado
Content-Type
de cualquier tipo de MIME. Agrega los datos del archivo a la parte de contenido multimedia.
Identifica cada parte con una string de límite, precedida por 2 guiones. Además, agrega 2 guiones después de la última string de límite.
- Metadatos. Los metadatos deben ir primero y deben tener un encabezado
Agrega estos encabezados HTTP de nivel superior:
Content-Type
. Se establece comomultipart/related
y, además, incluye la string de límite que usas para identificar las diferentes partes de la solicitud. Por ejemplo:Content-Type: multipart/related; boundary=foo_bar_baz
.Content-Length
. Configurado como la cantidad total de bytes en el cuerpo de la solicitud.
Envía la solicitud.
Para crear o actualizar solo la parte de metadatos, sin los datos asociados, envía una solicitud POST
o PATCH
al extremo de recurso estándar: https://www.googleapis.com/drive/v3/files
. Si la solicitud se realiza correctamente, el servidor muestra el código de estado HTTP 200 OK
junto con los metadatos del archivo.
Cuando se crean archivos, deben especificar una extensión de archivo en el campo name
del archivo. Por ejemplo, cuando creas un archivo JPEG de foto, puedes especificar algo como "name": "photo.jpg"
en los metadatos. Las llamadas posteriores a files.get muestran la propiedad fileExtension
de solo lectura que contiene la extensión especificada originalmente en el campo name
.
Realiza una carga reanudable
Una carga reanudable te permite reanudar una operación de carga después de que una falla de comunicación interrumpa el flujo de datos. Debido a que no es necesario reiniciar las cargas de archivos grandes desde el principio, las cargas reanudables también pueden reducir el uso del ancho de banda si hay una falla de red.
Las cargas reanudables son útiles cuando los tamaños de tus archivos pueden variar mucho o cuando hay un límite de tiempo fijo para las solicitudes (como las tareas en segundo plano del SO móvil y ciertas solicitudes de App Engine). También puedes usar cargas reanudables para situaciones en las que desees mostrar una barra de progreso de carga.
Una carga reanudable consta de varios pasos de alto nivel:
- Envía la solicitud inicial y recupera el URI de la sesión reanudable.
- Sube los datos y supervisa el estado de carga.
- (Opcional) Si se interrumpe la carga, reanúdala.
Envía la solicitud inicial
Para iniciar una carga reanudable, usa el método files.create con uploadType=resumable
.
HTTP
Crea una solicitud
POST
para el URI /upload del método con el parámetro de consulta deuploadType=resumable
:POST https://www.googleapis.com/upload/drive/v3/files?uploadType=resumable
Si la solicitud de inicio se realiza correctamente, la respuesta incluye un código de estado HTTP
200 OK
. Además, incluye un encabezadoLocation
que especifica el URI de la sesión reanudable:HTTP/1.1 200 OK Location: https://www.googleapis.com/upload/drive/v3/files?uploadType=resumable&upload_id=xa298sd_sdlkj2 Content-Length: 0
Guarda el URI de la sesión reanudable para que puedas subir los datos del archivo y consultar el estado de la carga. Un URI de sesión reanudable vence después de una semana.
Si tienes metadatos para el archivo, agrégalos al cuerpo de la solicitud en formato JSON. De lo contrario, deja el cuerpo de la solicitud vacío.
Agrega los siguientes encabezados HTTP:
X-Upload-Content-Type
. Es opcional. Se establece en el tipo de MIME de los datos del archivo, que se transfieren en solicitudes posteriores. Si no se especifica el tipo de MIME de los datos en los metadatos ni a través de este encabezado, el objeto se entrega comoapplication/octet-stream.
.X-Upload-Content-Length
. Es opcional. Se establece como la cantidad de bytes de datos del archivo, que se transfieren en solicitudes posteriores.Content-Type
. Es obligatorio si existen metadatos para el archivo. Se establece enapplication/json;
charset=UTF-8
.Content-Length
. Es obligatorio, a menos que uses la codificación de transferencia fragmentada. Se establece como la cantidad de bytes en el cuerpo de esta solicitud inicial.
Envía la solicitud. Si la solicitud de inicio de sesión se realiza correctamente, la respuesta incluye un código de estado
200 OK HTTP
. Además, la respuesta incluye un encabezadoLocation
que especifica el URI de la sesión reanudable. Usa el URI de la sesión reanudable para subir los datos del archivo y consultar el estado de la carga. Un URI de sesión reanudable vence después de una semana.Copia y guarda la URL de la sesión reanudable.
Continúa con la sección Sube el contenido.
Sube el contenido
Existen 2 maneras de subir un archivo con una sesión reanudable:
- Sube contenido en una sola solicitud: Usa este enfoque cuando el archivo se pueda subir en una sola solicitud si no hay un límite de tiempo fijo para ninguna solicitud o si no necesitas mostrar un indicador de progreso de carga. Este enfoque es el mejor porque requiere menos solicitudes y da como resultado un mejor rendimiento.
Sube el contenido en varios fragmentos: Usa este enfoque si debes reducir la cantidad de datos que se transfieren en una sola solicitud. Es posible que debas reducir los datos transferidos cuando haya un límite de tiempo fijo para las solicitudes individuales, como puede ser el caso de ciertas clases de solicitudes de App Engine. Este enfoque también es útil si debes proporcionar un indicador personalizado para mostrar el progreso de la carga.
HTTP: solicitud única
- Crea una solicitud
PUT
para el URI de la sesión reanudable. - Agrega los datos del archivo al cuerpo de la solicitud.
- Agrega un encabezado HTTP Content-Length, establecido en la cantidad de bytes del archivo.
- Envía la solicitud. Si se interrumpe la solicitud de carga, o si recibes una respuesta
5xx
, sigue el procedimiento que se describe en Reanuda una carga interrumpida.
HTTP: Solicitudes múltiples
Crea una solicitud
PUT
para el URI de la sesión reanudable.Agrega los datos del fragmento al cuerpo de la solicitud. Crea fragmentos en múltiplos de 256 KB (256 x 1,024 bytes), excepto el último fragmento que completa la carga. El tamaño de los fragmentos debe ser lo más grande posible para que la carga sea eficiente.
Agrega los siguientes encabezados HTTP:
Content-Length
. Se establece en la cantidad de bytes del fragmento actual.Content-Range
. Se establece para que muestre qué bytes del archivo subes. Por ejemplo,Content-Range: bytes 0-524287/2000000
muestra que subes los primeros 524,288 bytes (256 x 1024 x 2) de un archivo de 2,000,000 bytes.
Envía la solicitud y procesa la respuesta. Si se interrumpe la solicitud de carga, o si recibes una respuesta
5xx
, sigue el procedimiento que se indica en Reanuda una carga interrumpida.Repite los pasos 1 a 4 para cada fragmento que quede en el archivo. Usa el encabezado
Range
en la respuesta para determinar dónde comenzar el siguiente fragmento. No des por sentado que el servidor recibió todos los bytes que se enviaron en la solicitud anterior.
Cuando se complete la carga del archivo, recibirás una respuesta 200 OK
o 201 Created
, junto con los metadatos asociados al recurso.
Reanuda una carga interrumpida
Si una solicitud de carga se finaliza antes de una respuesta o si recibes una respuesta 503 Service Unavailable
, debes reanudar la carga interrumpida.
HTTP
Crea una solicitud
PUT
vacía para el URI de sesión reanudable a fin de solicitar el estado de la carga.Agrega un encabezado
Content-Range
para indicar que se desconoce la posición actual en el archivo. Por ejemplo, configuraContent-Range
como*/2000000
si el tamaño total del archivo es de 2,000,000 bytes. Si desconoces el tamaño completo del archivo, configuraContent-Range
como*/*
.Envía la solicitud.
Procesa la respuesta:
- Una respuesta
200 OK
o201 Created
indica que se completó la carga y que no es necesario realizar ninguna otra acción. - Una respuesta
308 Resume Incomplete
indica que debes seguir subiendo el archivo. - Una respuesta
404 Not Found
indica que la sesión de carga venció y que la carga debe reiniciarse desde el principio.
- Una respuesta
Si recibiste una respuesta
308 Resume Incomplete
, procesa el encabezadoRange
de la respuesta para determinar qué bytes recibió el servidor. Si la respuesta no tiene un encabezadoRange
, significa que no se recibieron bytes. Por ejemplo, un encabezadoRange
debytes=0-42
indica que se recibieron los primeros 43 bytes del archivo y que el siguiente fragmento que se subiría comenzaría con el byte 44.Ahora que sabes dónde reanudar la carga, continúa con la carga del archivo a partir del siguiente byte. Incluye un encabezado
Content-Range
para indicar qué parte del archivo envías. Por ejemplo,Content-Range: bytes 43-1999999
indica que envías bytes 44 a 2,000,000.
Soluciona errores de carga de contenido multimedia
Cuando subas contenido multimedia, sigue estas prácticas recomendadas para solucionar los errores:
- En el caso de los errores
5xx
, reanuda o vuelve a intentar las cargas que fallan debido a interrupciones en la conexión. Para obtener más información sobre cómo manejar los errores5xx
, consulta Cómo resolver un error5xx
. - Si hay
403 rate limit
errores, vuelve a subirlo. Para obtener más información sobre cómo manejar los errores403 rate limit
, consulta Cómo resolver un error403 error: Rate limit exceeded
. - Si se produce algún error
4xx
(incluido403
) durante una carga reanudable, reinicia la carga. Estos errores indican que la sesión de carga venció y debes solicitar un nuevo URI de sesión para reiniciarla. Las sesiones de carga también vencen después de una semana de inactividad.
Importar a tipos de Documentos de Google
Cuando creas un archivo en Drive, es posible que desees convertirlo en un tipo de archivo de Google Workspace, como un documento o una hoja de cálculo de Google. Por ejemplo, tal vez quieras convertir un documento de tu procesador de textos favorito en un documento de Google para aprovechar sus funciones.
Para convertir un archivo en un tipo de archivo de Google Workspace específico, especifica el mimeType
de Google Workspace cuando lo crees.
A continuación, se muestra cómo convertir un archivo CSV en una hoja de Google Workspace:
Java
Python
Node.js
PHP
.NET
Para saber si hay una conversión disponible, consulta el array importFormats
del recurso Acerca de antes de crear el archivo. Las conversiones admitidas están disponibles de forma dinámica en este array. Estos son algunos formatos de importación comunes:
De | Para |
---|---|
Microsoft Word, OpenDocument Text, HTML, RTF, texto sin formato | Documentos de Google |
Microsoft Excel, OpenDocument Sheet, CSV, TSV, texto sin formato | Hojas de cálculo de Google |
Microsoft PowerPoint y OpenDocument Presentación | Presentaciones de Google |
JPEG, PNG, GIF, BMP y PDF | Documentos de Google (incorpora la imagen en un documento) |
Texto sin formato (tipo de MIME especial), JSON | Google Apps Script |
Cuando subes y conviertes contenido multimedia durante una solicitud update
en un documento, hoja de cálculo o presentación, se reemplaza todo el contenido del documento.
Cuando conviertes una imagen en un documento, Drive usa el reconocimiento óptico de caracteres (OCR) para convertir la imagen en texto. Puedes mejorar la calidad del algoritmo de OCR si especificas el código de idioma BCP 47 aplicable en el parámetro ocrLanguage
.
El texto extraído aparecerá en el documento junto a la imagen incorporada.
Cómo usar un ID generado previamente para subir archivos
La API de Drive te permite recuperar una lista de ID de archivos pregenerados que se usan para subir y crear recursos. Las solicitudes de carga y creación de archivos pueden usar estos IDs generados previamente. Establece el campo id
en los metadatos del archivo.
Para crear ID pregenerados, llama a file.generateIds con la cantidad de ID que crearás.
Si hay un error o tiempo de espera indeterminados del servidor, puedes volver a intentar las cargas de forma segura con IDs generados previamente. Si el archivo se creó de forma correcta, los reintentos posteriores mostrarán un error HTTP 409
y no crearán archivos duplicados.
Define el texto indexable para tipos de archivo desconocidos
Los usuarios pueden usar la IU de Drive para buscar contenido del documento. También puedes usar files.list y el campo fullText
para buscar contenido de tu app. Si deseas obtener más información, consulta Cómo buscar archivos y carpetas.
Drive indexa de forma automática los documentos para la búsqueda cuando reconoce el tipo de archivo, incluidos los documentos de texto, los PDF, las imágenes con texto y otros tipos comunes. Si tu app guarda otros tipos de archivos (como dibujos, videos y accesos directos), puedes mejorar la visibilidad proporcionando texto indexable en el campo contentHints.indexableText
del archivo.
Para obtener más información sobre el texto indexable, consulta Administra metadatos de archivos.