Class File

Plik

plik na Dysku Google, Pliki można tworzyć i otwierać 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 danego użytkownika do listy komentujących File.
addCommenter(user)FileDodaj danego użytkownika do listy komentujących File.
addCommenters(emailAddresses)FileDodaj podany tablicowy zbiór użytkowników do listy komentujących w ramach File.
addEditor(emailAddress)FileDodaje danego użytkownika do listy edytujących File.
addEditor(user)FileDodaje danego użytkownika do listy edytujących File.
addEditors(emailAddresses)FileDodaje podany tablicowy zbiór użytkowników do listy edytujących w przypadku File.
addViewer(emailAddress)FileDodaje danego użytkownika do listy widzów File.
addViewer(user)FileDodaje danego użytkownika do listy widzów File.
addViewers(emailAddresses)FileDodaje podany tablicowy zbiór 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 z tego obiektu jako blob przekonwertowany na określony typ treści.
getBlob()BlobZwraca dane z tego obiektu jako blob.
getDateCreated()DatePobiera datę utworzenia elementu File.
getDescription()StringPobiera opis elementu File.
getDownloadUrl()StringPobiera adres URL, którego można użyć do pobrania pliku.
getEditors()User[]Pobiera listę edytorów tego File.
getId()StringPobiera identyfikator File.
getLastUpdated()DatePobiera datę ostatniej aktualizacji elementu 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 folderami nadrzędnymi folderu 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 File może zastosować aktualizację zabezpieczeń, która wymaga klucza zasobu do uzyskania dostępu, gdy jest udostępniana za pomocą linku.
getSecurityUpdateEnabled()BooleanOkreśla, czy ten element File wymaga klucza zasobu, aby uzyskać dostęp, gdy jest udostępniany za pomocą linku.
getSharingAccess()AccessPobiera informacje o tym, którzy użytkownicy mają dostęp do File, z wyjątkiem tych, którzy mają do niego wyraźnie przyznany dostęp.
getSharingPermission()PermissionPobiera uprawnienia przyznane użytkownikom, którzy mogą uzyskać dostęp do File, z wyjątkiem pojedynczych użytkowników, którym dostęp został wyraźnie przyznany.
getSize()IntegerPobiera liczbę bajtów użytych do przechowywania File na Dysku.
getTargetId()StringJeśli jest to skrót, zwraca identyfikator elementu, do którego się odwołuje.
getTargetMimeType()StringJeśli jest to skrót, zwraca typ MIME elementu, do którego się odwołuje.
getTargetResourceKey()StringJeśli plik jest skrótem, zwraca klucz zasobu elementu, do którego się odwołuje.
getThumbnail()BlobPobiera miniaturę pliku lub null, jeśli miniatura nie istnieje.
getUrl()StringPobiera adres URL, za pomocą którego można otworzyć File w aplikacji Google, takiej jak Dysk lub Dokumenty.
getViewers()User[]Pobiera listę osób, które oglądały lub komentowały ten File.
isShareableByEditors()BooleanOkreśla, czy użytkownicy z uprawnieniami do edycji w File mogą udostępniać inne uprawnienia innym użytkownikom lub zmieniać uprawnienia.
isStarred()BooleanOkreśla, czy File zostało oznaczone 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 podany w prośbie nazwę.
makeCopy(name, destination)FileTworzy kopię pliku w katalogu docelowym i nadaje mu podany w parametrze nazwę.
moveTo(destination)FilePrzenosi ten element do podanego folderu docelowego.
removeCommenter(emailAddress)FileUsunięcie danego użytkownika z listy komentujących w przypadku File.
removeCommenter(user)FileUsunięcie danego użytkownika z listy komentujących w przypadku File.
removeEditor(emailAddress)FileUsunięcie danego użytkownika z listy edytujących w przypadku File.
removeEditor(user)FileUsunięcie danego użytkownika z listy edytujących w przypadku File.
removeViewer(emailAddress)FileUsunięcie danego użytkownika z listy widzów i komentujących File.
removeViewer(user)FileUsunięcie danego użytkownika z listy widzów i komentujących File.
revokePermissions(emailAddress)FileUnieważnia przyznany danemu użytkownikowi dostęp do File.
revokePermissions(user)FileUnieważnia przyznany danemu użytkownikowi dostęp do File.
setContent(content)FileZastępuje zawartość pliku podanym tekstem.
setDescription(description)FileUstawia opis File.
setName(name)FileUstawia nazwę File.
setOwner(emailAddress)FileZmienia właściciela File.
setOwner(user)FileZmienia właściciela File.
setSecurityUpdateEnabled(enabled)FileOkreśla, czy File wymaga klucza zasobu, aby uzyskać dostęp, gdy jest udostępniany za pomocą linku.
setShareableByEditors(shareable)FileOkreśla, czy użytkownicy z uprawnieniami do edycji w File mogą udostępniać innym użytkownikom lub zmieniać uprawnienia.
setSharing(accessType, permissionType)FileOkreśla, które grupy użytkowników mogą uzyskiwać dostęp do File i jakie uprawnienia są im przyznawane, oprócz użytkowników indywidualnych, którzy mają wyraźnie przyznany dostęp.
setStarred(starred)FileOkreśla, czy File ma być oznaczone 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 danego 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 – ta File służy do tworzenia łańcuszków.

