Class File

Plik

plik na Dysku Google, Dostęp do plików można uzyskać lub utworzyć je w panelu DriveApp.

// Trash every untitled spreadsheet that hasn't been updated in a week.
const files = DriveApp.getFilesByName('Untitled spreadsheet');
while (files.hasNext()) {
  const file = files.next();
  if (new Date() - file.getLastUpdated() > 7 * 24 * 60 * 60 * 1000) {
    file.setTrashed(true);
  }
}

Metody

MetodaZwracany typKrótki opis
addCommenter(emailAddress)FileDodaj podanego użytkownika do listy komentujących File.
addCommenter(user)FileDodaj podanego użytkownika do listy komentujących File.
addCommenters(emailAddresses)FileDodaj podaną tablicę użytkowników do listy komentujących w przypadku elementu File.
addEditor(emailAddress)FileDodaje podanego użytkownika do listy edytujących File.
addEditor(user)FileDodaje podanego użytkownika do listy edytujących File.
addEditors(emailAddresses)FileDodaje podaną tablicę użytkowników do listy edytujących File.
addViewer(emailAddress)FileDodaje podanego użytkownika do listy osób, które mogą wyświetlać File.
addViewer(user)FileDodaje podanego użytkownika do listy osób, które mogą wyświetlać File.
addViewers(emailAddresses)FileDodaje podaną tablicę użytkowników do listy widzów File.
getAccess(email)PermissionPobiera uprawnienia przyznane konkretnemu użytkownikowi.
getAccess(user)PermissionPobiera uprawnienia przyznane konkretnemu użytkownikowi.
getAs(contentType)BlobZwraca dane w tym obiekcie jako obiekt blob przekonwertowany na określony typ treści.
getBlob()BlobZwraca dane w tym obiekcie jako obiekt blob.
getDateCreated()DatePobiera datę utworzenia File.
getDescription()StringPobiera opis elementu File.
getDownloadUrl()StringPobiera adres URL, który można wykorzystać do pobrania pliku.
getEditors()User[]Pobiera listę edytorów tego File.
getId()StringPobiera identyfikator File.
getLastUpdated()DatePobiera datę ostatniej aktualizacji File.
getMimeType()StringPobiera typ MIME pliku.
getName()StringPobiera nazwę File.
getOwner()UserPobiera właściciela pliku.
getParents()FolderIteratorPobiera kolekcję folderów, które są bezpośrednimi elementami nadrzędnymi elementu File.
getResourceKey()StringPobiera klucz zasobu File, który jest wymagany do uzyskania dostępu do elementów udostępnionych za pomocą linku.
getSecurityUpdateEligible()BooleanOkreśla, czy ten File może zastosować aktualizację zabezpieczeń, która wymaga klucza zasobu do uzyskania dostępu, gdy jest udostępniany za pomocą linku.
getSecurityUpdateEnabled()BooleanOkreśla, czy ten File wymaga klucza zasobu do uzyskania dostępu, gdy jest udostępniany za pomocą linku.
getSharingAccess()AccessOkreśla, która grupa użytkowników może uzyskać dostęp do File, oprócz użytkowników, którym wyraźnie przyznano dostęp.
getSharingPermission()PermissionPobiera uprawnienia przyznane użytkownikom, którzy mają dostęp do File, oprócz użytkowników, którym wyraźnie przyznano dostęp.
getSize()IntegerPobiera liczbę bajtów używanych do przechowywania File na Dysku.
getTargetId()StringJeśli jest to skrót, zwraca identyfikator elementu, do którego prowadzi.
getTargetMimeType()StringJeśli jest to skrót, zwraca typ MIME elementu, do którego prowadzi.
getTargetResourceKey()StringJeśli plik jest skrótem, zwraca klucz zasobu elementu, do którego prowadzi.
getThumbnail()Blob|nullPobiera miniaturę pliku lub null, jeśli miniatura nie istnieje.
getUrl()StringPobiera adres URL, którego można użyć do otwarcia File w aplikacji Google, takiej jak Dysk lub Dokumenty.
getViewers()User[]Pobiera listę przeglądających i komentujących dla tego File.
isShareableByEditors()BooleanOkreśla, czy użytkownicy z uprawnieniami do edycji File mogą udostępniać je innym użytkownikom lub zmieniać uprawnienia.
isStarred()BooleanOkreśla, czy File został oznaczony gwiazdką na Dysku użytkownika.
isTrashed()BooleanOkreśla, czy File znajduje się w koszu na Dysku użytkownika.
makeCopy()FileTworzy kopię pliku.
makeCopy(destination)FileTworzy kopię pliku w katalogu docelowym.
makeCopy(name)FileTworzy kopię pliku i nadaje jej podaną nazwę.
makeCopy(name, destination)FileTworzy kopię pliku w katalogu docelowym i nadaje jej podaną nazwę.
moveTo(destination)FilePrzenosi ten element do podanego folderu docelowego.
removeCommenter(emailAddress)FileUsuwa danego użytkownika z listy komentujących File.
removeCommenter(user)FileUsuwa danego użytkownika z listy komentujących File.
removeEditor(emailAddress)FileUsuwa danego użytkownika z listy osób edytujących File.
removeEditor(user)FileUsuwa danego użytkownika z listy osób edytujących File.
removeViewer(emailAddress)FileUsuwa danego użytkownika z listy przeglądających i komentujących File.
removeViewer(user)FileUsuwa danego użytkownika z listy przeglądających i komentujących File.
revokePermissions(emailAddress)FileUnieważnia dostęp do File przyznany danemu użytkownikowi.
revokePermissions(user)FileUnieważnia dostęp do File przyznany danemu użytkownikowi.
setContent(content)FileZastępuje zawartość pliku podanym tekstem.
setDescription(description)FileUstawia opis elementu File.
setName(name)FileUstawia nazwę elementu File.
setOwner(emailAddress)FileZmienia właściciela File.
setOwner(user)FileZmienia właściciela File.
setSecurityUpdateEnabled(enabled)FileOkreśla, czy File wymaga klucza zasobu do uzyskania dostępu, gdy jest udostępniany za pomocą linku.
setShareableByEditors(shareable)FileOkreśla, czy użytkownicy z uprawnieniami do edycji File mogą udostępniać pliki innym użytkownikom lub zmieniać uprawnienia.
setSharing(accessType, permissionType)FileOkreśla, która klasa użytkowników może uzyskać dostęp do File i jakie uprawnienia są im przyznawane, oprócz uprawnień przyznanych poszczególnym użytkownikom.
setStarred(starred)FileOkreśla, czy File jest oznaczony gwiazdką na Dysku użytkownika.
setTrashed(trashed)FileOkreśla, czy File znajduje się w koszu na Dysku użytkownika.

