Class DriveApp

درایو اپ

به اسکریپت‌ها اجازه می‌دهد فایل‌ها و پوشه‌ها را در گوگل درایو ایجاد، پیدا و تغییر دهند. اگرچه سرویس درایو داخلی آسان‌تر است، اما محدودیت‌هایی دارد. برای جدیدترین ویژگی‌ها و پشتیبانی و دسترسی به فایل‌ها یا پوشه‌ها در درایوهای مشترک، از سرویس پیشرفته درایو استفاده کنید.

// Logs the name of every file in the user's Drive.
const files = DriveApp.getFiles();
while (files.hasNext()) {
  const file = files.next();
  console.log(file.getName());
}

خواص

ملک نوع توضیحات
Access Access یک enum که نشان‌دهنده‌ی کلاس‌هایی از کاربران است که می‌توانند به یک فایل یا پوشه دسترسی داشته باشند، علاوه بر هر کاربر شخصی که صراحتاً به او دسترسی داده شده است.
Permission Permission یک enum که نشان‌دهنده مجوزهای اعطا شده به کاربرانی است که می‌توانند به یک فایل یا پوشه دسترسی داشته باشند، علاوه بر هر کاربر شخصی که صراحتاً به او دسترسی داده شده است.

روش‌ها

روش نوع بازگشتی شرح مختصر
continue File Iterator(continuationToken) File Iterator تکرار یک فایل را با استفاده از یک توکن ادامه از تکرارکننده قبلی از سر می‌گیرد.
continue Folder Iterator(continuationToken) Folder Iterator تکرار یک پوشه را با استفاده از یک توکن ادامه از تکرارکننده قبلی از سر می‌گیرد.
create File(blob) File یک فایل در ریشه درایو کاربر از یک Blob داده دلخواه ایجاد می‌کند.
create File(name, content) File یک فایل متنی در ریشه درایو کاربر با نام و محتوای داده شده ایجاد می‌کند.
create File(name, content, mimeType) File یک فایل در ریشه درایو کاربر با نام، محتویات و نوع MIME داده شده ایجاد می‌کند.
create Folder(name) Folder پوشه‌ای با نام داده شده در ریشه درایو کاربر ایجاد می‌کند.
create Shortcut(targetId) File یک میانبر برای شناسه‌ی آیتم درایو ارائه شده ایجاد می‌کند و آن را برمی‌گرداند.
create Shortcut For Target Id And Resource Key(targetId, targetResourceKey) File یک میانبر برای شناسه آیتم درایو و کلید منبع ارائه شده ایجاد می‌کند و آن را برمی‌گرداند.
enforce Single Parent(value) void رفتار implementSingleParent را برای همه فراخوانی‌های مؤثر بر والدهای آیتم فعال یا غیرفعال می‌کند.
get File By Id(id) File فایلی را با شناسه (ID) داده شده دریافت می‌کند.
get File By Id And Resource Key(id, resourceKey) File فایل را با شناسه و کلید منبع داده شده دریافت می‌کند.
get Files() File Iterator مجموعه‌ای از تمام فایل‌های موجود در درایو کاربر را دریافت می‌کند.
get Files By Name(name) File Iterator مجموعه‌ای از تمام فایل‌های موجود در درایو کاربر که نام داده شده را دارند، دریافت می‌کند.
get Files By Type(mimeType) File Iterator مجموعه‌ای از تمام فایل‌های موجود در درایو کاربر که نوع MIME داده شده را دارند، دریافت می‌کند.
get Folder By Id(id) Folder پوشه‌ای با شناسه‌ی داده شده را دریافت می‌کند.
get Folder By Id And Resource Key(id, resourceKey) Folder پوشه‌ای را با شناسه و کلید منبع داده شده دریافت می‌کند.
get Folders() Folder Iterator مجموعه‌ای از تمام پوشه‌های موجود در درایو کاربر را دریافت می‌کند.
get Folders By Name(name) Folder Iterator مجموعه‌ای از تمام پوشه‌های موجود در درایو کاربر که نام داده شده را دارند، دریافت می‌کند.
get Root Folder() Folder پوشه‌ی موجود در ریشه‌ی درایو کاربر را دریافت می‌کند.
get Storage Limit() Integer تعداد بایت‌هایی که کاربر مجاز به ذخیره در Drive است را برمی‌گرداند.
get Storage Used() Integer تعداد بایت‌هایی که کاربر در حال حاضر در Drive ذخیره می‌کند را برمی‌گرداند.
get Trashed Files() File Iterator مجموعه‌ای از تمام فایل‌های موجود در سطل زباله‌ی درایو کاربر را دریافت می‌کند.
get Trashed Folders() Folder Iterator مجموعه‌ای از تمام پوشه‌های موجود در سطل زباله‌ی درایو کاربر را دریافت می‌کند.
search Files(params) File Iterator مجموعه‌ای از تمام فایل‌های موجود در درایو کاربر که با معیارهای جستجوی داده شده مطابقت دارند را دریافت می‌کند.
search Folders(params) Folder Iterator مجموعه‌ای از تمام پوشه‌های موجود در درایو کاربر که با معیارهای جستجوی داده شده مطابقت دارند را دریافت می‌کند.