Autoryzacja

Skrypty, które korzystają 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 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 – ta File służy do tworzenia łańcuszków.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

addCommenters(emailAddresses)

Dodaj podany tablicowy zbiór użytkowników do listy komentujących w ramach File. Jeśli któryś z użytkowników był już na liście widzów, ta metoda spowoduje usunięcie 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 – ta File służy do tworzenia łańcuszków.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

addEditor(emailAddress)

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

Parametry

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

Powrót

File – ta File służy do tworzenia łańcuszków.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

addEditor(user)

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

Parametry

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

Powrót

File – ta File służy do tworzenia łańcuszków.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

addEditors(emailAddresses)

Dodaje podany tablicowy zbiór użytkowników do listy edytujących w przypadku File. Jeśli któryś z użytkowników znajduje się już na liście widzów, ta metoda spowoduje usunięcie go z tej listy.

Parametry

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

Powrót

File – ta File służy do tworzenia łańcuszków.

Autoryzacja

Skrypty, które korzystają 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 widzów File. Jeśli użytkownik był już na liście redaktorów, ta metoda nie przyniesie efektu.

Parametry

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

Powrót

File – ta File służy do tworzenia łańcuszków.

Autoryzacja

Skrypty, które korzystają 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 widzów File. Jeśli użytkownik był już na liście redaktorów, ta metoda nie przyniesie efektu.

Parametry

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

Powrót

File – ta File służy do tworzenia łańcuszków.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

addViewers(emailAddresses)

Dodaje podany tablicowy zbiór 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 – ta File służy do tworzenia łańcuszków.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym 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ń grupy dyskusyjnej Google ani uprawnień odziedziczonych 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, które korzystają 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 konkretnemu użytkownikowi. Ta metoda nie obsługuje zwracania uprawnień grupy dyskusyjnej Google ani uprawnień odziedziczonych przez grupy dyskusyjne Google.

Parametry

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

Powrót

Permission – uprawnienia przyznane użytkownikowi.

Autoryzacja

Skrypty, które korzystają 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 z tego obiektu jako blob przekonwertowany na określony typ treści. Ta metoda dodaje odpowiednie rozszerzenie do nazwy pliku, np. „mójplik.pdf”. Zakłada ona jednak, że część nazwy pliku, która następuje po ostatnim okresie (jeśli w ogóle występuje), to istniejące rozszerzenie, które należy zastąpić. W rezultacie plik „ShoppingList.12.25.2014” zmieni nazwę na „ShoppingList.12.25.pdf”.