Szczegółowa dokumentacja

addCommenter(emailAddress)

Dodaj podanego użytkownika do listy komentujących File. Jeśli użytkownik był już na liście widzów, ta metoda usuwa go z tej listy.

const files = DriveApp.getFilesByName('Test');

// Loops through the files
while (files.hasNext()) {
  const file = files.next();
  file.addCommenter('hello@example.com');
}

Parametry

NazwaTypOpis
emailAddressStringAdres e-mail użytkownika, którego chcesz dodać.

Powrót

File – ten File do tworzenia łańcuszków.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive

addCommenter(user)

Dodaj podanego użytkownika do listy komentujących File. Jeśli użytkownik był już na liście widzów, ta metoda usuwa go z tej listy.

// 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

NazwaTypOpis
userUserReprezentacja użytkownika, którego chcesz dodać.

Powrót

File — ten File do tworzenia łańcuszków.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive

addCommenters(emailAddresses)

Dodaj podaną tablicę użytkowników do listy komentujących w przypadku elementu File. Jeśli którykolwiek z użytkowników był już na liście widzów, ta metoda usuwa go z tej listy.

// 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

NazwaTypOpis
emailAddressesString[]Tablica adresów e-mail użytkowników, których chcesz dodać.

Powrót

File — ten File do tworzenia łańcuszków.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive

addEditor(emailAddress)

Dodaje podanego użytkownika do listy edytujących File. Jeśli użytkownik był już na liście widzów, ta metoda usuwa go z tej listy.

Parametry

NazwaTypOpis
emailAddressStringAdres e-mail użytkownika, którego chcesz dodać.

Powrót

File — ten File do tworzenia łańcuszków.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive

addEditor(user)

Dodaje podanego użytkownika do listy edytujących File. Jeśli użytkownik był już na liście widzów, ta metoda usuwa go z tej listy.

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika, którego chcesz dodać.

Powrót

File – ten File do tworzenia łańcuszków.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive

addEditors(emailAddresses)

