Class File

Plik

plik na Dysku Google, Pliki można tworzyć i otwierać 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

MetodaZwracany typKrótki opis
addCommenter(emailAddress)FileDodaj danego użytkownika do listy komentujących zasobu File.
addCommenter(user)FileDodaj danego użytkownika do listy komentujących zasobu File.
addCommenters(emailAddresses)FileDodaj podaną tablicę użytkowników do listy komentujących obiektu File.
addEditor(emailAddress)FileDodaje danego użytkownika do listy edytorów zasobu File.
addEditor(user)FileDodaje danego użytkownika do listy edytorów zasobu File.
addEditors(emailAddresses)FileDodaje podaną tablicę użytkowników do listy edytorów zasobu File.
addViewer(emailAddress)FileDodaje danego użytkownika do listy przeglądających w: File.
addViewer(user)FileDodaje danego użytkownika do listy przeglądających w: File.
addViewers(emailAddresses)FileDodaje podaną tablicę użytkowników do listy przeglądających obiekt File.
getAccess(email)PermissionPobiera uprawnienie przyznane danemu użytkownikowi.
getAccess(user)PermissionPobiera uprawnienie przyznane danemu użytkownikowi.
getAs(contentType)BlobZwraca dane wewnątrz tego obiektu jako obiekt blob przekonwertowany na określony typ treści.
getBlob()BlobZwraca dane wewnątrz tego obiektu jako obiekt blob.
getDateCreated()DateOtrzymuje 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 elementu File.
getId()StringPobiera identyfikator elementu File.
getLastUpdated()DatePobiera datę ostatniej aktualizacji urządzenia File.
getMimeType()StringPobiera typ MIME pliku.
getName()StringPobiera nazwę elementu File.
getOwner()UserPobiera właściciela pliku.
getParents()FolderIteratorPobiera kolekcję folderów, które są bezpośrednimi elementami nadrzędnymi folderu File.
getResourceKey()StringPobiera klucz zasobu File wymagany, aby uzyskać dostęp do elementów, które zostały udostępnione za pomocą linku.
getSecurityUpdateEligible()BooleanOkreśla, czy to urządzenie File kwalifikuje się do stosowania aktualizacji zabezpieczeń, która wymaga klucza zasobu, aby uzyskać dostęp, gdy jest on udostępniany za pomocą linku.
getSecurityUpdateEnabled()BooleanOkreśla, czy File wymaga klucza zasobu, aby uzyskać dostęp, gdy jest udostępnione za pomocą linku.
getSharingAccess()AccessPobiera klasę użytkowników, którzy mają dostęp do: File (oprócz poszczególnych osób) użytkownikom, którym wprost przyznano dostęp.
getSharingPermission()Permissionpobiera uprawnienia przyznane użytkownikom, którzy mają dostęp do: File, oprócz poszczególnych użytkowników, którym wprost przyznano dostęp.
getSize()IntegerPobiera liczbę bajtów używanych do przechowywania elementu 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()BlobPobiera obraz miniatury pliku lub null, jeśli miniatura nie istnieje.
getUrl()StringUzyskuje adres URL, którego można użyć do otwarcia pliku File w aplikacji Google, np. Dysk lub Dokumenty.
getViewers()User[]Pobiera listę przeglądających i komentujących dla elementu File.
isShareableByEditors()BooleanOkreśla, czy użytkownicy z uprawnieniami do edycji zasobu File mogą udostępnić innym użytkownikom lub zmienić uprawnienia.
isStarred()BooleanOkreśla, czy element 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 mu nazwę (nadać mu podaną nazwę).
makeCopy(name, destination)FileTworzy kopię pliku w katalogu docelowym i nadaje mu nazwę na podstawie podanej nazwy.
moveTo(destination)FilePrzenosi ten element do podanego folderu docelowego.
removeCommenter(emailAddress)FileUsuwa dane użytkownika z listy komentujących do: File.
removeCommenter(user)FileUsuwa dane użytkownika z listy komentujących do: File.
removeEditor(emailAddress)FileUsuwa danego użytkownika z listy edytorów zasobu File.
removeEditor(user)FileUsuwa danego użytkownika z listy edytorów zasobu File.
removeViewer(emailAddress)FileUsuwa dane użytkownika z listy przeglądających i komentujących File.
removeViewer(user)FileUsuwa dane użytkownika z listy przeglądających i komentujących File.
revokePermissions(emailAddress)FileOdbierze uprawnienia File przyznane danemu użytkownikowi.
revokePermissions(user)FileOdbierze uprawnienia File przyznane danemu użytkownikowi.
setContent(content)FilePowoduje zastąpienie zawartości pliku danym zamiennikiem.
setDescription(description)FileUstawia opis elementu File.
setName(name)FileOkreśla 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, aby uzyskać dostęp, gdy jest udostępnione za pomocą linku.
setShareableByEditors(shareable)FileOkreśla, czy użytkownicy z uprawnieniami do edycji w elemencie File mogą udostępniać treści innym użytkownikom lub zmienić uprawnienia.
setSharing(accessType, permissionType)FileOkreśla, które klasy użytkowników mają dostęp do elementu File i jakie uprawnienia użytkownicy, którym przyznano dostęp wprost.
setStarred(starred)FileOkreśla, czy element File jest oznaczony gwiazdką na Dysku użytkownika.
setTrashed(trashed)FileOkreśla, czy File znajduje się w koszu Dysku użytkownika.