Informacje o limitach dziennych konwersji znajdziesz w artykule Limity dotyczące usług Google. Nowo utworzone domeny Google Workspace mogą być tymczasowo objęte bardziej rygorystycznymi limitami.

Parametry

NazwaTypOpis
contentTypeStringTyp MIME, na który ma nastąpić konwersja. W przypadku większości blobów opcja 'application/pdf' jest jedyną prawidłową opcją. W przypadku obrazów w formacie BMP, GIF, JPEG lub PNG prawidłowe są również wartości 'image/bmp', 'image/gif', 'image/jpeg' lub 'image/png'. W przypadku dokumentu w Dokumentach Google możesz też użyć 'text/markdown'.

Powrót

Blob – dane w postaci bloba.


getBlob()

Zwraca dane z tego obiektu jako blob.

Powrót

Blob – dane w postaci bloba.


getDateCreated()

Pobiera datę utworzenia elementu File.

Powrót

Date – data utworzenia File

Autoryzacja

Skrypty, które korzystają 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

getDescription()

Pobiera opis elementu File.

Powrót

String – opis elementu File,

Autoryzacja

Skrypty, które korzystają 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

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 plików 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 była uwzględniona 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());
}

Powrót

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

Autoryzacja

Skrypty, które korzystają 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 File. Jeśli użytkownik, który wykonuje skrypt, nie ma uprawnień do edytowania elementu File, ta metoda zwraca pusty 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 elementu File, zwraca listę edytorów. Jeśli użytkownik nie ma uprawnień do edycji, zwraca pustą tablicę.

Autoryzacja

Skrypty, które korzystają 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()

Pobiera identyfikator File.

Powrót

String – identyfikator File

Autoryzacja

Skrypty, które korzystają 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

getLastUpdated()

Pobiera datę ostatniej aktualizacji elementu File.

Powrót

Date – data ostatniej aktualizacji File

Autoryzacja

Skrypty, które korzystają 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

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, które korzystają 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()

Pobiera nazwę File.

Powrót

String – nazwa File

Autoryzacja

Skrypty, które korzystają 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

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, które korzystają 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 kolekcję folderów, które są bezpośrednimi folderami nadrzędnymi folderu File.

Powrót

FolderIterator – kolekcja folderów, które są bezpośrednimi folderami nadrzędnymi folderu File

Autoryzacja

Skrypty, które korzystają 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 za pomocą linku.

Powrót

String – klucz zasobu File.

Autoryzacja

Skrypty, które korzystają 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()

Określa, czy File może zastosować aktualizację zabezpieczeń, która wymaga klucza zasobu do uzyskania dostępu, gdy jest udostępniana 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ć wymóg klucza zasobu w przypadku kwalifikujących się plików, użyj opcji setSecurityUpdateEnabled.

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

Powrót

Boolean – czy można zastosować wymóg klucza zasobu w przypadku File.

Autoryzacja

Skrypty, które korzystają 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()

Pobiera informację, czy ten File wymaga klucza zasobu, aby uzyskać dostęp, 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ć wymóg klucza zasobu w przypadku kwalifikujących się plików, użyj setSecurityUpdateEnabled.

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

Powrót

Boolean – określa, czy w przypadku tego File jest włączone wymaganie klucza zasobu.

Autoryzacja

Skrypty, które korzystają 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()

Pobiera informacje o klasie użytkowników, którzy mogą uzyskać dostęp do File, z wyjątkiem użytkowników, którzy mają wyraźnie przyznany dostęp.

Powrót

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

Autoryzacja

Skrypty, które korzystają 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()

Pobiera uprawnienia przyznane użytkownikom, którzy mogą uzyskać dostęp do File, z wyjątkiem pojedynczych użytkowników, którym dostęp został wyraźnie przyznany.

Powrót

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

Autoryzacja