مستندات دقیق

continueFileIterator(continuationToken)

تکرار یک فایل را با استفاده از یک توکن ادامه از یک تکرارکننده قبلی از سر می‌گیرد. این روش در صورتی مفید است که پردازش یک تکرارکننده در یک اجرا از حداکثر زمان اجرا فراتر رود. توکن‌های ادامه معمولاً به مدت یک هفته معتبر هستند.

// Continues getting a list of all 'Untitled document' files in the user's
// Drive. Creates a file iterator named 'previousIterator'.
const previousIterator = DriveApp.getFilesByName('Untitled document');

// Gets continuation token from the previous file iterator.
const continuationToken = previousIterator.getContinuationToken();

// Creates a new iterator using the continuation token from the previous file
// iterator.
const newIterator = DriveApp.continueFileIterator(continuationToken);

// Resumes the file iteration using a continuation token from 'firstIterator'
// and logs the file name.
if (newIterator.hasNext()) {
  const file = newIterator.next();
  console.log(file.getName());
}

پارامترها

نام نوع توضیحات
continuation Token String یک توکن ادامه از یک تکرارکننده فایل قبلی.

بازگشت

FileIterator - مجموعه‌ای از فایل‌هایی که هنگام تولید توکن ادامه، در یک تکرارکننده قبلی باقی مانده‌اند.

continueFolderIterator(continuationToken)

تکرار یک پوشه را با استفاده از یک توکن تداوم از یک تکرارکننده قبلی از سر می‌گیرد. این روش در صورتی مفید است که پردازش یک تکرارکننده در یک اجرا از حداکثر زمان اجرا فراتر رود. توکن‌های تداوم معمولاً به مدت یک هفته معتبر هستند.

// Continues getting a list of all folders in user's Drive.
// Creates a folder iterator named 'previousIterator'.
const previousIterator = DriveApp.getFolders();

// Gets continuation token from the previous folder iterator.
const continuationToken = previousIterator.getContinuationToken();

// Creates a new iterator using the continuation token from the previous folder
// iterator.
const newIterator = DriveApp.continueFolderIterator(continuationToken);

// Resumes the folder iteration using a continuation token from the previous
// iterator and logs the folder name.
if (newIterator.hasNext()) {
  const folder = newIterator.next();
  console.log(folder.getName());
}

پارامترها

نام نوع توضیحات
continuation Token String یک توکن ادامه از یک تکرارکننده پوشه قبلی.

بازگشت

FolderIterator - مجموعه‌ای از پوشه‌هایی که هنگام تولید توکن ادامه، در یک تکرارکننده قبلی باقی مانده‌اند.

createFile(blob)

یک فایل در ریشه درایو کاربر از یک Blob داده دلخواه ایجاد می‌کند.

پارامترها

نام نوع توضیحات
blob Blob Source داده‌های مربوط به فایل جدید.

بازگشت

File — فایل جدید.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

createFile(name, content)

یک فایل متنی در ریشه درایو کاربر با نام و محتوای داده شده ایجاد می‌کند. اگر content بزرگتر از ۵۰ مگابایت باشد، استثنا ایجاد می‌کند.

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

پارامترها

نام نوع توضیحات
name String نام فایل جدید.
content String محتوای فایل جدید.

بازگشت

