Plik na Dysku Google. Pliki możesz otwierać i tworzyć na stronie DriveApp
.
// Trash every untitled spreadsheet that hasn't been updated in a week. var files = DriveApp.getFilesByName('Untitled spreadsheet'); while (files.hasNext()) { var file = files.next(); if (new Date() - file.getLastUpdated() > 7 * 24 * 60 * 60 * 1000) { file.setTrashed(true); } }
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
addCommenter(emailAddress) | File | Dodaj danego użytkownika do listy komentujących (File ). |
addCommenter(user) | File | Dodaj danego użytkownika do listy komentujących (File ). |
addCommenters(emailAddresses) | File | Dodaj daną tablicę użytkowników do listy komentujących element File . |
addEditor(emailAddress) | File | Dodaje danego użytkownika do listy edytorów elementu File . |
addEditor(user) | File | Dodaje danego użytkownika do listy edytorów elementu File . |
addEditors(emailAddresses) | File | Dodaje podaną tablicę użytkowników do listy edytorów obiektu File . |
addViewer(emailAddress) | File | Dodaje danego użytkownika do listy gogli File . |
addViewer(user) | File | Dodaje danego użytkownika do listy gogli File . |
addViewers(emailAddresses) | File | Dodaje podaną tablicę użytkowników do listy widzów obiektu File . |
getAccess(email) | Permission | Pobiera uprawnienia przyznane danemu użytkownikowi. |
getAccess(user) | Permission | Pobiera uprawnienia przyznane danemu użytkownikowi. |
getAs(contentType) | Blob | Zwraca dane wewnątrz tego obiektu w postaci obiektu blob przekonwertowanego na określony typ treści. |
getBlob() | Blob | Zwraca dane wewnątrz tego obiektu jako obiekt blob. |
getDateCreated() | Date | Pobiera datę utworzenia zasobu File . |
getDescription() | String | Pobiera opis elementu File . |
getDownloadUrl() | String | Pobiera adres URL, którego można użyć do pobrania pliku. |
getEditors() | User[] | Pobiera listę edytorów na koncie File . |
getId() | String | Pobiera identyfikator File . |
getLastUpdated() | Date | Pobiera datę ostatniej aktualizacji elementu File . |
getMimeType() | String | Pobiera typ MIME pliku. |
getName() | String | Pobiera nazwę File . |
getOwner() | User | Pobiera właściciela pliku. |
getParents() | FolderIterator | Pobiera kolekcję folderów, które są bezpośrednimi elementami nadrzędnym folderu File . |
getResourceKey() | String | Pobiera klucz zasobu File , który jest wymagany do uzyskania dostępu do elementów udostępnionych przy użyciu linku. |
getSecurityUpdateEligible() | Boolean | Określa, czy File może stosować aktualizację zabezpieczeń, która wymaga dostępu do zasobu za pomocą linku. |
getSecurityUpdateEnabled() | Boolean | Określa, czy to File wymaga dostępu do zasobu za pomocą linku. |
getSharingAccess() | Access | Określa, do jakiej klasy użytkowników oprócz File mają mieć dostęp inni użytkownicy. |
getSharingPermission() | Permission | Pobiera uprawnienia przyznawane użytkownikom, którzy mają dostęp do File , oraz wszystkie osoby, którym jednoznacznie przyznano dostęp. |
getSize() | Integer | Pobiera liczbę bajtów przechowywanych na Dysku: File . |
getTargetId() | String | Jeśli jest to skrót, zwraca identyfikator elementu, do którego prowadzi. |
getTargetMimeType() | String | Jeśli jest to skrót, zwraca typ MIME elementu, do którego prowadzi. |
getTargetResourceKey() | String | Jeśli plik jest skrótem, zwraca klucz zasobu wskazanego elementu. |
getThumbnail() | Blob | Pobiera miniaturę pliku lub null , jeśli nie ma miniatury. |
getUrl() | String | Pobiera adres URL, którego można użyć do otwarcia elementu File w aplikacji Google, takiej jak Dysk czy Dokumenty. |
getViewers() | User[] | Pobiera listę widzów i komentujących ten element (File ). |
isShareableByEditors() | Boolean | Określa, czy użytkownicy z uprawnieniami do edycji elementu File mogą udostępniać pliki innym użytkownikom lub zmieniać uprawnienia. |
isStarred() | Boolean | Określa, czy plik File został oznaczony na Dysku użytkownika. |
isTrashed() | Boolean | Określa, czy plik File znajduje się w koszu na Dysku użytkownika. |
makeCopy() | File | Tworzy kopię pliku. |
makeCopy(destination) | File | Tworzy kopię pliku z katalogu docelowego. |
makeCopy(name) | File | Tworzy kopię pliku i nadaje mu nazwę. |
makeCopy(name, destination) | File | Tworzy kopię pliku w katalogu docelowym i nadaje mu nazwę. |
moveTo(destination) | File | Przenosi ten element do podanego folderu docelowego. |
removeCommenter(emailAddress) | File | Usunięcie użytkownika z listy komentujących: File . |
removeCommenter(user) | File | Usunięcie użytkownika z listy komentujących: File . |
removeEditor(emailAddress) | File | Usunięcie tego użytkownika z listy edytorów File . |
removeEditor(user) | File | Usunięcie tego użytkownika z listy edytorów File . |
removeViewer(emailAddress) | File | Usunięcie użytkownika z listy widzów i komentujących w przypadku File . |
removeViewer(user) | File | Usunięcie użytkownika z listy widzów i komentujących w przypadku File . |
revokePermissions(emailAddress) | File | Cofnie dostęp do File przyznany danemu użytkownikowi. |
revokePermissions(user) | File | Cofnie dostęp do File przyznany danemu użytkownikowi. |
setContent(content) | File | Zastępuje zawartość pliku danym elementem. |
setDescription(description) | File | Ustawia opis elementu File . |
setName(name) | File | Ustawia nazwę elementu File . |
setOwner(emailAddress) | File | Zmienia właściciela elementu File . |
setOwner(user) | File | Zmienia właściciela elementu File . |
setSecurityUpdateEnabled(enabled) | File | Określa, czy File wymaga klucza dostępu do zasobu, gdy jest udostępniany za pomocą linku. |
setShareableByEditors(shareable) | File | Określa, czy użytkownicy z uprawnieniami do edycji elementu File mogą udostępniać pliki innym użytkownikom lub zmieniać uprawnienia. |
setSharing(accessType, permissionType) | File | Określa klasy użytkowników, którzy mają mieć dostęp do File , i uprawnienia przyznawane tym użytkownikom oprócz poszczególnych użytkowników, którzy otrzymali bezpośrednie zezwolenie. |
setStarred(starred) | File | Określa, czy plik File jest oznaczony gwiazdką na Dysku użytkownika. |
setTrashed(trashed) | File | Określa, czy plik File znajduje się w koszu na Dysku użytkownika. |
Szczegółowa dokumentacja
addCommenter(emailAddress)
Dodaj danego użytkownika do listy komentujących (File
). Jeśli użytkownik był już na liście widzów, ta metoda spowoduje, że zniknie on z listy widzów.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace 'cloudysanfrancisco@gmail.com' with the email address that you // want to add as a commenter. while (files.hasNext()) { const file = files.next(); email = 'cloudysanfrancisco@gmail.com'; console.log(file.addCommenter(email)); }
Parametry
Nazwa | Typ | Opis |
---|---|---|
emailAddress | String | Adres e-mail użytkownika, którego chcesz dodać. |
Powrót
File
– File
w celu tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive
addCommenter(user)
Dodaj danego użytkownika do listy komentujących (File
). Jeśli użytkownik był już na liście widzów, ta metoda spowoduje, że zniknie on z listy widzów.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Adds the active user as a commenter. while (files.hasNext()) { const file = files.next(); file.addCommenter(Session.getActiveUser()); }
Parametry
Nazwa | Typ | Opis |
---|---|---|
user | User | Reprezentacja użytkownika do dodania. |
Powrót
File
– File
w celu tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive
addCommenters(emailAddresses)
Dodaj daną tablicę użytkowników do listy komentujących element File
. Jeśli którykolwiek z użytkowników znajduje się już na liście widzów, ta metoda przenosi ich na listę widzów.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); while (files.hasNext()) { const file = files.next(); // TODO(developer): Replace 'cloudysanfrancisco@gmail.com' and // 'baklavainthebalkans@gmail.com' with the email addresses to add as commenters. const emails = ['cloudysanfrancisco@gmail.com','baklavainthebalkans@gmail.com']; console.log(file.addCommenters(emails)); }
Parametry
Nazwa | Typ | Opis |
---|---|---|
emailAddresses | String[] | Tablica adresów e-mail użytkowników do dodania. |
Powrót
File
– File
w celu tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive
addEditor(emailAddress)
Dodaje danego użytkownika do listy edytorów elementu File
. Jeśli użytkownik był już na liście widzów, ta metoda przenosi go z listy.
Parametry
Nazwa | Typ | Opis |
---|---|---|
emailAddress | String | Adres e-mail użytkownika, którego chcesz dodać. |
Powrót
File
– File
w celu tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive
addEditor(user)
Dodaje danego użytkownika do listy edytorów elementu File
. Jeśli użytkownik był już na liście widzów, ta metoda przenosi go z listy.
Parametry
Nazwa | Typ | Opis |
---|---|---|
user | User | Reprezentacja użytkownika do dodania. |
Powrót
File
– File
w celu tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive
addEditors(emailAddresses)
Dodaje podaną tablicę użytkowników do listy edytorów obiektu File
. Jeśli którykolwiek z użytkowników znajduje się już na liście widzów, ta metoda przenosi ich na listę widzów.
Parametry
Nazwa | Typ | Opis |
---|---|---|
emailAddresses | String[] | Tablica adresów e-mail użytkowników do dodania. |
Powrót
File
– File
w celu tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive
addViewer(emailAddress)
Dodaje danego użytkownika do listy gogli File
. Jeśli użytkownik był już na liście edytorów, ta metoda nie przyniesie efektu.
Parametry
Nazwa | Typ | Opis |
---|---|---|
emailAddress | String | Adres e-mail użytkownika, którego chcesz dodać. |
Powrót
File
– File
w celu tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive
addViewer(user)
Dodaje danego użytkownika do listy gogli File
. Jeśli użytkownik był już na liście edytorów, ta metoda nie przyniesie efektu.
Parametry
Nazwa | Typ | Opis |
---|---|---|
user | User | Reprezentacja użytkownika do dodania. |
Powrót
File
– File
w celu tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive
addViewers(emailAddresses)
Dodaje podaną tablicę użytkowników do listy widzów obiektu File
. Jeśli którykolwiek z użytkowników był już na liście edytorów, ta metoda nie będzie miała dla nich żadnego wpływu.
Parametry
Nazwa | Typ | Opis |
---|---|---|
emailAddresses | String[] | Tablica adresów e-mail użytkowników do dodania. |
Powrót
File
– File
w celu tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive
getAccess(email)
Pobiera uprawnienia przyznane danemu użytkownikowi.
Parametry
Nazwa | Typ | Opis |
---|---|---|
email | String | adres e-mail użytkownika, którego uprawnienia należy sprawdzić; |
Powrót
Permission
– uprawnienia przyznane użytkownikowi,
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getAccess(user)
Pobiera uprawnienia przyznane danemu użytkownikowi.
Parametry
Nazwa | Typ | Opis |
---|---|---|
user | User | reprezentacja użytkownika, którego uprawnienia należy sprawdzić; |
Powrót
Permission
– uprawnienia przyznane użytkownikowi,
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getAs(contentType)
Zwraca dane wewnątrz tego obiektu w postaci obiektu blob przekonwertowanego na określony typ treści. Ta metoda dodaje odpowiednie rozszerzenie do nazwy pliku, na przykład „mójplik.pdf”. Zakładamy jednak, że część nazwy pliku po ostatnim okresie (jeśli istnieje) to istniejące rozszerzenie, które należy zastąpić. W efekcie adres „ShoppingList.12.25.2014” zmieni się w „ShoppingList.12.25.pdf”.
Aby wyświetlić dzienne limity konwersji, przeczytaj artykuł Limity dla usług Google. Nowo utworzone domeny Google Workspace mogą być tymczasowo objęte bardziej rygorystycznymi limitami.
Parametry
Nazwa | Typ | Opis |
---|---|---|
contentType | String | Typ MIME, na który ma zostać przekonwertowane. W przypadku większości blobów jedyną prawidłową opcją jest 'application/pdf' . W przypadku obrazów w formacie BMP, GIF, JPEG lub PNG ważne są też wszystkie formaty 'image/bmp' , 'image/gif' , 'image/jpeg' lub 'image/png' . |
Powrót
Blob
– dane w formie obiektu blob.
getBlob()
getDateCreated()
getDescription()
getDownloadUrl()
Pobiera adres URL, którego można użyć do pobrania pliku. Tylko użytkownicy z uprawnieniami do otwierania pliku na Dysku Google mogą uzyskać dostęp do adresu URL. Możesz użyć tego adresu URL w przeglądarce, aby pobrać plik, ale za pomocą UrlFetchApp
nie możesz tego zrobić. Jeśli chcesz umieścić zawartość pliku w skrypcie, użyj polecenia getBlob()
.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files and logs the download URLs to the console. while (files.hasNext()) { const file = files.next(); console.log(file.getDownloadUrl()); }
Powrót
String
– adres URL, którego można użyć do pobrania pliku.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getEditors()
Pobiera listę edytorów na koncie File
. Jeśli użytkownik, który wykonuje skrypt, nie ma uprawnień do edycji elementu File
, ta metoda zwraca pustą tablicę.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Adds the email addresses in the array as editors of each file. // TODO(developer): Replace 'cloudysanfrancisco@gmail.com' // and 'baklavainthebalkans@gmail.com' with valid email addresses. file.addEditors(['cloudysanfrancisco@gmail.com', 'baklavainthebalkans@gmail.com']); // Gets a list of the file editors. const editors = file.getEditors(); // For each file, logs the editors' email addresses to the console. for (const editor of editors) { console.log(editor.getEmail()); } }
Powrót
User[]
– jeśli użytkownik ma uprawnienia do edycji elementu File
, zwraca listę edytorów. Jeśli użytkownik nie ma uprawnień do edycji, zwraca pustą tablicę.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getId()
getLastUpdated()
Pobiera datę ostatniej aktualizacji elementu File
.
Powrót
Date
– data ostatniej aktualizacji elementu File
.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getMimeType()
Pobiera typ MIME pliku.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files and logs the MIME type to the console. while (files.hasNext()) { const file = files.next(); console.log(file.getMimeType()); }
Powrót
String
– typ MIME pliku.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getName()
getOwner()
Pobiera właściciela pliku.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files and logs the names of the file owners to the console. while (files.hasNext()) { const file = files.next(); console.log(file.getOwner().getName()); }
Powrót
User
– właściciel pliku,
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getParents()
Pobiera kolekcję folderów, które są bezpośrednimi elementami nadrzędnym folderu File
.
Powrót
FolderIterator
– zbiór folderów, które są bezpośrednimi elementami nadrzędnymi folderu File
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getResourceKey()
Pobiera klucz zasobu File
, który jest wymagany do uzyskania dostępu do elementów udostępnionych przy użyciu linku.
Powrót
String
– klucz zasobu File
.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSecurityUpdateEligible()
Określa, czy File
może stosować aktualizację zabezpieczeń, która wymaga dostępu do zasobu za pomocą linku.
Dysk wymaga klucza zasobu, aby uzyskać dostęp do niektórych plików lub folderów, które zostały udostępnione przy użyciu linku. Ta zmiana jest częścią aktualizacji zabezpieczeń. Aktualizacja jest domyślnie włączona w przypadku odpowiednich plików i folderów. Aby włączyć lub wyłączyć wymaganie klucza zasobu dla kwalifikujących się plików, użyj setSecurityUpdateEnabled
.
Dowiedz się więcej o aktualizacji zabezpieczeń Dysku Google.
Powrót
Boolean
– określa, czy w File
można zastosować wymóg klucza zasobu.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSecurityUpdateEnabled()
Określa, czy to File
wymaga dostępu do zasobu za pomocą linku. To wymaganie jest domyślnie włączone w przypadku kwalifikujących się plików i folderów.
Aby włączyć lub wyłączyć wymaganie klucza zasobu dla kwalifikujących się plików, użyj zasady
setSecurityUpdateEnabled
.
Dowiedz się więcej o aktualizacji zabezpieczeń Dysku Google.
Powrót
Boolean
– określa, czy w przypadku tego zasobu File
włączono wymaganie klucza zasobu.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSharingAccess()
Określa, do jakiej klasy użytkowników oprócz File
mają mieć dostęp inni użytkownicy.
Powrót
Access
– które grupy użytkowników mają dostęp do File
,
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSharingPermission()
Pobiera uprawnienia przyznawane użytkownikom, którzy mają dostęp do File
, oraz wszystkie osoby, którym jednoznacznie przyznano dostęp.
Powrót
Permission
– uprawnienia przyznane użytkownikom, którzy mają dostęp do File
;
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSize()
Pobiera liczbę bajtów przechowywanych na Dysku: File
. Pamiętaj, że pliki aplikacji Google Workspace nie wliczają się do limitów miejsca na Dysku, dlatego zwracają 0
bajty.
Powrót
Integer
– liczba bajtów używanych do przechowywania elementu File
na Dysku.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getTargetId()
Jeśli jest to skrót, zwraca identyfikator elementu, do którego prowadzi.
W przeciwnym razie zwraca null
.
// The ID of the file for which to make a shortcut and the ID of // the folder to which you want to add the shortcut. // TODO(developer): Replace the file and folder IDs with your IDs. const fileId = 'abc123456'; const folderId = 'xyz987654'; // Gets the folder to add the shortcut to. const folder = DriveApp.getFolderById(folderId); // Creates a shortcut of the file and moves it to the specified folder. const shortcut = DriveApp.createShortcut(fileId).moveTo(folder); // Logs the target ID of the shortcut. console.log(`${shortcut.getName()}=${shortcut.getTargetId()}`);
Powrót
String
– identyfikator elementu docelowego;
getTargetMimeType()
Jeśli jest to skrót, zwraca typ MIME elementu, do którego prowadzi.
W przeciwnym razie zwraca null
.
// The ID of the file for which to make a shortcut and the ID of // the folder to which you want to add the shortcut. // TODO(developer): Replace the file and folder IDs with your IDs. const fileId = 'abc123456'; const folderId = 'xyz987654'; // Gets the folder to add the shortcut to. const folder = DriveApp.getFolderById(folderId); // Creates a shortcut of the file and moves it to the specified folder. const shortcut = DriveApp.createShortcut(fileId).moveTo(folder); // Logs the MIME type of the file that the shortcut points to. console.log(`MIME type of the shortcut: ${shortcut.getTargetMimeType()}`);
Powrót
String
– typ MIME elementu docelowego.
getTargetResourceKey()
Jeśli plik jest skrótem, zwraca klucz zasobu wskazanego elementu. Klucz zasobu to dodatkowy parametr, który należy przekazać w celu uzyskania dostępu do plików udostępnionych przy użyciu linku.
Jeśli plik nie jest skrótem, funkcja ta zwraca wartość null
.
// Gets a file by its ID. // TODO(developer): Replace 'abc123456' with your file ID. const file = DriveApp.getFileById('abc123456'); // If the file is a shortcut, returns the resource key of the file that it points to. console.log(file.getTargetResourceKey());
Powrót
String
– klucz zasobu elementu docelowego lub null
, jeśli plik nie jest skrótem.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getThumbnail()
Pobiera miniaturę pliku lub null
, jeśli nie ma miniatury.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Logs the thumbnail image for each file to the console as a blob, // or null if no thumbnail exists. console.log(file.getThumbnail()); }
Powrót
Blob
– miniatura pliku.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getUrl()
Pobiera adres URL, którego można użyć do otwarcia elementu File
w aplikacji Google, takiej jak Dysk czy Dokumenty.
Powrót
String
– adres URL, którego można użyć do wyświetlenia elementu File
w aplikacji Google, takiej jak Dysk czy Dokumenty.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getViewers()
Pobiera listę widzów i komentujących ten element (File
). Jeśli użytkownik, który wykonuje skrypt, nie ma uprawnień do edycji elementu File
, ta metoda zwraca pustą tablicę.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // For each file, logs the viewers' email addresses to the console. const viewers = file.getViewers(); for (viewer of viewers) { console.log(viewer.getEmail()); } }
Powrót
User[]
– jeśli użytkownik ma uprawnienia do edycji elementu File
, zwraca listę widzów i komentujących. Jeśli użytkownik nie ma uprawnień do edycji, zwraca pustą tablicę.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
isStarred()
Określa, czy plik File
został oznaczony na Dysku użytkownika.
Powrót
Boolean
– true
, jeśli File
jest oznaczony gwiazdką na Dysku użytkownika; false
, jeśli nie
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
isTrashed()
Określa, czy plik File
znajduje się w koszu na Dysku użytkownika.
Powrót
Boolean
– true
, jeśli File
znajduje się w koszu na Dysku użytkownika. false
, jeśli nie.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
makeCopy()
Tworzy kopię pliku.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Creates a copy of each file and logs the file name to the console. console.log(file.makeCopy().getName()); }
Powrót
File
– nowa kopia.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive
makeCopy(destination)
Tworzy kopię pliku z katalogu docelowego.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Creates a copy of each file and adds it to the specified folder. // TODO(developer): Replace the folder ID with your own. const destination = DriveApp.getFolderById('123456abcxyz'); const copiedFile = file.makeCopy(destination); // Logs the file names to the console. console.log(copiedFile.getName()); }
Parametry
Nazwa | Typ | Opis |
---|---|---|
destination | Folder | Katalog, do którego chcesz skopiować plik. |
Powrót
File
– nowa kopia.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive
makeCopy(name)
Tworzy kopię pliku i nadaje mu nazwę.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Creates a copy of each file and sets the name to 'Test-Copy.' const filename = file.makeCopy('Test-Copy'); // Logs the copied file's name to the console. console.log(filename.getName()); }
Parametry
Nazwa | Typ | Opis |
---|---|---|
name | String | Nazwa pliku, która ma być zastosowana do nowej kopii. |
Powrót
File
– nowa kopia.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive
makeCopy(name, destination)
Tworzy kopię pliku w katalogu docelowym i nadaje mu nazwę.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Creates a copy of each file, sets the file name, and adds the copied file // to the specified folder. // TODO(developer): Replace the folder ID with your own. const destination = DriveApp.getFolderById('123456abcxyz'); const copiedFile = file.makeCopy('Test-Copy', destination); // Logs the file names to the console. console.log(copiedFile.getName()); }
Parametry
Nazwa | Typ | Opis |
---|---|---|
name | String | Nazwa pliku, która ma być zastosowana do nowej kopii. |
destination | Folder | Katalog, do którego chcesz skopiować plik. |
Powrót
File
– nowa kopia.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive
moveTo(destination)
Przenosi ten element do podanego folderu docelowego.
Aby można było przenieść element do folderu docelowego, obecny użytkownik musi być właścicielem pliku lub mieć uprawnienia do edycji bieżącego folderu nadrzędnego elementu.
Parametry
Nazwa | Typ | Opis |
---|---|---|
destination | Folder | Folder, który staje się nowym elementem nadrzędnym. |
Powrót
File
– File
w celu tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive
removeCommenter(emailAddress)
Usunięcie użytkownika z listy komentujących: File
. Ta metoda nie blokuje dostępu użytkowników do: File
, jeśli należą do grupy użytkowników, którzy mają ogólny dostęp, na przykład: File
jest udostępniany w całej domenie użytkownika.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Removes the given user from the list of commenters for each file. // TODO(developer): Replace the email with the email of the user you want to remove. file.removeCommenter('cloudysanfrancisco@gmail.com'); }
Parametry
Nazwa | Typ | Opis |
---|---|---|
emailAddress | String | Adres e-mail użytkownika, którego chcesz usunąć. |
Powrót
File
– File
w celu tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive
removeCommenter(user)
Usunięcie użytkownika z listy komentujących: File
. Ta metoda nie blokuje dostępu użytkowników do: File
, jeśli należą do grupy użytkowników, którzy mają ogólny dostęp, na przykład: File
jest udostępniany w całej domenie użytkownika.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Removes the given user from the list of commenters for each file. console.log(file.removeCommenter(Session.getActiveUser())); }
Parametry
Nazwa | Typ | Opis |
---|---|---|
user | User | Reprezentacja użytkownika do usunięcia. |
Powrót
File
– File
w celu tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive
removeEditor(emailAddress)
Usunięcie tego użytkownika z listy edytorów File
. Ta metoda nie blokuje dostępu do File
, jeśli należą one do grupy użytkowników, którzy mają dostęp ogólny, na przykład jeśli File
jest udostępniany w całej domenie użytkownika lub gdy File
znajduje się na dysku współdzielonym, do którego ma dostęp użytkownik.
W przypadku plików na Dysku również zostanie on usunięty z listy przeglądających.
Parametry
Nazwa | Typ | Opis |
---|---|---|
emailAddress | String | Adres e-mail użytkownika, którego chcesz usunąć. |
Powrót
File
– File
w celu tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive
removeEditor(user)
Usunięcie tego użytkownika z listy edytorów File
. Ta metoda nie blokuje dostępu do File
, jeśli należą one do grupy użytkowników, którzy mają dostęp ogólny, na przykład jeśli File
jest udostępniany w całej domenie użytkownika lub gdy File
znajduje się na dysku współdzielonym, do którego ma dostęp użytkownik.
W przypadku plików na Dysku również zostanie on usunięty z listy przeglądających.
Parametry
Nazwa | Typ | Opis |
---|---|---|
user | User | Reprezentacja użytkownika do usunięcia. |
Powrót
File
– File
w celu tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive
removeViewer(emailAddress)
Usunięcie użytkownika z listy widzów i komentujących w przypadku File
. Ta metoda nie działa, jeśli użytkownik jest edytorem, a nie przeglądającym lub komentującym. Ta metoda nie blokuje też dostępu do tych elementów: File
, jeśli należą one do grupy użytkowników, którzy mają ogólny dostęp, np. gdy element File
jest udostępniany w całej domenie użytkownika lub gdy File
znajduje się na dysku współdzielonym, do którego ma dostęp użytkownik.
W przypadku plików na Dysku również zostanie on usunięty z listy edytorów.
Parametry
Nazwa | Typ | Opis |
---|---|---|
emailAddress | String | Adres e-mail użytkownika, którego chcesz usunąć. |
Powrót
File
– to File
na potrzeby łańcucha.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive
removeViewer(user)
Usunięcie użytkownika z listy widzów i komentujących w przypadku File
. Ta metoda nie działa, jeśli użytkownik jest edytorem, a nie przeglądającym. Ta metoda nie blokuje też dostępu do tych elementów (File
), jeśli należą one do klasy użytkowników ogólnych, na przykład gdy element File
jest udostępniany w całej domenie użytkownika lub gdy dysk File
znajduje się na dysku współdzielonym, do którego ma dostęp użytkownik.
W przypadku plików na Dysku również zostanie on usunięty z listy edytorów.
Parametry
Nazwa | Typ | Opis |
---|---|---|
user | User | Reprezentacja użytkownika do usunięcia. |
Powrót
File
– to File
na potrzeby łańcucha.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive
revokePermissions(emailAddress)
Cofnie dostęp do File
przyznany danemu użytkownikowi. Ta metoda nie blokuje dostępu do File
, jeśli należą one do grupy użytkowników, którzy mają ogólny dostęp – na przykład gdy element File
jest udostępniany w całej domenie użytkownika.
Parametry
Nazwa | Typ | Opis |
---|---|---|
emailAddress | String | Adres e-mail użytkownika, któremu chcesz unieważnić dostęp. |
Powrót
File
– File
w celu tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive
revokePermissions(user)
Cofnie dostęp do File
przyznany danemu użytkownikowi. Ta metoda nie blokuje dostępu do File
, jeśli należą one do grupy użytkowników, którzy mają ogólny dostęp – na przykład gdy element File
jest udostępniany w całej domenie użytkownika.
Parametry
Nazwa | Typ | Opis |
---|---|---|
user | User | Informacja o użytkowniku, któremu chcesz anulować dostęp. |
Powrót
File
– File
w celu tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive
setContent(content)
Zastępuje zawartość pliku danym elementem. Wyjątek, jeśli content
ma więcej niż 10 MB.
// Creates a text file with the content 'Hello, world!' file = DriveApp.createFile('New Text File', 'Hello, world!'); // Logs the content of the text file to the console. console.log(file.getBlob().getDataAsString()); // Updates the content of the text file to 'Updated text!' file.setContent('Updated text!') // Logs content of the text file to the console. console.log(file.getBlob().getDataAsString());
Parametry
Nazwa | Typ | Opis |
---|---|---|
content | String | Nowa zawartość pliku. |
Powrót
File
– File
w celu tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive
setDescription(description)
setName(name)
setOwner(emailAddress)
Zmienia właściciela elementu File
. Ta metoda daje też poprzedniemu właścicielowi uprawnienia do edycji pliku File
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
emailAddress | String | adres e-mail użytkownika, który ma zostać nowym właścicielem; |
Powrót
File
– to File
na potrzeby łańcucha
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive
setOwner(user)
Zmienia właściciela elementu File
. Ta metoda daje też poprzedniemu właścicielowi uprawnienia do edycji pliku File
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
user | User | reprezentacja użytkownika, który powinien zostać nowym właścicielem; |
Powrót
File
– to File
na potrzeby łańcucha
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive
setSecurityUpdateEnabled(enabled)
Określa, czy File
wymaga klucza dostępu do zasobu, gdy jest udostępniany za pomocą linku. Odpowiednie pliki i foldery są domyślnie włączone.
Dowiedz się więcej o aktualizacji zabezpieczeń Dysku Google.
Parametry
Nazwa | Typ | Opis |
---|---|---|
enabled | Boolean | Określa, czy włączyć wymóg klucza klucza dla File . |
Powrót
File
– File
w celu tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive
setSharing(accessType, permissionType)
Określa klasy użytkowników, którzy mają mieć dostęp do File
, i uprawnienia przyznawane tym użytkownikom oprócz poszczególnych użytkowników, którzy otrzymali bezpośrednie zezwolenie.
// Creates a folder that anyone on the Internet can read from and write to. (Domain // administrators can prohibit this setting for users of a Google Workspace domain.) var folder = DriveApp.createFolder('Shared Folder'); folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);
Parametry
Nazwa | Typ | Opis |
---|---|---|
accessType | Access | do jakiej klasy użytkowników powinien mieć dostęp File , |
permissionType | Permission | uprawnienia, które powinny być przyznawane użytkownikom mającym dostęp do File |
Powrót
File
– to File
na potrzeby łańcucha
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive
setStarred(starred)
Określa, czy plik File
jest oznaczony gwiazdką na Dysku użytkownika. Domyślnie nowe wartości File
wynoszą false
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
starred | Boolean | true , jeśli element File powinien być oznaczony gwiazdką na Dysku użytkownika. false , jeśli nie. |
Powrót
File
– to File
na potrzeby łańcucha
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive
setTrashed(trashed)
Określa, czy plik File
znajduje się w koszu na Dysku użytkownika. Tylko właściciel może usunąć File
. Domyślnie nowe wartości File
wynoszą false
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
trashed | Boolean | true , jeśli File powinien zostać przeniesiony do kosza na Dysku użytkownika. false , jeśli nie. |
Powrót
File
– to File
na potrzeby łańcucha
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/drive