Skrypty, które korzystają 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żytych do przechowywania File na Dysku. Pamiętaj, że pliki aplikacji Google Workspace nie są wliczane do limitu miejsca na dane na Dysku, dlatego zwracane są bajty 0.

Powrót

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

Autoryzacja

Skrypty, które korzystają 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 jest to skrót, zwraca identyfikator elementu, do którego się odwołuje.

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 docelowego produktu.


getTargetMimeType()

Jeśli jest to skrót, zwraca typ MIME elementu, do którego się odwołuje.

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


getTargetResourceKey()

Jeśli plik jest skrótem, zwraca klucz zasobu elementu, do którego się odwołuje. 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, które korzystają 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 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 – miniatura pliku.

Autoryzacja

Skrypty, które korzystają 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ć 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, które korzystają 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ę osób, które oglądały lub komentowały ten File. Jeśli użytkownik, który wykonuje skrypt, nie ma uprawnień do edycji obiektu File, ta metoda zwraca pusty 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, które korzystają 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

isShareableByEditors()

Określa, czy użytkownicy z uprawnieniami do edycji w File mogą udostępniać inne uprawnienia 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, które korzystają 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 File zostało oznaczone gwiazdką na Dysku użytkownika.

Powrót

Boolean – true, jeśli File ma gwiazdkę na Dysku użytkownika; false w przeciwnym razie.

Autoryzacja

Skrypty, które korzystają 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 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

Autoryzacja

Skrypty, które korzystają 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());
}

Powrót

File – nowa kopia.

Autoryzacja

Skrypty, które korzystają 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

NazwaTypOpis
destinationFolderKatalog, do którego ma zostać skopiowany plik.

Powrót

File – nowa kopia.

Autoryzacja

Skrypty, które korzystają 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 podany w prośbie 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 powinna zostać zastosowana do nowej kopii.

Powrót

File – nowa kopia.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

makeCopy(name, destination)

Tworzy kopię pliku w katalogu docelowym i nadaje mu podany w parametrze 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 powinna zostać zastosowana do nowej kopii.
destinationFolderKatalog, do którego ma zostać skopiowany plik.

Powrót

File – nowa kopia.

Autoryzacja

Skrypty, które korzystają 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 przenieść element do folderu docelowego, bieżący użytkownik musi być jego właścicielem lub mieć co najmniej uprawnienia do edycji do bieżącego folderu nadrzędnego elementu.

Parametry

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

Powrót

File – ta File służy do tworzenia łańcuszków.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

removeCommenter(emailAddress)

Usunięcie danego użytkownika z listy komentujących w przypadku File. Ta metoda nie blokuje dostępu do File użytkownikom, którzy należą do grupy użytkowników z ogólnym dostępem. Na przykład, 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 – ta File służy do tworzenia łańcuszków.

Autoryzacja

Skrypty, które korzystają 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 w przypadku File. Ta metoda nie blokuje dostępu do File użytkownikom, którzy należą do grupy użytkowników z ogólnym dostępem. Na przykład, 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 – ta File służy do tworzenia łańcuszków.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

removeEditor(emailAddress)

Usunięcie danego użytkownika z listy edytujących w przypadku File. Ta metoda nie blokuje dostępu do File użytkownikom, którzy należą do grupy użytkowników z ogólnym dostępem. Na przykład, 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 widzów.

Parametry

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

Powrót

File – ta File służy do tworzenia łańcuszków.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

removeEditor(user)

Usunięcie danego użytkownika z listy edytujących w przypadku File. Ta metoda nie blokuje dostępu do File użytkownikom, którzy należą do grupy użytkowników z ogólnym dostępem. Na przykład, 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 widzów.

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika do usunięcia.

Powrót

File – ta File służy do tworzenia łańcuszków.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

removeViewer(emailAddress)