File — فایل جدید.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

createFile(name, content, mimeType)

یک فایل در ریشه درایو کاربر با نام، محتوا و نوع MIME داده شده ایجاد می‌کند. اگر content بزرگتر از 10 مگابایت باشد، استثنا ایجاد می‌کند.

// Create an HTML file with the content "Hello, world!"
DriveApp.createFile('New HTML File', '<b>Hello, world!</b>', MimeType.HTML);

پارامترها

نام نوع توضیحات
name String نام فایل جدید.
content String محتوای فایل جدید.
mime Type String نوع MIME فایل جدید.

بازگشت

File — فایل جدید.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

createFolder(name)

پوشه‌ای با نام داده شده در ریشه درایو کاربر ایجاد می‌کند.

پارامترها

نام نوع توضیحات
name String نام پوشه جدید.

بازگشت

Folder — پوشه جدید.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

createShortcut(targetId)

یک میانبر برای شناسه‌ی آیتم درایو ارائه شده ایجاد می‌کند و آن را برمی‌گرداند.

پارامترها

نام نوع توضیحات
target Id String شناسه فایل یا پوشه هدف.

بازگشت

File — میانبر جدید.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)

یک میانبر برای شناسه آیتم درایو و کلید منبع ارائه شده ایجاد می‌کند و آن را برمی‌گرداند. کلید منبع یک پارامتر اضافی است که برای دسترسی به فایل یا پوشه هدف که با استفاده از یک لینک به اشتراک گذاشته شده است، باید ارسال شود.

// Creates shortcuts for all folders in the user's drive that have a specific
// name.
// TODO(developer): Replace 'Test-Folder' with a valid folder name in your
// drive.
const folders = DriveApp.getFoldersByName('Test-Folder');

// Iterates through all folders named 'Test-Folder'.
while (folders.hasNext()) {
  const folder = folders.next();

  // Creates a shortcut to the provided Drive item ID and resource key, and
  // returns it.
  DriveApp.createShortcutForTargetIdAndResourceKey(
      folder.getId(),
      folder.getResourceKey(),
  );
}

پارامترها

نام نوع توضیحات
target Id String شناسه فایل یا پوشه هدف.
target Resource Key String کلید منبع فایل یا پوشه‌ی هدف.

بازگشت

File — میانبر جدید.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

enforceSingleParent(value)

رفتار implementSingleParent را برای همه فراخوانی‌های مؤثر بر والدهای آیتم فعال یا غیرفعال می‌کند.

برای جزئیات بیشتر به وبلاگ « ساده‌سازی ساختار پوشه‌ها و مدل‌های اشتراک‌گذاری گوگل درایو» مراجعه کنید.

// Enables enforceSingleParent behavior for all calls affecting item parents.
DriveApp.enforceSingleParent(true);

پارامترها

نام نوع توضیحات
value Boolean وضعیت جدید پرچم enforcementSingleParent.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

getFileById(id)

فایل را با شناسه‌ی داده شده دریافت می‌کند. اگر فایل وجود نداشته باشد یا کاربر اجازه‌ی دسترسی به آن را نداشته باشد، یک خطای اسکریپتی صادر می‌کند.

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

if (files.hasNext()) {
  // Gets the ID of each file in the list.
  const fileId = files.next().getId();

  // Gets the file name using its ID and logs it to the console.
  console.log(DriveApp.getFileById(fileId).getName());
}

پارامترها

نام نوع توضیحات
id String شناسه فایل.

بازگشت

File — فایلی با شناسه‌ی داده شده.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

getFileByIdAndResourceKey(id, resourceKey)

فایلی را با شناسه و کلید منبع داده شده دریافت می‌کند. کلیدهای منبع یک پارامتر اضافی هستند که برای دسترسی به فایل‌هایی که با استفاده از یک لینک به اشتراک گذاشته شده‌اند، باید ارسال شوند.

اگر فایل وجود نداشته باشد یا کاربر اجازه دسترسی به آن را نداشته باشد، یک خطای اسکریپتی ایجاد می‌کند.

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

  // Gets the ID and resource key.
  const key = file.getResourceKey();
  const id = file.getId();

  // Logs the file name to the console using its ID and resource key.
  console.log(DriveApp.getFileByIdAndResourceKey(id, key).getName());
}

