Google Drive API obsługuje kilka typów działań związanych z pobieraniem i eksportowaniem, które są wymienione w tabeli poniżej:
| Działania związane z pobieraniem |
|
||||
| Działania związane z eksportowaniem |
|
W 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
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 blob
Aby pobrać plik blob przechowywany na Dysku, użyj metody files.get z identyfikatorem pliku do pobrania i parametrem
alt systemowym.
Parametr alt=media informuje serwer, że żądanie pobrania treści jest alternatywnym formatem odpowiedzi.
Parametr systemowy alt jest dostępny we wszystkich interfejsach Google REST API. Jeśli używasz biblioteki klienta 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:
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 odczyt zawartości pliku. Na przykład aplikacja korzystająca z zakresu drive.readonly.metadata nie jest uprawniona do pobierania zawartości pliku.
Przykłady kodu biblioteki klienta używają ograniczonego zakresu plików 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ą
DownloadRestrictionsMetadata
obiektu. Więcej informacji znajdziesz w artykule Uniemożliwianie użytkownikom pobierania, drukowania i
kopiowania pliku.
Pliki uznane za obraźliwe
(np. szkodliwe oprogramowanie) mogą być pobierane tylko przez właściciela pliku.
Dodatkowo parametr zapytania acknowledgeAbuse musi być ustawiony na true, aby wskazać, że użytkownik zdaje sobie sprawę z ryzyka pobrania potencjalnie niechcianego oprogramowania lub innych obraźliwych 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 mieć dostęp do danych pliku bezpośrednio w pamięci (np. jako bufor bajtów), a nie zapisywać ich 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);Możesz też ustawić parametr
responseTypew opcjach żądania, aby dane były zwracane bezpośrednio w pamięci jakoArrayBufferzamiast strumienia: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 już zapisuje pobrane fragmenty w obiekcie
io.BytesIO()w pamięci. Aby uzyskać dostęp do surowych bajtów, wywołajfile.getvalue().Java: przykładowy kod w Javie do pobierania pliku blob używa
java.io.ByteArrayOutputStreamdo przechwytywania pobranych bajtów w pamięci. Aby uzyskać dostęp do surowej tablicy bajtów, użyjoutputStream.toByteArray()..NET: Przykładowy kod w C# do pobierania pliku blob używa
System.IO.MemoryStream. Aby uzyskać dostęp do podstawowej tablicy bajtów, użyjstream.ToArray().Apps Script: Przykładowy kod w Apps Script do pobierania pliku blob używa metody
response.getBlob()do zwracania obiektuBlob. Aby przekonwertować go na tablicę bajtów, użyj metodygetBytes().
Pobieranie częściowe
Pobieranie częściowe polega na pobieraniu tylko określonej części pliku. Możesz
określić część pliku, którą chcesz pobrać, używając zakresu
bajtów z
Range nagłówkiem. Na przykład:
Range: bytes=500-999
Pobieranie zawartości pliku blob 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
systemowym.
Parametr alt=media informuje serwer, że żądanie pobrania treści jest alternatywnym formatem odpowiedzi. Podobnie jak files.get, metoda revisions.get akceptuje też parametr zapytania acknowledgeAbuse i nagłówek Range.
Możesz pobierać tylko wersje zawartości plików blob, 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.
Dodatkowe informacje o pobieraniu wersji znajdziesz w artykule Zarządzanie operacjami długotrwałymi.
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 blob w przeglądarce
Aby pobrać zawartość plików blob przechowywanych na Dysku w
przeglądarce, a nie 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 link, który można kliknąć.
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 pobrania.
- ACCESS_TOKEN: token dostępu, który przyznaje dostęp do interfejsu API.
Pobieranie zawartości pliku blob za pomocą operacji długotrwałych
Aby pobrać zawartość plików blob za pomocą operacji długotrwałych (LRO), użyj
metody files.download z identyfikatorem
pliku do pobrania. Opcjonalnie możesz ustawić identyfikator wersji.
Jest to jedyny sposób na pobranie plików Google Vids. Jeśli spróbujesz wyeksportować
pliki Google Vids, otrzymasz
fileNotExportable błąd.
Więcej informacji znajdziesz w artykule Zarządzanie operacjami długotrwałymi.
curl
To polecenie curl inicjuje LRO i zwraca odpowiedź JSON. Aby pobrać plik lub sprawdzić stan tej LRO, musisz wysłać kolejne żądanie z zwróconym identyfikatorem, aby uzyskać adres URL treści. Następnie możesz wysłać ostateczne żądanie curl na ten adres URL, aby pobrać plik. Więcej informacji znajdziesz w artykule Zarządzanie operacjami długotrwałymi.
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 zawartoś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. Wyeksportowana zawartość może mieć maksymalnie 10 MB.
Poniższe przykłady kodu pokazują, jak używać metody files.export do eksportowania dokumentu Google Workspace w formacie PDF:
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 biblioteki klienta używają 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.
Przykłady kodu deklarują też typ MIME eksportu 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 zwracany jest link do pobrania pliku i jego zawartości dla każdego dostępnego typu MIME. 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?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 pobrania.
- 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 zawartości dokumentu Google Workspace za pomocą operacji długotrwałych
Aby wyeksportować zawartość dokumentu Google Workspace za pomocą operacji długotrwałych
(LRO), użyj metody files.download z
identyfikatorem pliku do pobrania i identyfikatorem wersji. Więcej informacji znajdziesz w artykule Zarządzanie operacjami długotrwałymi.
curl
To polecenie curl inicjuje LRO i zwraca odpowiedź JSON. Aby pobrać plik lub sprawdzić stan tej LRO, musisz wysłać kolejne żądanie z zwróconym identyfikatorem, aby uzyskać adres URL treści. Następnie możesz wysłać ostateczne żądanie curl na ten adres URL, aby pobrać plik. Więcej informacji znajdziesz w artykule Zarządzanie operacjami długotrwałymi.
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ć plik.
- REVISION_ID: identyfikator wersji do pobrania.
- ACCESS_TOKEN: token dostępu, który przyznaje dostęp do interfejsu API.