Szczegółowa dokumentacja

addCommenter(emailAddress)

Dodaj danego użytkownika do listy komentujących zasobu File. Jeśli użytkownik był już znajdują się na liście widzów, więc ta metoda wycofuje użytkownika z listy widzów.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace 'cloudysanfrancisco@gmail.com' with the email address that you
// want to add as a commenter.
while (files.hasNext()) {
  const file = files.next();
  email = 'cloudysanfrancisco@gmail.com';
  console.log(file.addCommenter(email));
}

Parametry

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

Powrót

FileFile do łańcuchów.

Autoryzacja

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 zasobu File. Jeśli użytkownik był już znajdują się na liście widzów, więc ta metoda wycofuje użytkownika z listy widzów.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Adds the active user as a commenter.
while (files.hasNext()) {
  const file = files.next();
  file.addCommenter(Session.getActiveUser());
}

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika, który ma zostać dodany.

Powrót

FileFile do łańcuchów.

Autoryzacja

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 obiektu File. Jeśli tak, użytkowników było już na liście widzów, więc ta metoda powoduje wyeliminowanie ich z listy widzów.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

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 do dodania.

Powrót

FileFile do łańcuchów.

Autoryzacja

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 danego użytkownika do listy edytorów zasobu File. Jeśli użytkownik był już na liście widzów, ta metoda wycofuje użytkownika z listy widzów.

Parametry

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

Powrót

FileFile do łańcuchów.

Autoryzacja

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 danego użytkownika do listy edytorów zasobu File. Jeśli użytkownik był już na liście widzów, ta metoda wycofuje użytkownika z listy widzów.

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika, który ma zostać dodany.

Powrót

FileFile do łańcuchów.

Autoryzacja

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 zasobu File. Jeśli któryś z Użytkownicy byli już na liście widzów, więc ta metoda powoduje wyeliminowanie ich z listy widzów.

Parametry

NazwaTypOpis
emailAddressesString[]Tablica adresów e-mail użytkowników do dodania.

Powrót

FileFile do łańcuchów.

Autoryzacja

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 w: File. Jeśli użytkownik był już na liście redaktorów, ta metoda nie będzie działać.

Parametry

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

Powrót

FileFile do łańcuchów.

Autoryzacja

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 w: File. Jeśli użytkownik był już na liście redaktorów, ta metoda nie będzie działać.

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika, który ma zostać dodany.

Powrót

FileFile do łańcuchów.

Autoryzacja

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 przeglądających obiekt File. Jeśli któryś z Użytkownicy byli już na liście edytorów, ta metoda nie ma u nich żadnego efektu.

Parametry

NazwaTypOpis
emailAddressesString[]Tablica adresów e-mail użytkowników do dodania.

Powrót

FileFile do łańcuchów.

Autoryzacja

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 uprawnienie przyznane danemu użytkownikowi.

Parametry

NazwaTypOpis
emailStringadres e-mail użytkownika, którego uprawnienia powinny zostać sprawdzone.

Powrót

Permission – uprawnienia przyznane użytkownikowi;

Autoryzacja

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 uprawnienie przyznane danemu użytkownikowi.

Parametry

NazwaTypOpis
userUserreprezentacja użytkownika, którego uprawnienia powinny zostać sprawdzone

Powrót

Permission – uprawnienia przyznane użytkownikowi;

Autoryzacja

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. Ten dodaje do nazwy pliku odpowiednie rozszerzenie, na przykład „mojplik.pdf”. Jednak zakłada, że część nazwy pliku, która następuje po ostatnim kropce (jeśli występuje), jest już , które należy zastąpić. W rezultacie „ShoppingList.12.25.2014” zmienia się w „ShoppingList.12.25.pdf”.