پارامترها

نام نوع توضیحات
id String شناسه فایل.
resource Key String کلید منبع پوشه.

بازگشت

File — فایلی با شناسه‌ی داده شده.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

getFiles()

مجموعه‌ای از تمام فایل‌های موجود در درایو کاربر را دریافت می‌کند.

بازگشت

FileIterator — مجموعه‌ای از تمام فایل‌های موجود در درایو کاربر.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

getFilesByName(name)

مجموعه‌ای از تمام فایل‌های موجود در درایو کاربر که نام داده شده را دارند، دریافت می‌کند.

پارامترها

نام نوع توضیحات
name String نام فایل‌هایی که باید پیدا شوند.

بازگشت

FileIterator — مجموعه‌ای از تمام فایل‌های موجود در درایو کاربر که نام داده شده را دارند.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

getFilesByType(mimeType)

مجموعه‌ای از تمام فایل‌های موجود در درایو کاربر که نوع MIME داده شده را دارند، دریافت می‌کند.

پارامترها

نام نوع توضیحات
mime Type String نوع MIME فایل‌هایی که باید پیدا شوند.

بازگشت

FileIterator — مجموعه‌ای از تمام فایل‌های موجود در درایو کاربر که نوع MIME داده شده را دارند.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

getFolderById(id)

پوشه‌ای با شناسه‌ی داده شده را دریافت می‌کند. اگر پوشه وجود نداشته باشد یا کاربر اجازه‌ی دسترسی به آن را نداشته باشد، یک خطای اسکریپتی صادر می‌کند.

پارامترها

نام نوع توضیحات
id String شناسه پوشه.

بازگشت

Folder — پوشه‌ای با شناسه‌ی داده شده.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

getFolderByIdAndResourceKey(id, resourceKey)

پوشه‌ای با شناسه و کلید منبع داده شده را دریافت می‌کند. کلیدهای منبع یک پارامتر اضافی هستند که برای دسترسی به پوشه‌هایی که با استفاده از یک لینک به اشتراک گذاشته شده‌اند، باید ارسال شوند.

اگر پوشه وجود نداشته باشد یا کاربر اجازه دسترسی به آن را نداشته باشد، یک خطای اسکریپتی ایجاد می‌کند.

پارامترها

نام نوع توضیحات
id String شناسه پوشه.
resource Key String کلید منبع پوشه.

بازگشت

Folder — پوشه‌ای با شناسه‌ی داده شده.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

getFolders()

مجموعه‌ای از تمام پوشه‌های موجود در درایو کاربر را دریافت می‌کند.

بازگشت

FolderIterator — مجموعه‌ای از تمام پوشه‌های موجود در درایو کاربر.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

getFoldersByName(name)

مجموعه‌ای از تمام پوشه‌های موجود در درایو کاربر که نام داده شده را دارند، دریافت می‌کند.

پارامترها

نام نوع توضیحات
name String نام پوشه‌هایی که باید پیدا شوند.

بازگشت

FolderIterator — مجموعه‌ای از تمام پوشه‌های موجود در درایو کاربر که نام داده شده را دارند.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

getRootFolder()

پوشه‌ی موجود در ریشه‌ی درایو کاربر را دریافت می‌کند. 

// Gets the user's My Drive folder and logs its name to the console.
console.log(DriveApp.getRootFolder().getName());

// Logs the Drive owner's name to the console.
console.log(DriveApp.getRootFolder().getOwner().getName());

بازگشت

Folder — پوشه ریشه درایو کاربر.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

getStorageLimit()

تعداد بایت‌هایی که کاربر مجاز به ذخیره در Drive است را برمی‌گرداند. 

// Gets the number of bytes the user can store in Drive and logs it to the
// console.
console.log(DriveApp.getStorageLimit());

بازگشت

Integer - تعداد بایت‌هایی که کاربر مجاز به ذخیره آنها در درایو است.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

getStorageUsed()

تعداد بایت‌هایی که کاربر در حال حاضر در Drive ذخیره می‌کند را برمی‌گرداند. 

// Gets the number of bytes the user is currently storing in Drive and logs it
// to the console.
console.log(DriveApp.getStorageUsed());

بازگشت