Dodaje podaną tablicę użytkowników do listy edytujących File. Jeśli któryś z użytkowników był już na liście widzów, ta metoda usuwa go z tej listy.

Parametry

NazwaTypOpis
emailAddressesString[]Tablica adresów e-mail użytkowników, których chcesz dodać.

Powrót

File – ten File do tworzenia łańcuszków.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive

addViewer(emailAddress)

Dodaje podanego użytkownika do listy osób, które mogą wyświetlać File. Jeśli użytkownik był już na liście edytujących, ta metoda nie ma wpływu.

Parametry

NazwaTypOpis
emailAddressStringAdres e-mail użytkownika, którego chcesz dodać.

Powrót

File — ten File do tworzenia łańcuszków.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive

addViewer(user)

Dodaje podanego użytkownika do listy osób, które mogą wyświetlać File. Jeśli użytkownik był już na liście edytujących, ta metoda nie ma wpływu.

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika, którego chcesz dodać.

Powrót

File — ten File do tworzenia łańcuszków.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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 File. Jeśli któryś z użytkowników był już na liście edytujących, ta metoda nie będzie miała na niego wpływu.

Parametry

NazwaTypOpis
emailAddressesString[]Tablica adresów e-mail użytkowników, których chcesz dodać.

Powrót

File — ten File do tworzenia łańcuszków.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive

getAccess(email)

Pobiera uprawnienia przyznane konkretnemu użytkownikowi. Ta metoda nie obsługuje zwracania uprawnień dla grupy dyskusyjnej Google ani uprawnień dziedziczonych przez grupy dyskusyjne Google.

Parametry

NazwaTypOpis
emailStringAdres e-mail użytkownika, którego uprawnienia mają zostać sprawdzone. Grupy dyskusyjne Google nie są obsługiwane.

Powrót

Permission – uprawnienia przyznane użytkownikowi.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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 konkretnemu użytkownikowi. Ta metoda nie obsługuje zwracania uprawnień dla grupy dyskusyjnej Google ani uprawnień dziedziczonych przez grupy dyskusyjne Google.

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika, którego uprawnienia mają zostać sprawdzone.

Powrót

Permission – uprawnienia przyznane użytkownikowi.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getAs(contentType)

Zwraca dane w tym obiekcie jako obiekt blob przekonwertowany na określony typ treści. Ta metoda dodaje do nazwy pliku odpowiednie rozszerzenie, np. „mójplik.pdf”. Zakłada jednak, że część nazwy pliku, która następuje po ostatniej kropce (jeśli występuje), jest istniejącym rozszerzeniem, które należy zastąpić. W konsekwencji nazwa „ShoppingList.12.25.2014” zmieni się na „ShoppingList.12.25.pdf”.

Aby wyświetlić dzienne limity konwersji, zapoznaj się z artykułem Limity usług Google. Nowo utworzone domeny Google Workspace mogą być tymczasowo objęte bardziej rygorystycznymi limitami.

Parametry

NazwaTypOpis
contentTypeStringTyp MIME, na który ma zostać przekonwertowany plik. W przypadku większości obiektów blob jedyną prawidłową opcją jest 'application/pdf'. W przypadku obrazów w formacie BMP, GIF, JPEG lub PNG prawidłowe są też znaki 'image/bmp', 'image/gif', 'image/jpeg''image/png'. W przypadku dokumentu Google 'text/markdown' jest również prawidłowy.

Powrót

Blob – dane w formie obiektu blob.


getBlob()

Zwraca dane w tym obiekcie jako obiekt blob.

Powrót

Blob – dane w formie obiektu blob.


getDateCreated()

Pobiera datę utworzenia File.

Powrót

Date – data utworzenia File.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getDescription()

Pobiera opis elementu File.

Powrót

String – opis elementu File;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getDownloadUrl()

Pobiera adres URL, który można wykorzystać do pobrania pliku. Dostęp do adresu URL mają tylko użytkownicy, którzy mają uprawnienia 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ą UrlFetchApp. Jeśli chcesz, aby w skrypcie znalazła się zawartość pliku, 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());
}

Powrót

String – adres URL, za pomocą którego można pobrać plik.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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 tego File. Jeśli użytkownik, który wykonuje skrypt, nie ma uprawnień do edytowania 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 edytowania tego File, zwraca listę edytujących. Jeśli użytkownik nie ma uprawnień do edycji, zwraca pustą tablicę.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getId()