Aby wyświetlić dzienne limity konwersji, zobacz Limity dla Google Usługi. Nowo utworzone domeny Google Workspace mogą być tymczasowo bardziej rygorystyczne limity.

Parametry

NazwaTypOpis
contentTypeStringTyp MIME do skonwertowania. W przypadku większości blobów atrybut 'application/pdf' to jedyną prawidłową opcją. W przypadku zdjęć w formacie BMP, GIF, JPEG lub PNG możesz też użyć dowolnego z tych atrybutów: 'image/bmp', 'image/gif', 'image/jpeg' lub 'image/png'. prawidłowe. W przypadku dokumentów w Dokumentach Google prawidłowa jest też wartość 'text/markdown'.

Powrót

Blob – dane w postaci obiektu blob.


getBlob()

Zwraca dane wewnątrz tego obiektu jako obiekt blob.

Powrót

Blob – dane w postaci obiektu blob.


getDateCreated()

Otrzymuje datę utworzenia elementu File.

Powrót

Date – data utworzenia elementu File;

Autoryzacja

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

getDescription()

Pobiera opis elementu File.

Powrót

String – opis pola File.

Autoryzacja

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

getDownloadUrl()

Pobiera adres URL, którego można użyć do pobrania pliku. Tylko użytkownicy z uprawnieniami do otwierania pliku na Dysku Google mogą uzyskać dostęp do adresu URL. Możesz użyć tego adresu URL w przeglądarce, aby pobrać plik, ale nie możesz użyć do pobrania pliku z UrlFetchApp. Jeśli chcesz, aby zawartość pliku 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, który może służyć do pobrania pliku.

Autoryzacja

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

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Adds the email addresses in the array as editors of each file.
  // TODO(developer): Replace 'cloudysanfrancisco@gmail.com'
  // and 'baklavainthebalkans@gmail.com' with valid email addresses.
  file.addEditors(['cloudysanfrancisco@gmail.com', 'baklavainthebalkans@gmail.com']);

  // Gets a list of the file editors.
  const editors = file.getEditors();

  // For each file, logs the editors' email addresses to the console.
  for (const editor of editors) {
    console.log(editor.getEmail());
  }
}

Powrót

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

Autoryzacja

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()

Pobiera identyfikator elementu File.

Powrót

String – identyfikator instancji File,

Autoryzacja

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

getLastUpdated()

Pobiera datę ostatniej aktualizacji urządzenia File.

Powrót

Date – data ostatniej aktualizacji elementu File.

Autoryzacja

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

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 co najmniej jednym z tych zakresów:

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

getName()

Pobiera nazwę elementu File.

Powrót

String – nazwa File

Autoryzacja

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

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 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 elementami nadrzędnymi folderu File.

Powrót

FolderIterator – zbiór folderów, które są bezpośrednimi elementami nadrzędnymi folderu File

Autoryzacja

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 wymagany, aby uzyskać dostęp do elementów, które zostały udostępnione za pomocą linku.

Powrót

String – klucz zasobu klasy File.

Autoryzacja

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()

Określa, czy to urządzenie File kwalifikuje się do stosowania aktualizacji zabezpieczeń, która wymaga klucza zasobu, aby uzyskać dostęp, gdy jest on 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ą . Ta zmiana jest częścią aktualizacji zabezpieczeń. Aktualizacja jest domyślnie włączona dla kwalifikujących się użytkowników pliki i foldery. Aby włączyć lub wyłączyć wymaganie dotyczące klucza zasobu w przypadku kwalifikujących się plików, użyj polecenia setSecurityUpdateEnabled

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

Powrót

Boolean – określa, czy wymaganie dotyczące klucza zasobu można zastosować do File.

Autoryzacja

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()

Określa, czy File wymaga klucza zasobu, aby uzyskać dostęp, gdy jest udostępnione 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 dotyczące klucza zasobu w przypadku kwalifikujących się plików, użyj funkcji setSecurityUpdateEnabled.

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

Powrót

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

Autoryzacja

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()

Pobiera klasę użytkowników, którzy mają dostęp do: File (oprócz poszczególnych osób) użytkownikom, którym wprost przyznano dostęp.

Powrót

Access – klasa użytkowników, którzy mają dostęp do pliku File.

Autoryzacja

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()

pobiera uprawnienia przyznane użytkownikom, którzy mają dostęp do: File, oprócz poszczególnych użytkowników, którym wprost przyznano dostęp.

Powrót

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

Autoryzacja

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. Pamiętaj, że Pliki aplikacji Google Workspace nie wliczają się do limitu miejsca na Dysku, więc nie wliczają się do limitu miejsca na Dysku. 0 B.

