Plik na Dysku Google. Pliki można otwierać i tworzyć w usłudze 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 podaną tablicę użytkowników do listy komentujących w elemencie File . |
addEditor(emailAddress) | File | Dodaje wskazanego użytkownika do listy edytorów w File . |
addEditor(user) | File | Dodaje wskazanego użytkownika do listy edytorów w File . |
addEditors(emailAddresses) | File | Dodaje podaną tablicę użytkowników do listy edytorów elementu File . |
addViewer(emailAddress) | File | Dodaje danego użytkownika do listy przeglądających stronę File . |
addViewer(user) | File | Dodaje danego użytkownika do listy przeglądających stronę File . |
addViewers(emailAddresses) | File | Dodaje podaną tablicę użytkowników do listy osób przeglądających element 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 jako obiekt blob przekonwertowany na określony typ treści. |
getBlob() | Blob | Zwracaj dane wewnątrz tego obiektu jako obiekt blob. |
getDateCreated() | Date | Pobiera datę utworzenia File . |
getDescription() | String | Pobiera opis obiektu File . |
getDownloadUrl() | String | Pobiera adres URL, którego można użyć do pobrania pliku. |
getEditors() | User[] | Pobiera listę edytorów tego elementu (File ). |
getId() | String | Pobiera identyfikator elementu File . |
getLastUpdated() | Date | Pobiera datę ostatniej aktualizacji elementu File . |
getMimeType() | String | Pobiera typ MIME pliku. |
getName() | String | Pobiera nazwę elementu File . |
getOwner() | User | Pobiera właściciela pliku. |
getParents() | FolderIterator | Pobiera zbiór folderów, które są bezpośrednimi elementami nadrzędnymi elementu 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 | Sprawdza, czy File może zastosować aktualizację zabezpieczeń, która wymaga dostępu przy użyciu klucza zasobu, gdy jest on udostępniany przy użyciu linku. |
getSecurityUpdateEnabled() | Boolean | Sprawdza, czy File wymaga klucza zasobu, aby uzyskać dostęp, gdy jest udostępniany przy użyciu linku. |
getSharingAccess() | Access | Określa, która klasa użytkowników (oprócz poszczególnych użytkowników, którym przyznano dostęp) ma dostęp do File . |
getSharingPermission() | Permission | Otrzymuje uprawnienia przyznane tym użytkownikom, którzy mają dostęp do elementu File , oprócz wszystkich użytkowników, którym przyznano dostęp wprost. |
getSize() | Integer | Pobiera liczbę bajtów używanych do przechowywania elementu File na Dysku. |
getTargetId() | String | Jeśli to skrót, zwraca identyfikator elementu, do którego wskazuje element. |
getTargetMimeType() | String | Jeśli jest to skrót, zwraca typ MIME elementu, który wskazuje. |
getTargetResourceKey() | String | Jeśli plik jest skrótem, zwraca klucz zasobu elementu, do którego prowadzi. |
getThumbnail() | Blob | Pobiera obraz miniatury pliku lub null , jeśli miniatura nie istnieje. |
getUrl() | String | Pobiera adres URL, za pomocą którego można otworzyć plik File w aplikacji Google, takiej jak Dysk czy Dokumenty. |
getViewers() | User[] | Pobiera listę przeglądających i komentujących tego elementu (File ). |
isShareableByEditors() | Boolean | Określa, czy użytkownicy z uprawnieniami do edycji elementu File mogą udostępniać pliki innym użytkownikom czy zmieniać uprawnienia. |
isStarred() | Boolean | Określa, czy zasób File jest oznaczony gwiazdką na Dysku użytkownika. |
isTrashed() | Boolean | Określa, czy zasób File znajduje się w koszu na Dysku użytkownika. |
makeCopy() | File | Tworzy kopię pliku. |
makeCopy(destination) | File | Tworzy kopię pliku w katalogu docelowym. |
makeCopy(name) | File | Tworzy kopię pliku i nadaje mu nazwę. |
makeCopy(name, destination) | File | W katalogu docelowym utworzy kopię pliku i nada mu nazwę. |
moveTo(destination) | File | Przenosi ten element do podanego folderu docelowego. |
removeCommenter(emailAddress) | File | Usuwa danego użytkownika z listy komentujących elementu File . |
removeCommenter(user) | File | Usuwa danego użytkownika z listy komentujących elementu File . |
removeEditor(emailAddress) | File | Usuwa danego użytkownika z listy edytorów File . |
removeEditor(user) | File | Usuwa danego użytkownika z listy edytorów File . |
removeViewer(emailAddress) | File | Usuwa danego użytkownika z listy przeglądających i komentujących elementu File . |
removeViewer(user) | File | Usuwa danego użytkownika z listy przeglądających i komentujących elementu File . |
revokePermissions(emailAddress) | File | Unieważnia dostęp do uprawnienia File przyznanego danemu użytkownikowi. |
revokePermissions(user) | File | Unieważnia dostęp do uprawnienia File przyznanego danemu użytkownikowi. |
setContent(content) | File | Zastępuje treść pliku danym zamiennikiem. |
setDescription(description) | File | Ustawia opis obiektu File . |
setName(name) | File | Ustawia nazwę: 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 zasobu w celu uzyskania dostępu, 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, która klasa użytkowników ma dostęp do elementu File i jakie uprawnienia są im przyznane (z wyjątkiem poszczególnych użytkowników, którym przyznano dostęp bezpośrednio). |
setStarred(starred) | File | Określa, czy File ma być oznaczony gwiazdką na Dysku użytkownika. |
setTrashed(trashed) | File | Określa, czy zasób 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 powoduje wypromowanie go z listy odbiorcó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ć. |
Powroty
File
– ten element typu File
do tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym 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 powoduje wypromowanie go z listy odbiorcó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, który ma zostać dodany. |
Powroty
File
– ten element typu File
do tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive
addCommenters(emailAddresses)
Dodaj podaną tablicę użytkowników do listy komentujących w elemencie File
. Jeśli którykolwiek z użytkowników był już na liście widzów, ta metoda przesuwa go poza 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. |
Powroty
File
– ten element typu File
do tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive
addEditor(emailAddress)
Dodaje wskazanego użytkownika do listy edytorów w File
. Jeśli użytkownik był już na liście widzów, ta metoda przesuwa go poza listę widzów.
Parametry
Nazwa | Typ | Opis |
---|---|---|
emailAddress | String | Adres e-mail użytkownika, którego chcesz dodać. |
Powroty
File
– ten element typu File
do tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive
addEditor(user)
Dodaje wskazanego użytkownika do listy edytorów w File
. Jeśli użytkownik był już na liście widzów, ta metoda przesuwa go poza listę widzów.
Parametry
Nazwa | Typ | Opis |
---|---|---|
user | User | Reprezentacja użytkownika, który ma zostać dodany. |
Powroty
File
– ten element typu File
do tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive
addEditors(emailAddresses)
Dodaje podaną tablicę użytkowników do listy edytorów elementu File
. Jeśli którykolwiek z użytkowników był już na liście widzów, ta metoda przesuwa go poza listę widzów.
Parametry
Nazwa | Typ | Opis |
---|---|---|
emailAddresses | String[] | Tablica adresów e-mail użytkowników do dodania. |
Powroty
File
– ten element typu File
do tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive
addViewer(emailAddress)
Dodaje danego użytkownika do listy przeglądających stronę File
. Jeśli użytkownik był już na liście edytorów, ta metoda nie ma żadnego efektu.
Parametry
Nazwa | Typ | Opis |
---|---|---|
emailAddress | String | Adres e-mail użytkownika, którego chcesz dodać. |
Powroty
File
– ten element typu File
do tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive
addViewer(user)
Dodaje danego użytkownika do listy przeglądających stronę File
. Jeśli użytkownik był już na liście edytorów, ta metoda nie ma żadnego efektu.
Parametry
Nazwa | Typ | Opis |
---|---|---|
user | User | Reprezentacja użytkownika, który ma zostać dodany. |
Powroty
File
– ten element typu File
do tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive
addViewers(emailAddresses)
Dodaje podaną tablicę użytkowników do listy osób przeglądających element File
. Jeśli którykolwiek z użytkowników był już na liście edytorów, ta metoda nie będzie działać.
Parametry
Nazwa | Typ | Opis |
---|---|---|
emailAddresses | String[] | Tablica adresów e-mail użytkowników do dodania. |
Powroty
File
– ten element typu File
do tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym 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ć |
Powroty
Permission
– uprawnienia przyznane użytkownikowi,
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym 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ć |
Powroty
Permission
– uprawnienia przyznane użytkownikowi,
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym 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 jako obiekt blob przekonwertowany na określony typ treści. Ta metoda dodaje do nazwy pliku odpowiednie rozszerzenie, na przykład „mójplik.pdf”. Zakładamy jednak, że część nazwy pliku, która występuje po ostatniej kropce (jeśli występuje), jest istniejącym rozszerzeniem, które należy zastąpić. W związku z tym „Lista zakupów.12.25.2014” zmieni się na „Lista zakupów.12.25.pdf”.
Aby sprawdzić dzienne limity konwersji, przeczytaj artykuł Limity w usługach Google. Nowo utworzone domeny Google Workspace mogą tymczasowo podlegać bardziej rygorystycznym limitom.
Parametry
Nazwa | Typ | Opis |
---|---|---|
contentType | String | Typ MIME, na który ma zostać przekonwertowany. W przypadku większości obiektów blob jedyną prawidłową opcją jest 'application/pdf' . W przypadku zdjęć w formacie BMP, GIF, JPEG lub PNG obowiązują dowolne z tych wartości: 'image/bmp' , 'image/gif' , 'image/jpeg' i 'image/png' . |
Powroty
Blob
– dane w postaci obiektu blob.
getBlob()
getDateCreated()
getDescription()
getDownloadUrl()
Pobiera adres URL, którego można użyć do pobrania pliku. Dostęp do adresu URL mają tylko użytkownicy z uprawnieniami do otwierania pliku na Dysku Google. Możesz użyć tego adresu URL w przeglądarce, aby pobrać plik, ale nie możesz go użyć do pobrania pliku za pomocą funkcji UrlFetchApp
. Jeśli chcesz, aby zawartość pliku znajdowała się w skrypcie, użyj 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()); }
Powroty
String
– adres URL, pod którym można pobrać plik.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getEditors()
Pobiera listę edytorów tego elementu (File
). Jeśli użytkownik, który wykona 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()); } }
Powroty
User[]
– jeśli użytkownik ma uprawnienia do edycji elementu File
, zwraca listę redaktorów. Jeśli użytkownik nie ma uprawnień do edycji, zwraca pustą tablicę.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getId()
getLastUpdated()
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()); }
Powroty
String
– typ MIME pliku.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym 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()); }
Powroty
User
– właściciel pliku,
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getParents()
Pobiera zbiór folderów, które są bezpośrednimi elementami nadrzędnymi elementu File
.
Powroty
FolderIterator
– zbiór folderów, które są bezpośrednimi elementami nadrzędnymi elementu File
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym 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.
Powroty
String
– klucz zasobu File
.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSecurityUpdateEligible()
Sprawdza, czy File
może zastosować aktualizację zabezpieczeń, która wymaga dostępu przy użyciu klucza zasobu, gdy jest on udostępniany przy użyciu linku.
Dysk wymaga klucza zasobu, aby uzyskać dostęp do niektórych plików i folderów udostępnionych 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 w przypadku kwalifikujących się plików, użyj setSecurityUpdateEnabled
.
Dowiedz się więcej o aktualizacji zabezpieczeń Dysku Google.
Powroty
Boolean
– określa, czy wymaganie klucza zasobu może zostać zastosowane do File
.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSecurityUpdateEnabled()
Sprawdza, czy File
wymaga klucza zasobu, aby uzyskać dostęp, gdy jest udostępniany przy użyciu linku. To wymaganie jest domyślnie włączone w przypadku odpowiednich plików i folderów.
Aby włączyć lub wyłączyć wymóg klucza zasobu w przypadku kwalifikujących się plików, użyj
setSecurityUpdateEnabled
.
Dowiedz się więcej o aktualizacji zabezpieczeń Dysku Google.
Powroty
Boolean
– określa, czy wymaganie klucza zasobu jest włączone dla klucza File
.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSharingAccess()
Określa, która klasa użytkowników (oprócz poszczególnych użytkowników, którym przyznano dostęp) ma dostęp do File
.
Powroty
Access
– klasa użytkowników mających dostęp do elementu File
.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSharingPermission()
Otrzymuje uprawnienia przyznane tym użytkownikom, którzy mają dostęp do elementu File
, oprócz wszystkich użytkowników, którym przyznano dostęp wprost.
Powroty
Permission
– uprawnienia przyznane użytkownikom, którzy mają dostęp do: File
.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSize()
Pobiera liczbę bajtów używanych do przechowywania elementu File
na Dysku. Pliki aplikacji Google Workspace nie wliczają się do limitu miejsca na Dysku i dlatego zwracają 0
B.
Powroty
Integer
– liczba bajtów użytych do przechowywania elementu File
na Dysku.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getTargetId()
Jeśli to skrót, zwraca identyfikator elementu, do którego wskazuje element.
W przeciwnym razie zwraca wartość 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()}`);
Powroty
String
– identyfikator elementu docelowego.
getTargetMimeType()
Jeśli jest to skrót, zwraca typ MIME elementu, który wskazuje.
W przeciwnym razie zwraca wartość 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()}`);
Powroty
String
– typ MIME elementu docelowego.
getTargetResourceKey()
Jeśli plik jest skrótem, zwraca klucz zasobu elementu, do którego prowadzi. Klucz zasobu to dodatkowy parametr, który trzeba przekazać, aby uzyskać dostęp do plików udostępnionych przy użyciu linku.
Jeśli plik nie jest skrótem, 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());
Powroty
String
– klucz zasobu elementu docelowego lub null
, jeśli plik nie jest skrótem.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getThumbnail()
Pobiera obraz miniatury pliku lub null
, jeśli miniatura nie istnieje.
// 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()); }
Powroty
Blob
– miniatura pliku.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getUrl()
Pobiera adres URL, za pomocą którego można otworzyć plik File
w aplikacji Google, takiej jak Dysk czy Dokumenty.
Powroty
String
– adres URL, pod którym można wyświetlić ten element (File
) w aplikacji Google, takiej jak Dysk czy Dokumenty
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getViewers()
Pobiera listę przeglądających i komentujących tego elementu (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()); } }
Powroty
User[]
– jeśli użytkownik ma uprawnienia do edycji elementu File
, zwraca listę przeglądających 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 z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
isStarred()
Określa, czy zasób File
jest oznaczony gwiazdką na Dysku użytkownika.
Powroty
Boolean
– true
, jeśli File
jest oznaczony gwiazdką na Dysku użytkownika; false
, jeśli nie jest.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
isTrashed()
Określa, czy zasób File
znajduje się w koszu na Dysku użytkownika.
Powroty
Boolean
– true
, jeśli File
znajduje się w koszu na Dysku użytkownika; false
, jeśli nie jest.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym 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()); }
Powroty
File
– nowa kopia.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive
makeCopy(destination)
Tworzy kopię pliku w katalogu docelowym.
// 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. |
Powroty
File
– nowa kopia.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym 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 powinna zostać zastosowana do nowej kopii. |
Powroty
File
– nowa kopia.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive
makeCopy(name, destination)
W katalogu docelowym utworzy kopię pliku i nada 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 powinna zostać zastosowana do nowej kopii. |
destination | Folder | Katalog, do którego chcesz skopiować plik. |
Powroty
File
– nowa kopia.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym 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, bieżący użytkownik musi być właścicielem pliku lub mieć co najmniej uprawnienia do edycji bieżącego folderu nadrzędnego danego elementu.
Parametry
Nazwa | Typ | Opis |
---|---|---|
destination | Folder | Folder, który staje się nowym elementem nadrzędnym. |
Powroty
File
– ten element typu File
do tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive
removeCommenter(emailAddress)
Usuwa danego użytkownika z listy komentujących elementu File
. Ta metoda nie blokuje dostępu do File
użytkownikom, którzy należą do klasy użytkowników z ogólnym dostępem – na przykład gdy File
jest udostępniany 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ąć. |
Powroty
File
– ten element typu File
do tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive
removeCommenter(user)
Usuwa danego użytkownika z listy komentujących elementu File
. Ta metoda nie blokuje dostępu do File
użytkownikom, którzy należą do klasy użytkowników z ogólnym dostępem – na przykład gdy File
jest udostępniany 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, który ma zostać usunięty. |
Powroty
File
– ten element typu File
do tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive
removeEditor(emailAddress)
Usuwa danego użytkownika z listy edytorów File
. Ta metoda nie blokuje użytkownikom dostępu do File
, jeśli należą do klasy użytkowników z dostępem ogólnym – na przykład gdy zasób File
jest udostępniany całej domenie użytkownika lub gdy File
znajduje się na dysku współdzielonym, do którego użytkownik ma dostęp.
W przypadku plików na Dysku spowoduje to też usunięcie użytkownika z listy osób przeglądających.
Parametry
Nazwa | Typ | Opis |
---|---|---|
emailAddress | String | Adres e-mail użytkownika, którego chcesz usunąć. |
Powroty
File
– ten element typu File
do tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive
removeEditor(user)
Usuwa danego użytkownika z listy edytorów File
. Ta metoda nie blokuje użytkownikom dostępu do File
, jeśli należą do klasy użytkowników z dostępem ogólnym – na przykład gdy zasób File
jest udostępniany całej domenie użytkownika lub gdy File
znajduje się na dysku współdzielonym, do którego użytkownik ma dostęp.
W przypadku plików na Dysku spowoduje to też usunięcie użytkownika z listy osób przeglądających.
Parametry
Nazwa | Typ | Opis |
---|---|---|
user | User | Reprezentacja użytkownika, który ma zostać usunięty. |
Powroty
File
– ten element typu File
do tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive
removeViewer(emailAddress)
Usuwa danego użytkownika z listy przeglądających i komentujących elementu File
. Ta metoda nie działa, jeśli użytkownik jest edytującym, a nie przeglądającym lub komentującym. Ta metoda nie blokuje też użytkownikom dostępu do zasobu File
, jeśli należą do klasy użytkowników z ogólnymi uprawnieniami dostępu – na przykład gdy File
jest udostępniony całej domenie użytkownika lub gdy File
znajduje się na dysku współdzielonym, do którego użytkownik ma dostęp.
W przypadku plików na Dysku spowoduje to też usunięcie użytkownika z listy edytorów.
Parametry
Nazwa | Typ | Opis |
---|---|---|
emailAddress | String | Adres e-mail użytkownika, którego chcesz usunąć. |
Powroty
File
– ten element typu File
do tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive
removeViewer(user)
Usuwa danego użytkownika z listy przeglądających i komentujących elementu File
. Ta metoda nie działa, jeśli użytkownik jest edytorem, a nie przeglądającym. Ta metoda nie blokuje też użytkownikom dostępu do File
, jeśli należą do klasy użytkowników z ogólnymi uprawnieniami dostępu – na przykład gdy File
jest udostępniony całej domenie użytkownika lub File
znajduje się na dysku współdzielonym, do którego użytkownik ma dostęp.
W przypadku plików na Dysku spowoduje to też usunięcie użytkownika z listy edytorów.
Parametry
Nazwa | Typ | Opis |
---|---|---|
user | User | Reprezentacja użytkownika, który ma zostać usunięty. |
Powroty
File
– ten element typu File
do tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive
revokePermissions(emailAddress)
Unieważnia dostęp do uprawnienia File
przyznanego danemu użytkownikowi. Ta metoda nie blokuje użytkownikom dostępu do File
, jeśli należą do klasy użytkowników z ogólnym dostępem – na przykład gdy File
jest udostępniany całej domenie użytkownika.
Parametry
Nazwa | Typ | Opis |
---|---|---|
emailAddress | String | Adres e-mail użytkownika, któremu chcesz anulować dostęp. |
Powroty
File
– ten element typu File
do tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive
revokePermissions(user)
Unieważnia dostęp do uprawnienia File
przyznanego danemu użytkownikowi. Ta metoda nie blokuje użytkownikom dostępu do File
, jeśli należą do klasy użytkowników z ogólnym dostępem – na przykład gdy File
jest udostępniany całej domenie użytkownika.
Parametry
Nazwa | Typ | Opis |
---|---|---|
user | User | Reprezentacja użytkownika, którego dostęp powinien zostać unieważniony. |
Powroty
File
– ten element typu File
do tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive
setContent(content)
Zastępuje treść pliku danym zamiennikiem. Jeśli rozmiar pliku content
przekracza 10 MB, zgłasza wyjątek.
// 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. |
Powroty
File
– ten element typu File
do tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym 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 elementu File
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
emailAddress | String | adres e-mail użytkownika, który powinien zostać nowym właścicielem; |
Powroty
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym 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 elementu File
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
user | User | nazwa użytkownika, który powinien zostać nowym właścicielem; |
Powroty
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive
setSecurityUpdateEnabled(enabled)
Określa, czy File
wymaga klucza zasobu w celu uzyskania dostępu, 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ć wymaganie klucza zasobu dla obiektu File . |
Powroty
File
– ten element typu File
do tworzenia łańcuchów.
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive
setSharing(accessType, permissionType)
Określa, która klasa użytkowników ma dostęp do elementu File
i jakie uprawnienia są im przyznane (z wyjątkiem poszczególnych użytkowników, którym przyznano dostęp bezpośrednio).
// 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 | która klasa użytkowników powinna mieć dostęp do File |
permissionType | Permission | uprawnienia, które należy przyznać użytkownikom mającym dostęp do: File |
Powroty
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive
setStarred(starred)
Określa, czy File
ma być oznaczony gwiazdką na Dysku użytkownika. Wartością domyślną dla nowych komponentów File
jest false
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
starred | Boolean | true , jeśli element File powinien być oznaczony gwiazdką na Dysku użytkownika; jeśli nie, false |
Powroty
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive
setTrashed(trashed)
Określa, czy zasób File
znajduje się w koszu na Dysku użytkownika. Tylko właściciel może przenieść do kosza element File
. Wartością domyślną nowych File
jest false
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
trashed | Boolean | true , jeśli element File powinien zostać przeniesiony do kosza na Dysku użytkownika; w przeciwnym razie false |
Powroty
Upoważnienie
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive