Interfejs Google Drive API obsługuje kilka typów działań związanych z pobieraniem i eksportowaniem, które są wymienione w tej tabeli:
| Działania związane z pobieraniem |
|
||||
| Eksportowanie działań |
|
W interfejsie Drive API plik blob to dowolny surowy plik binarny przechowywany na Dysku Google (np. obrazy, filmy i pliki PDF) w przeciwieństwie do dokumentu Google Workspace. Nie odnosi się do obiektu Blob w JavaScript. Szczegółowe opisy wymienionych tutaj typów plików, w tym plików blob i plików Google Workspace, znajdziesz w artykule Typy plików.
Zanim pobierzesz lub wyeksportujesz zawartość pliku, sprawdź, czy użytkownicy mogą pobrać plik za pomocą pola capabilities.canDownload w zasobie files.
W pozostałej części tego dokumentu znajdziesz szczegółowe instrukcje wykonywania tych typów działań związanych z pobieraniem i eksportowaniem.
Pobieranie zawartości pliku binarnego
Aby pobrać plik binarny przechowywany na Dysku, użyj metody files.get z identyfikatorem pliku do pobrania i alt parametrem system.
Parametr alt=media informuje serwer, że żądane jest pobranie treści jako alternatywnego formatu odpowiedzi.
Parametr systemowy alt jest dostępny we wszystkich interfejsach API REST Google. Jeśli używasz biblioteki klienta interfejsu Drive API, nie musisz jawnie ustawiać tego parametru, ponieważ metoda biblioteki klienta dodaje parametr alt=media do podstawowego żądania HTTP.
Poniższe przykłady kodu pokazują, jak używać metody files.get do pobierania pliku:
Google Apps Script
/**
* Downloads a file from Drive.
* @param {string} fileId The ID of the file to download.
* @return {Blob} The file content as a Blob.
*/
function downloadFile(fileId) {
var url = 'https://www.googleapis.com/drive/v3/files/' + fileId + '?alt=media';
var response = UrlFetchApp.fetch(url, {
headers: {
'Authorization': 'Bearer ' + ScriptApp.getOAuthToken()
}
});
return response.getBlob();
}
Java
Python
Node.js
PHP
.NET
curl
curl -L "https://www.googleapis.com/drive/v3/files/FILE_ID?alt=media" \
--header "Authorization: Bearer ACCESS_TOKEN" \
--output "FILE_NAME"
Zastąp te elementy:
- FILE_ID: identyfikator pliku do pobrania.
- ACCESS_TOKEN: token dostępu, który przyznaje dostęp do interfejsu API.
- FILE_NAME: nazwa pliku wyjściowego.
Pobieranie plików rozpoczęte w aplikacji musi być autoryzowane za pomocą zakresu, który umożliwia dostęp do treści pliku w trybie odczytu. Na przykład aplikacja korzystająca z zakresu
drive.readonly.metadata nie ma uprawnień do pobierania zawartości pliku.
Przykłady kodu biblioteki klienta używają ograniczonego zakresu pliku drive, który umożliwia użytkownikom wyświetlanie wszystkich plików na Dysku i zarządzanie nimi. Więcej informacji o zakresach Dysku znajdziesz w artykule Wybieranie zakresów interfejsu Google Drive API.
Użytkownicy z uprawnieniami owner (w przypadku plików na Moim dysku) lub organizer (w przypadku plików na dysku współdzielonym) mogą ograniczyć pobieranie za pomocą obiektu DownloadRestrictionsMetadata. Więcej informacji znajdziesz w artykule Uniemożliwianie użytkownikom pobierania, drukowania i kopiowania pliku.
Pliki uznane za nadużycia (np. szkodliwe oprogramowanie) może pobrać tylko właściciel pliku.
Dodatkowo parametr zapytania acknowledgeAbuse musi mieć wartość true, aby wskazywać, że użytkownik potwierdził, że zdaje sobie sprawę z ryzyka pobrania potencjalnie niechcianego oprogramowania lub innych szkodliwych plików. Przed użyciem tego parametru zapytania aplikacja powinna interaktywnie ostrzec użytkownika.
Dostęp do danych pliku w pamięci
Jeśli aplikacja musi uzyskać dostęp do danych pliku bezpośrednio w pamięci (np. jako bufor bajtów), zamiast zapisywać je na dysku lokalnym, możesz dostosować żądanie biblioteki klienta lub przetworzyć zwrócony strumień:
Node.js domyślnie biblioteka klienta Node.js zwraca zawartość pliku jako strumień
Readable. Aby zapisać plik na dysku lokalnym:const fs = require('fs'); const dest = fs.createWriteStream('/path/to/dest/file.ext'); const response = await service.files.get( { fileId, alt: 'media' }, { responseType: 'stream' } ); response.data .on('end', () => { console.log('Download complete.'); }) .on('error', (err) => { console.error('Error downloading file.', err); }) .pipe(dest);Aby zwrócić dane bezpośrednio w pamięci jako
ArrayBufferzamiast strumienia, ustaw parametrresponseTypew opcjach żądania:const file = await service.files.get({ fileId, alt: 'media', }, { responseType: 'arraybuffer' }); // Convert the ArrayBuffer to a Node.js Buffer object. const buffer = Buffer.from(file.data);Python: przykładowy kod w Pythonie do pobierania pliku blob zapisuje już pobrane fragmenty do obiektu
io.BytesIO()w pamięci. Aby uzyskać dostęp do surowych bajtów, wywołaj funkcjęfile.getvalue().Java: przykładowy kod w języku Java do pobierania pliku blob używa
java.io.ByteArrayOutputStreamdo przechwytywania pobranych bajtów w pamięci. UżyjoutputStream.toByteArray(), aby uzyskać dostęp do surowej tablicy bajtów..NET: Przykładowy kod w języku C# do pobierania pliku binarnego korzysta z
System.IO.MemoryStream. Użyjstream.ToArray(), aby uzyskać dostęp do bazowej tablicy bajtów.Apps Script: przykładowy kod Apps Script do pobierania pliku blob korzysta z metody
response.getBlob(), aby zwrócić obiektBlob. Przekonwertuj go na tablicę bajtów za pomocą metodygetBytes().
Częściowe pobieranie
Pobieranie częściowe polega na pobraniu tylko określonej części pliku. Możesz określić część pliku, którą chcesz pobrać, używając zakresu bajtów z nagłówkiem Range. Na przykład:
Range: bytes=500-999
Pobieranie zawartości pliku binarnego w starszej wersji
Aby pobrać zawartość plików blob w starszej wersji, użyj metody revisions.get z identyfikatorem pliku do pobrania, identyfikatorem wersji i alt parametrem system.
Parametr alt=media informuje serwer, że żądane jest pobranie treści jako alternatywnego formatu odpowiedzi. Podobnie jak w przypadku metody files.get, metoda revisions.get też akceptuje parametr zapytania acknowledgeAbuse i nagłówek Range.
Możesz pobrać tylko te wersje treści plików binarnych, które są oznaczone jako „Zachowaj na zawsze”. Jeśli chcesz pobrać wersję, najpierw ustaw ją na „Zachowaj na zawsze”. Więcej informacji znajdziesz w artykule Określanie wersji, które mają być zapisywane przed automatycznym usunięciem.
Więcej informacji o pobieraniu wersji znajdziesz w artykule Zarządzanie długotrwałymi operacjami.
curl
curl -L "https://www.googleapis.com/drive/v3/files/FILE_ID/revisions/REVISION_ID?alt=media" \
--header "Authorization: Bearer ACCESS_TOKEN" \
--output "FILE_NAME"
Zastąp te elementy:
- FILE_ID: identyfikator pliku do pobrania.
- REVISION_ID: identyfikator wersji do pobrania.
- ACCESS_TOKEN: token dostępu, który przyznaje dostęp do interfejsu API.
- FILE_NAME: nazwa pliku wyjściowego.
Pobieranie zawartości pliku binarnego w przeglądarce
Aby pobrać zawartość plików binarnych przechowywanych na Dysku w przeglądarce zamiast za pomocą interfejsu API, użyj pola webContentLink zasobu files. Jeśli użytkownik ma dostęp do pobierania pliku, zwracany jest link do pobrania pliku i jego zawartości. Możesz przekierować użytkownika na ten adres URL lub udostępnić go jako klikalny link.
curl
curl "https://www.googleapis.com/drive/v3/files/FILE_ID?fields=webContentLink" \
--header "Authorization: Bearer ACCESS_TOKEN" \
--header "Accept: application/json"
Zastąp te elementy:
- FILE_ID: identyfikator pliku, dla którego chcesz uzyskać link do pobierania.
- ACCESS_TOKEN: token dostępu, który przyznaje dostęp do interfejsu API.
Pobieranie zawartości pliku binarnego za pomocą długotrwałych operacji
Aby pobrać zawartość plików binarnych za pomocą długotrwałych operacji (LRO), użyj metody files.download z identyfikatorem pliku do pobrania. Opcjonalnie możesz ustawić identyfikator wersji.
To jedyny sposób pobierania plików Google Vids. Jeśli spróbujesz wyeksportować pliki Google Vids, pojawi się błąd fileNotExportable.
Więcej informacji znajdziesz w artykule Zarządzanie długotrwałymi operacjami.
curl
Poniższe polecenie curl inicjuje LRO i zwraca odpowiedź JSON. Aby pobrać plik lub sprawdzić ten LRO, musisz wysłać kolejne żądanie z użyciem zwróconego identyfikatora, aby uzyskać adres URL treści. Następnie możesz wysłać do tego adresu URL końcowe żądanie curl, aby pobrać plik. Więcej informacji znajdziesz w artykule Zarządzanie długotrwałymi operacjami.
curl --request POST "https://www.googleapis.com/drive/v3/files/FILE_ID/download?mimeType=video/mp4" \
--header "Authorization: Bearer ACCESS_TOKEN" \
--header "Content-Length: 0" \
--header "Accept: application/json"
Zastąp te elementy:
- FILE_ID: identyfikator pliku do pobrania.
- ACCESS_TOKEN: token dostępu, który przyznaje dostęp do interfejsu API.
Eksportowanie treści dokumentu Google Workspace
Aby wyeksportować zawartość bajtową dokumentu Google Workspace, użyj metody files.export z identyfikatorem pliku do wyeksportowania i prawidłowym typem MIME. Eksportowane treści są ograniczone do 10 MB.
Poniższe przykłady kodu pokazują, jak za pomocą metody files.export wyeksportować dokument Google Workspace w formacie PDF:
Google Apps Script
/**
* Exports a Google Workspace document.
* @param {string} fileId The ID of the file to export.
* @param {string} mimeType The MIME type to export to.
* @return {Blob} The exported content as a Blob.
*/
function exportPdf(fileId, mimeType) {
var url = 'https://www.googleapis.com/drive/v3/files/' + fileId + '/export?mimeType=' + encodeURIComponent(mimeType);
var response = UrlFetchApp.fetch(url, {
headers: {
'Authorization': 'Bearer ' + ScriptApp.getOAuthToken()
}
});
return response.getBlob();
}
Java
Python
Node.js
PHP
.NET
curl
curl -L "https://www.googleapis.com/drive/v3/files/FILE_ID/export?mimeType=application/pdf" \
--header "Authorization: Bearer ACCESS_TOKEN" \
--output "FILE_NAME.pdf"
Zastąp te elementy:
- FILE_ID: identyfikator pliku do pobrania.
- ACCESS_TOKEN: token dostępu, który przyznaje dostęp do interfejsu API.
- FILE_NAME: nazwa pliku wyjściowego.
Przykłady kodu w bibliotece klienta korzystają z ograniczonego zakresu drive, który umożliwia użytkownikom wyświetlanie wszystkich plików na Dysku i zarządzanie nimi. Więcej informacji o zakresach Dysku znajdziesz w artykule Wybieranie zakresów interfejsu Google Drive API.
W przykładowych kodach typ MIME eksportu jest też deklarowany jako application/pdf. Pełną listę wszystkich typów MIME eksportu obsługiwanych w przypadku każdego dokumentu Google Workspace znajdziesz w artykule Typy MIME eksportu w przypadku dokumentów Google Workspace.
Eksportowanie zawartości dokumentu Google Workspace w przeglądarce
Aby wyeksportować zawartość dokumentu Google Workspace w przeglądarce, użyj pola
exportLinks zasobu
files. W zależności od typu dokumentu dla każdego dostępnego typu MIME zwracany jest link do pobrania pliku i jego zawartości. Możesz przekierować użytkownika na adres URL lub zaoferować go jako klikalny link.
curl
curl "https://www.googleapis.com/drive/v3/files/FILE_ID?fields=id,name,exportLinks" \
--header "Authorization: Bearer ACCESS_TOKEN" \
--header "Accept: application/json"
Zastąp te elementy:
- FILE_ID: identyfikator pliku, dla którego chcesz uzyskać link do pobierania.
- ACCESS_TOKEN: token dostępu, który przyznaje dostęp do interfejsu API.
Eksportowanie zawartości dokumentu Google Workspace w starszej wersji w przeglądarce
Aby wyeksportować zawartość dokumentu Google Workspace w starszej wersji w przeglądarce, użyj metody revisions.get z identyfikatorem pliku do pobrania i identyfikatorem wersji, aby wygenerować link do eksportu, z którego możesz pobrać plik. Jeśli użytkownik ma dostęp do pobierania pliku, zwracany jest link do pobrania pliku i jego zawartości. Możesz przekierować użytkownika na ten adres URL lub udostępnić go jako link, który można kliknąć.
curl
curl "https://www.googleapis.com/drive/v3/files/FILE_ID/revisions/REVISION_ID?fields=id,name,exportLinks" \
--header "Authorization: Bearer ACCESS_TOKEN" \
--header "Accept: application/json"
Zastąp te elementy:
- FILE_ID: identyfikator pliku do pobrania.
- REVISION_ID: identyfikator wersji do pobrania.
- ACCESS_TOKEN: token dostępu, który przyznaje dostęp do interfejsu API.
Eksportowanie treści dokumentów Google Workspace za pomocą operacji długotrwałych
Aby wyeksportować zawartość dokumentu Google Workspace za pomocą długotrwałych operacji (LRO), użyj metody files.download z identyfikatorem pliku do pobrania i identyfikatorem wersji. Więcej informacji znajdziesz w artykule Zarządzanie długotrwałymi operacjami.
curl
Poniższe polecenie curl inicjuje LRO i zwraca odpowiedź JSON. Aby pobrać plik lub sprawdzić stan tego LRO, musisz wysłać kolejne żądanie z użyciem zwróconego identyfikatora, aby uzyskać adres URL treści. Następnie możesz wysłać do tego adresu URL końcowe żądanie curl, aby pobrać plik. Więcej informacji znajdziesz w artykule Zarządzanie długotrwałymi operacjami.
curl --request POST "https://www.googleapis.com/drive/v3/files/FILE_ID/download?mimeType=MIME_TYPE&revisionId=REVISION_ID" \
--header "Authorization: Bearer ACCESS_TOKEN" \
--header "Content-Length: 0" \
--header "Accept: application/json"
Zastąp te elementy:
- FILE_ID: identyfikator pliku do pobrania.
- MIME_TYPE: typ MIME, do którego chcesz wyeksportować dane.
- REVISION_ID: identyfikator wersji do pobrania.
- ACCESS_TOKEN: token dostępu, który przyznaje dostęp do interfejsu API.