Usunięcie danego użytkownika z listy widzów i komentujących File. Ta metoda nie ma żadnego wpływu, jeśli użytkownik jest edytorem, a nie widzem lub komentatorem. Ta metoda nie blokuje też dostępu do File użytkownikom, którzy należą do grupy użytkowników z ogólnym dostępem. Na przykład, 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 edytorów.

Parametry

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

Powrót

File – File do łańcucha.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

removeViewer(user)

Usunięcie danego użytkownika z listy widzów i komentujących File. Ta metoda nie ma żadnego wpływu, jeśli użytkownik jest edytorem, a nie widzem. Ta metoda nie blokuje też dostępu do File użytkownikom, którzy należą do grupy użytkowników z ogólnym dostępem. Na przykład 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.File

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

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika do usunięcia.

Powrót

File – File do łańcucha.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

revokePermissions(emailAddress)

Unieważnia przyznany danemu użytkownikowi dostęp do File. Ta metoda nie blokuje dostępu do File użytkownikom, którzy należą do grupy użytkowników z ogólnym dostępem. Na przykład, jeśli File jest udostępniony całej domenie użytkownika.

Parametry

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

Powrót

File – ta File służy do tworzenia łańcuszków.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

revokePermissions(user)

Unieważnia przyznany danemu użytkownikowi dostęp do File. Ta metoda nie blokuje dostępu do File użytkownikom, którzy należą do grupy użytkowników z ogólnym dostępem. Na przykład, jeśli File jest udostępniony całej domenie użytkownika.

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika, którego uprawnienia dostępu należy cofnąć.

Powrót

File – ta File służy do tworzenia łańcuszków.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

setContent(content)

Zastępuje zawartość pliku podanym tekstem. Wyjątek jest zgłaszany, jeśli 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
contentStringnowe treści w pliku.

Powrót

File – ta File służy do tworzenia łańcuszków.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

setDescription(description)

Ustawia opis File.

Parametry

NazwaTypOpis
descriptionStringnowy opis File.

Powrót

File – ta File, aby utworzyć łańcuch

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

setName(name)

Ustawia nazwę File.

Parametry

NazwaTypOpis
nameStringnowa nazwa File

Powrót

File – ta File, aby utworzyć łańcuch

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

setOwner(emailAddress)

Zmienia właściciela File. Ta metoda daje również poprzedniemu właścicielowi wyraźny dostęp do edycji File.

Parametry

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

Powrót

File – ta File, aby utworzyć łańcuch

Autoryzacja

Skrypty, które korzystają 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 File. Ta metoda daje również poprzedniemu właścicielowi wyraźny dostęp do edycji File.

Parametry

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

Powrót

File – ta File, aby utworzyć łańcuch

Autoryzacja

Skrypty, które korzystają 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, aby uzyskać dostęp, 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 – ta File służy do tworzenia łańcuszków.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

setShareableByEditors(shareable)

Określa, czy użytkownicy z uprawnieniami do edycji w File mogą udostępniać innym użytkownikom lub zmieniać uprawnienia. Wartość domyślna dla nowego typu File to true.

Parametry

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

Powrót

File – ta File, aby utworzyć łańcuch

Autoryzacja

Skrypty, które korzystają 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óre grupy użytkowników mogą uzyskać dostęp do File i jakie uprawnienia zostaną im przyznane, z wyłączeniem użytkowników indywidualnych, którzy uzyskali dostęp wprost.

// 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
accessTypeAccessklasa użytkowników, która powinna mieć dostęp do File
permissionTypePermissionuprawnienia, które należy przyznać użytkownikom mającym dostęp do File.

Powrót

File – ta File, aby utworzyć łańcuch

Autoryzacja

Skrypty, które korzystają 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ć oznaczone gwiazdką na Dysku użytkownika. Wartość domyślna dla nowych Fileto false.

Parametry

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

Powrót

File – ta File, aby utworzyć łańcuch

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym 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 dla nowych typów 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 – ta File, aby utworzyć łańcuch

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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