Powrót

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

Autoryzacja

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 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 z dodatkowego parametru, który trzeba przekazać, by uzyskać dostęp do plików udostępnionych za pomocą .

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

Powrót

Blob – miniatura pliku.

Autoryzacja

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()

Uzyskuje adres URL, którego można użyć do otwarcia pliku File w aplikacji Google, np. Dysk lub Dokumenty.

Powrót

String – adres URL umożliwiający wyświetlenie elementu File w aplikacji Google, np. Dysk lub Dokumenty

Autoryzacja

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 dla elementu File. Jeśli użytkownik, który uruchamia skrypt, nie ma uprawnień do edycji elementu File, ta metoda zwraca pustą tablicę.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // For each file, logs the viewers' email addresses to the console.
  const viewers = file.getViewers();
  for (viewer of viewers) {
    console.log(viewer.getEmail());
  }
}

Powrót

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

Autoryzacja

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

isShareableByEditors()

Określa, czy użytkownicy z uprawnieniami do edycji zasobu File mogą udostępnić innym użytkownikom lub zmienić uprawnienia.

Powrót

Booleantrue, jeśli użytkownicy z uprawnieniami do edycji mogą udostępniać treści innym użytkownikom lub zmienić uprawnienia; false, jeśli nie

Autoryzacja

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 element File został oznaczony gwiazdką na Dysku użytkownika.

Powrót

Booleantrue, jeśli element File jest oznaczony gwiazdką na Dysku użytkownika; false, jeśli nie

Autoryzacja

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 File znajduje się w koszu na Dysku użytkownika.

Powrót

Booleantrue, jeśli File znajduje się w koszu na Dysku użytkownika; false, jeśli nie

Autoryzacja

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

Powrót

File – nowa wersja,

Autoryzacja

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

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

Powrót

File – nowa wersja,

Autoryzacja

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ę (nadać mu 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 powinna zostać zastosowana do nowej kopii.

Powrót

File – nowa wersja,

Autoryzacja

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)

Tworzy kopię pliku w katalogu docelowym i nadaje mu nazwę na podstawie podanej nazwy.

// 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 chcesz skopiować plik.

Powrót

File – nowa wersja,

Autoryzacja

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.

Bieżący użytkownik musi być właścicielem pliku lub mieć co najmniej uprawnienia do edycji elementu w bieżącym folderze nadrzędnym, aby przenieść element do folderu docelowego.

Parametry

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

Powrót

FileFile do łańcuchów.

Autoryzacja

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 dane użytkownika z listy komentujących do: File. Ta metoda nie blokuje dostępu do elementu File użytkownikom, którzy należą do klasy użytkowników. którzy mają dostęp ogólny – jeśli na przykład element File jest udostępniony całą domenę.

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

FileFile do łańcuchów.

Autoryzacja

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 dane użytkownika z listy komentujących do: File. Ta metoda nie blokuje dostępu do elementu File użytkownikom, którzy należą do klasy użytkowników. którzy mają dostęp ogólny – jeśli na przykład element File jest udostępniony całą domenę.

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

FileFile do łańcuchów.

Autoryzacja

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 zasobu File. Ta metoda nie: zablokuj dostęp do usługi File użytkownikom, którzy należą do klasy użytkowników, którzy ogólny dostęp – na przykład jeśli domena File jest udostępniona całej domenie domeny 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 też usunięcie użytkownika z listy przeglądających.

Parametry

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

Powrót

FileFile do łańcuchów.

Autoryzacja

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 zasobu File. Ta metoda nie: zablokuj dostęp do usługi File użytkownikom, którzy należą do klasy użytkowników, którzy ogólny dostęp – na przykład jeśli domena File jest udostępniona całej domenie domeny 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 też usunięcie użytkownika z listy przeglądających.

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika do usunięcia.

Powrót

FileFile do łańcuchów.

Autoryzacja

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 dane użytkownika z listy przeglądających i komentujących File. Ten nie ma zastosowania, jeśli użytkownik jest edytującym, a nie przeglądającym lub komentującym. Ta metoda również Nie blokuje dostępu do elementu File użytkownikom, którzy należą do klasy użytkowników, mieć ogólny dostęp – na przykład jeśli domena File została udostępniona domenie całej domeny 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 też usunięcie użytkownika z listy redaktorów.

Parametry

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

Powrót

FileFile do tworzenia łańcuchów.