Pobiera identyfikator File.

Powrót

String – identyfikator File

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getLastUpdated()

Pobiera datę ostatniej aktualizacji File.

Powrót

Date – data ostatniej aktualizacji File.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getName()

Pobiera nazwę File.

Powrót

String – nazwa File

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

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.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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ędnymi elementu File.

Powrót

FolderIterator – zbiór folderów, które są bezpośrednimi folderami nadrzędnymi elementu File.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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 za pomocą linku.

Powrót

String – klucz zasobu File.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getSecurityUpdateEligible()

Określa, czy ten File może zastosować aktualizację zabezpieczeń, która wymaga klucza zasobu do uzyskania dostępu, gdy jest udostępniany za pomocą linku.

Dysk wymaga klucza zasobu, aby uzyskać dostęp do niektórych plików lub folderów udostępnionych za pomocą linku. Ta zmiana jest częścią aktualizacji zabezpieczeń. Aktualizacja jest domyślnie włączona w przypadku kwalifikujących się 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.

Powrót

Boolean – czy wymaganie dotyczące klucza zasobu można zastosować w przypadku File.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getSecurityUpdateEnabled()

Określa, czy ten File wymaga klucza zasobu do uzyskania dostępu, gdy jest udostępniany 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 w przypadku kwalifikujących się plików, użyj ikony  setSecurityUpdateEnabled.

Dowiedz się więcej o aktualizacji zabezpieczeń Dysku Google.

Powrót

Boolean – czy wymaganie dotyczące klucza zasobu jest włączone w przypadku tego File.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getSharingAccess()

Określa, która grupa użytkowników może uzyskać dostęp do File, oprócz użytkowników, którym wyraźnie przyznano dostęp.

Powrót

Access – która grupa użytkowników może uzyskać dostęp do File

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getSharingPermission()

Pobiera uprawnienia przyznane użytkownikom, którzy mają dostęp do File, oprócz użytkowników, którym wyraźnie przyznano dostęp.

Powrót

Permission – uprawnienia przyznane użytkownikom, którzy mają dostęp do File

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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 używanych do przechowywania File na Dysku. Pamiętaj, że pliki aplikacji Google Workspace nie są wliczane do limitu miejsca na Dysku, dlatego zwracają 0 bajtów.

Powrót

Integer – liczba bajtów użytych do przechowywania File na Dysku.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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 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()}`);

Powrót

String – identyfikator produktu docelowego.


getTargetMimeType()

Jeśli jest to skrót, zwraca typ MIME elementu, do którego prowadzi.

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()}`);

Powrót

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 musisz przekazać, aby uzyskać dostęp do plików udostępnionych za pomocą 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());

Powrót

String – klucz zasobu elementu docelowego lub null, jeśli plik nie jest skrótem.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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 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());
}

Powrót

Blob|null – miniatura pliku.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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 File w aplikacji Google, takiej jak Dysk lub Dokumenty.

Powrót

String – adres URL, którego można użyć do wyświetlenia tego File w aplikacji Google, takiej jak Dysk lub Dokumenty.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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 dla tego File. Jeśli użytkownik, który wykonuje skrypt, nie ma dostępu do edycji 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 (const viewer of viewers) {
    console.log(viewer.getEmail());
  }
}

Powrót

User[] – jeśli użytkownik ma uprawnienia do edycji tego File, zwraca listę przeglądających i komentujących. Jeśli użytkownik nie ma uprawnień do edycji, zwraca pustą tablicę.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

isShareableByEditors()

Określa, czy użytkownicy z uprawnieniami do edycji File mogą udostępniać je innym użytkownikom lub zmieniać uprawnienia.

Powrót

Boolean – true jeśli użytkownicy z uprawnieniami do edycji mogą udostępniać pliki innym użytkownikom lub zmieniać uprawnienia; false jeśli nie.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

isStarred()

Określa, czy File został oznaczony gwiazdką na Dysku użytkownika.

Powrót

Boolean – true, jeśli File jest oznaczony gwiazdką na Dysku użytkownika; false, jeśli nie.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

isTrashed()

Określa, czy 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 w przeciwnym razie.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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 – nowy tekst.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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

NazwaTypOpis
destinationFolderKatalog, do którego chcesz skopiować plik.

Powrót

File – nowy tekst.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive

makeCopy(name)