Integer - تعداد بایت‌هایی که کاربر در حال حاضر در درایو ذخیره می‌کند.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

getTrashedFiles()

مجموعه‌ای از تمام فایل‌های موجود در سطل زباله‌ی درایو کاربر را دریافت می‌کند. 

// Gets a list of all the files in the trash of the user's Drive.
const trashFiles = DriveApp.getTrashedFiles();

// Logs the trash file names to the console.
while (trashFiles.hasNext()) {
  const file = trashFiles.next();
  console.log(file.getName());
}

بازگشت

FileIterator — مجموعه‌ای از فایل‌ها در سطل زباله.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

getTrashedFolders()

مجموعه‌ای از تمام پوشه‌های موجود در سطل زباله‌ی درایو کاربر را دریافت می‌کند. 

// Gets a collection of all the folders in the trash of the user's Drive.
const trashFolders = DriveApp.getTrashedFolders();

// Logs the trash folder names to the console.
while (trashFolders.hasNext()) {
  const folder = trashFolders.next();
  console.log(folder.getName());
}

بازگشت

FolderIterator — مجموعه‌ای از پوشه‌ها در سطل زباله.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

searchFiles(params)

مجموعه‌ای از تمام فایل‌های موجود در درایو کاربر که با معیارهای جستجوی داده شده مطابقت دارند را دریافت می‌کند. معیارهای جستجو در مستندات SDK گوگل درایو به تفصیل شرح داده شده است. توجه داشته باشید که سرویس درایو از نسخه ۲ رابط برنامه‌نویسی کاربردی درایو استفاده می‌کند و برخی از فیلدهای پرس‌وجو با نسخه ۳ متفاوت هستند. تفاوت‌های فیلدها بین نسخه ۲ و ۳ را بررسی کنید.

آرگومان params یک رشته پرس‌وجو است که می‌تواند شامل مقادیر رشته‌ای باشد، بنابراین مراقب باشید که علامت‌های نقل قول را به درستی قرار دهید (برای مثال "title contains 'Gulliver\\'s Travels'" یا 'title contains "Gulliver\'s Travels"' ). 

// Logs the name of every file in the user's Drive that modified after February 28,
// 2022 whose name contains "untitled.""
const files = DriveApp.searchFiles(
    'modifiedDate > "2022-02-28" and title contains "untitled"');
while (files.hasNext()) {
  const file = files.next();
  console.log(file.getName());
}

پارامترها

نام نوع توضیحات
params String معیارهای جستجو، همانطور که در مستندات SDK گوگل درایو به تفصیل آمده است.

بازگشت

FileIterator — مجموعه‌ای از تمام فایل‌های موجود در درایو کاربر که با معیارهای جستجو مطابقت دارند.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

searchFolders(params)

مجموعه‌ای از تمام پوشه‌های موجود در درایو کاربر که با معیارهای جستجوی داده شده مطابقت دارند را دریافت می‌کند. معیارهای جستجو در مستندات SDK گوگل درایو به تفصیل شرح داده شده است. توجه داشته باشید که سرویس درایو از نسخه ۲ رابط برنامه‌نویسی کاربردی درایو استفاده می‌کند و برخی از فیلدهای پرس‌وجو با نسخه ۳ متفاوت هستند. تفاوت‌های فیلدها بین نسخه ۲ و ۳ را بررسی کنید.

آرگومان params یک رشته پرس‌وجو است که می‌تواند شامل مقادیر رشته‌ای باشد، بنابراین مراقب باشید که علامت‌های نقل قول را به درستی قرار دهید (برای مثال "title contains 'Gulliver\\'s Travels'" یا 'title contains "Gulliver\'s Travels"' ). 

// Logs the name of every folder in the user's Drive that you own and is starred.
const folders = DriveApp.searchFolders('starred = true and "me" in owners');
while (folders.hasNext()) {
  const folder = folders.next();
  console.log(folder.getName());
}

پارامترها

نام نوع توضیحات
params String معیارهای جستجو، همانطور که در مستندات SDK گوگل درایو به تفصیل آمده است.

بازگشت

FolderIterator — مجموعه‌ای از تمام پوشه‌های موجود در درایو کاربر که با معیارهای جستجو مطابقت دارند.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

متدهای منسوخ شده