Autoryzacja

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 dane użytkownika z listy przeglądających i komentujących File. Ten nie ma zastosowania, jeśli użytkownik jest edytorem, a nie przeglądającym. Ta metoda nie blokuje też dostępu do funkcji File przez użytkowników, jeśli należą do klasy użytkowników, którzy mają ogólne warunki dostępu – na przykład jeśli element File został 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 też usunięcie użytkownika z listy redaktorów.

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika do usunięcia.

Powrót

FileFile do tworzenia łańcuchów.

Autoryzacja

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

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

revokePermissions(emailAddress)

Odbierze uprawnienia File przyznane danemu użytkownikowi. Ta metoda nie: zablokuj dostęp do usługi File użytkownikom, którzy należą do klasy użytkowników, mieć ogólny dostęp – jeśli na przykład element File został udostępniony domenie całą domenę.

Parametry

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

Powrót

FileFile do łańcuchów.

Autoryzacja

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

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

revokePermissions(user)

Odbierze uprawnienia File przyznane danemu użytkownikowi. Ta metoda nie: zablokuj dostęp do usługi File użytkownikom, którzy należą do klasy użytkowników, mieć ogólny dostęp – jeśli na przykład element File został udostępniony domenie całą domenę.

Parametry

NazwaTypOpis
userUserReprezentacja użytkownika, któremu chcesz odebrać dostęp.

Powrót

FileFile do łańcuchów.

Autoryzacja

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

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

setContent(content)

Powoduje zastąpienie zawartości pliku danym zamiennikiem. Zgłasza wyjątek, jeśli plik content jest większy niż 10 MB.

// Creates a text file with the content 'Hello, world!'
file = DriveApp.createFile('New Text File', 'Hello, world!');

// Logs the content of the text file to the console.
console.log(file.getBlob().getDataAsString());

// Updates the content of the text file to 'Updated text!'
file.setContent('Updated text!')

// Logs content of the text file to the console.
console.log(file.getBlob().getDataAsString());

Parametry

NazwaTypOpis
contentStringNowa zawartość pliku.

Powrót

FileFile do łańcuchów.

Autoryzacja

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

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

setDescription(description)

Ustawia opis elementu File.

Parametry

NazwaTypOpis
descriptionStringnowy opis dla: File

Powrót

FileFile, łańcuch

Autoryzacja

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

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

setName(name)

Określa nazwę elementu File.

Parametry

NazwaTypOpis
nameStringNowa nazwa usługi File

Powrót

File – to File, do łańcuchów

Autoryzacja

Skrypty korzystające 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 przypisuje również poprzedniemu właścicielowi użytkowników z uprawnieniami do edycji elementu File.

Parametry

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

Powrót

File – to File, do łańcuchów

Autoryzacja

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: File. Ta metoda przypisuje również poprzedniemu właścicielowi użytkowników z uprawnieniami do edycji elementu File.

Parametry

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

Powrót

File – to File, do łańcuchów

Autoryzacja

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, aby uzyskać dostęp, gdy jest udostępnione 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łączyć wymaganie dotyczące klucza zasobu w File.

Powrót

FileFile do łańcuchów.

Autoryzacja

Skrypty korzystające 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 elemencie File mogą udostępniać treści innym użytkownikom lub zmienić uprawnienia. Ustawienie domyślne nowego modelu File to true

Parametry

NazwaTypOpis
shareableBooleantrue, jeśli użytkownicy z uprawnieniami do edycji powinni mieć możliwość udostępniania treści tym osobom: innym użytkownikom ani zmieniać uprawnień; false, jeśli nie

Powrót

File – to File, do łańcuchów

Autoryzacja

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óre klasy użytkowników mają dostęp do elementu File i jakie uprawnienia użytkownicy, którym przyznano 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.)
var folder = DriveApp.createFolder('Shared Folder');
folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);

Parametry

NazwaTypOpis
accessTypeAccessgrupy użytkowników, którzy powinni mieć dostęp do File
permissionTypePermissionuprawnienia użytkowników mających dostęp do File

Powrót

FileFile, łańcuch

Autoryzacja

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 element File jest oznaczony gwiazdką na Dysku użytkownika. Domyślna wartość dla nowe Filefalse.

Parametry

NazwaTypOpis
starredBooleantrue, jeśli element File powinien być oznaczony gwiazdką w sekcji Dysk; false, jeśli nie

Powrót

FileFile, łańcuch

Autoryzacja

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 File znajduje się w koszu Dysku użytkownika. Tylko właściciel może przenieść do kosza File. Wartość domyślna nowych elementów File to false.

Parametry

NazwaTypOpis
trashedBooleantrue, jeśli element File ma zostać przeniesiony do kosza Dysk użytkownika; false, jeśli nie

Powrót

FileFile, łańcuch

Autoryzacja

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

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