Tworzy kopię pliku i nadaje jej podaną 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

NazwaTypOpis
nameStringNazwa pliku, która ma zostać zastosowana do nowej kopii.

Powrót

File – nowy tekst.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive

makeCopy(name, destination)

Tworzy kopię pliku w katalogu docelowym i nadaje jej podaną 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

NazwaTypOpis
nameStringNazwa pliku, która ma zostać zastosowana do nowej kopii.
destinationFolderKatalog, do którego chcesz skopiować plik.

Powrót

File – nowy tekst.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive

moveTo(destination)

Przenosi ten element do podanego folderu docelowego.

Aby 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 elementu.

Parametry

NazwaTypOpis
destinationFolderFolder, który stanie się nowym folderem nadrzędnym.

Powrót

File — ten File do tworzenia łańcuszków.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive

removeCommenter(emailAddress)

Usuwa danego użytkownika z listy komentujących File. Ta metoda nie blokuje dostępu do File użytkownikom, którzy należą do klasy użytkowników mających ogólny dostęp, np. jeśli File jest udostępniony 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

NazwaTypOpis
emailAddressStringAdres e-mail użytkownika, którego chcesz usunąć.

Powrót

File — ten File do tworzenia łańcuszków.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive

removeCommenter(user)

Usuwa danego użytkownika z listy komentujących File. Ta metoda nie blokuje dostępu do File użytkownikom, którzy należą do klasy użytkowników mających ogólny dostęp, np. jeśli File jest udostępniony 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

NazwaTypOpis
userUserReprezentacja użytkownika do usunięcia.

Powrót

File — ten File do tworzenia łańcuszków.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive

removeEditor(emailAddress)

Usuwa danego użytkownika z listy osób edytujących File. Ta metoda nie blokuje użytkownikom dostępu do File, jeśli należą oni do klasy użytkowników, którzy mają ogólny dostęp, np. jeśli File jest udostępniony całej domenie użytkownika lub jeśli File znajduje się na dysku współdzielonym, do którego użytkownik ma dostęp.

W przypadku plików na Dysku spowoduje to również usunięcie użytkownika z listy osób, które mogą je wyświetlać.

Parametry

NazwaTypOpis
emailAddressStringAdres e-mail użytkownika, którego chcesz usunąć.

Powrót

File – ten File do tworzenia łańcuszków.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive

removeEditor(user)

Usuwa danego użytkownika z listy osób edytujących File. Ta metoda nie blokuje użytkownikom dostępu do File, jeśli należą oni do klasy użytkowników, którzy mają ogólny dostęp, np. jeśli File jest udostępniony całej domenie użytkownika lub jeśli File znajduje się na dysku współdzielonym, do którego użytkownik ma dostęp.

W przypadku plików na Dysku spowoduje to również usunięcie użytkownika z listy osób, które mogą je wyświetlać.

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika do usunięcia.

Powrót

File — ten File do tworzenia łańcuszków.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive

removeViewer(emailAddress)

Usuwa danego użytkownika z listy przeglądających i komentujących File. Ta metoda nie ma wpływu, jeśli użytkownik jest edytującym, a nie przeglądającym lub komentującym. Ta metoda nie blokuje też dostępu do File użytkownikom, którzy należą do grupy użytkowników mających ogólny dostęp, np. jeśli File jest udostępniony całej domenie użytkownika lub jeśli File znajduje się na dysku współdzielonym, do którego użytkownik ma dostęp.

W przypadku plików na Dysku spowoduje to również usunięcie użytkownika z listy edytujących.

Parametry

NazwaTypOpis
emailAddressStringAdres e-mail użytkownika, którego chcesz usunąć.

Powrót

File – ten znak File służy do łączenia.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive

removeViewer(user)

Usuwa danego użytkownika z listy przeglądających i komentujących File. Ta metoda nie ma wpływu, jeśli użytkownik jest edytującym, a nie przeglądającym. Ta metoda nie blokuje też dostępu do File użytkownikom, którzy należą do klasy użytkowników mających ogólny dostęp, np. jeśli File jest udostępniony całej domenie użytkownika lub jeśli File znajduje się na dysku współdzielonym, do którego użytkownik ma dostęp.

W przypadku plików na Dysku spowoduje to również usunięcie użytkownika z listy edytujących.

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika do usunięcia.

Powrót

File – ten znak File służy do łączenia.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive

revokePermissions(emailAddress)

Unieważnia dostęp do File przyznany danemu użytkownikowi. Ta metoda nie blokuje użytkownikom dostępu do File, jeśli należą oni do klasy użytkowników, którzy mają ogólny dostęp, np. jeśli File jest udostępniony całej domenie użytkownika.

Parametry

NazwaTypOpis
emailAddressStringAdres e-mail użytkownika, któremu należy odebrać dostęp.

Powrót

File — ten File do tworzenia łańcuszków.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive

revokePermissions(user)

Unieważnia dostęp do File przyznany danemu użytkownikowi. Ta metoda nie blokuje użytkownikom dostępu do File, jeśli należą oni do klasy użytkowników, którzy mają ogólny dostęp, np. jeśli File jest udostępniony całej domenie użytkownika.

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika, którego dostęp powinien zostać cofnięty.

Powrót

File – ten File do tworzenia łańcuszków.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive

setContent(content)

Zastępuje zawartość pliku podanym tekstem. Zgłasza wyjątek, jeśli rozmiar pliku content przekracza 10 MB.

// Creates a text file with the content 'Hello, world!'
const 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

NazwaTypOpis
contentStringNowa zawartość pliku.

Powrót

File — ten File do tworzenia łańcuszków.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive

setDescription(description)

Ustawia opis elementu File.

Parametry

NazwaTypOpis
descriptionStringnowy opis File.

Powrót

File – ten File, do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive

setName(name)

Ustawia nazwę elementu File.

Parametry

NazwaTypOpis
nameStringnowa nazwa File;

Powrót

File – ten File, do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive

setOwner(emailAddress)

Zmienia właściciela File. Ta metoda przyznaje też poprzedniemu właścicielowi wyraźne uprawnienia do edycji File.

Parametry

NazwaTypOpis
emailAddressStringadres e-mail użytkownika, który ma zostać nowym właścicielem;

Powrót

File – ten File, do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive

setOwner(user)

Zmienia właściciela File. Ta metoda przyznaje też poprzedniemu właścicielowi wyraźne uprawnienia do edycji File.

Parametry

NazwaTypOpis
userUserreprezentację użytkownika, który ma zostać nowym właścicielem;

Powrót

File – ten File, do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive

setSecurityUpdateEnabled(enabled)

Określa, czy File wymaga klucza zasobu do 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

NazwaTypOpis
enabledBooleanOkreśla, czy w przypadku File ma być wymagany klucz zasobu.

Powrót

File – ten File do tworzenia łańcuszków.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive

setShareableByEditors(shareable)

Określa, czy użytkownicy z uprawnieniami do edycji File mogą udostępniać pliki innym użytkownikom lub zmieniać uprawnienia. Domyślna wartość nowego parametru File to true.

Parametry

NazwaTypOpis
shareableBooleantrue czy użytkownicy z uprawnieniami do edycji powinni mieć możliwość udostępniania innym użytkownikom lub zmiany uprawnień; false jeśli nie,

Powrót

File – ten File, do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive

setSharing(accessType, permissionType)

Określa, która klasa użytkowników może uzyskać dostęp do File i jakie uprawnienia są im przyznawane, oprócz uprawnień przyznanych poszczególnym użytkownikom.

// 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.)
const folder = DriveApp.createFolder('Shared Folder');
folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);

Parametry

NazwaTypOpis
accessTypeAccessktóra grupa użytkowników powinna mieć dostęp do File.
permissionTypePermissionuprawnienia, które powinny zostać przyznane użytkownikom mającym dostęp do File;

Powrót

File – ten File, do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive

setStarred(starred)

Określa, czy File jest oznaczony gwiazdką na Dysku użytkownika. Wartość domyślna dla nowych File to false.

Parametry

NazwaTypOpis
starredBooleantrue, jeśli File ma być oznaczony gwiazdką na Dysku użytkownika; false, jeśli nie.

Powrót

File – ten File, do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive

setTrashed(trashed)

Określa, czy File znajduje się w koszu na Dysku użytkownika. Tylko właściciel może przenieść File do kosza. Wartość domyślna nowych File to false.

Parametry

NazwaTypOpis
trashedBooleantrue – jeśli File ma zostać przeniesiony do kosza na Dysku użytkownika; false – w przeciwnym razie.

Powrót

File – ten File, do tworzenia łańcuszków

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/drive