Class DataSource

منبع اطلاعات

به منبع داده موجود دسترسی داشته باشید و آن را اصلاح کنید. برای ایجاد جدول منبع داده با منبع داده جدید، به DataSourceTable مراجعه کنید.

از این کلاس فقط با داده هایی استفاده کنید که به پایگاه داده متصل هستند.

مواد و روش ها

روش نوع برگشت توضیح مختصر
createCalculatedColumn(name, formula) DataSourceColumn یک ستون محاسبه شده ایجاد می کند.
createDataSourcePivotTableOnNewSheet() DataSourcePivotTable یک جدول محوری منبع داده را از این منبع داده در سلول اول یک صفحه جدید ایجاد می کند.
createDataSourceTableOnNewSheet() DataSourceTable یک جدول منبع داده را از این منبع داده در سلول اول یک صفحه جدید ایجاد می کند.
getCalculatedColumnByName(columnName) DataSourceColumn ستون محاسبه شده را در منبع داده که با نام ستون مطابقت دارد برمی‌گرداند.
getCalculatedColumns() DataSourceColumn[] تمام ستون های محاسبه شده در منبع داده را برمی گرداند.
getColumns() DataSourceColumn[] تمام ستون های منبع داده را برمی گرداند.
getDataSourceSheets() DataSourceSheet[] برگه های منبع داده مرتبط با این منبع داده را برمی گرداند.
getSpec() DataSourceSpec مشخصات منبع داده را دریافت می کند.
refreshAllLinkedDataSourceObjects() void همه اشیاء منبع داده مرتبط با منبع داده را تازه می کند.
updateSpec(spec) DataSource مشخصات منبع داده را به روز می کند و اشیاء منبع داده مرتبط با این منبع داده را با مشخصات جدید تازه می کند.
updateSpec(spec, refreshAllLinkedObjects) DataSource مشخصات منبع داده را به روز می کند و data source sheets مرتبط را با مشخصات جدید تازه می کند.
waitForAllDataExecutionsCompletion(timeoutInSeconds) void صبر می کند تا تمام اجرای فعلی اشیاء منبع داده پیوند شده کامل شود و پس از تعداد ثانیه های ارائه شده به پایان می رسد.

مستندات دقیق

createCalculatedColumn(name, formula)

یک ستون محاسبه شده ایجاد می کند.

مولفه های

نام تایپ کنید شرح
name String نام ستون محاسبه شده
formula String فرمول ستون محاسبه شده

برگشت

DataSourceColumn - ستون محاسبه شده جدید ایجاد شده است.

مجوز

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

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

createDataSourcePivotTableOnNewSheet()

یک جدول محوری منبع داده را از این منبع داده در سلول اول یک صفحه جدید ایجاد می کند. به عنوان یک عارضه جانبی، برگه جدید را به برگه فعال تبدیل می کند.

برگشت

DataSourcePivotTable - جدول محوری منبع داده جدید ایجاد شده.

مجوز

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

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

createDataSourceTableOnNewSheet()

یک جدول منبع داده را از این منبع داده در سلول اول یک صفحه جدید ایجاد می کند. به عنوان یک عارضه جانبی، برگه جدید را به برگه فعال تبدیل می کند.

برگشت

DataSourceTable - جدول منبع داده جدید ایجاد شده.

مجوز

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

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getCalculatedColumnByName(columnName)

ستون محاسبه شده را در منبع داده که با نام ستون مطابقت دارد برمی‌گرداند.

مولفه های

نام تایپ کنید شرح
columnName String نام ستون محاسبه شده برای دریافت.

برگشت

DataSourceColumn - ستون محاسبه شده که با نام ستون مطابقت دارد، یا اگر ستون محاسبه شده وجود نداشته باشد، null است.

مجوز

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

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getCalculatedColumns()

تمام ستون های محاسبه شده در منبع داده را برمی گرداند.

برگشت

DataSourceColumn[] - آرایه ای از تمام ستون های محاسبه شده در منبع داده.

مجوز

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

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getColumns()

تمام ستون های منبع داده را برمی گرداند.

برگشت

DataSourceColumn[] - آرایه ای از تمام DataSourceColumn در منبع داده.

مجوز

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

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getDataSourceSheets()

برگه های منبع داده مرتبط با این منبع داده را برمی گرداند.

برگشت

DataSourceSheet[] - آرایه ای از برگه های منبع داده.

مجوز

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

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getSpec()

مشخصات منبع داده را دریافت می کند.

برگشت

DataSourceSpec - مشخصات منبع داده.

مجوز

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

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

refreshAllLinkedDataSourceObjects()

همه اشیاء منبع داده مرتبط با منبع داده را تازه می کند.

در صورتی که نوع منبع داده فعال نباشد، یک استثنا ایجاد می کند. از متدهای SpreadsheetApp#enable...Execution() برای فعال کردن اجرای داده برای نوع منبع داده خاص استفاده کنید.

مجوز

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

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

updateSpec(spec)

مشخصات منبع داده را به روز می کند و اشیاء منبع داده مرتبط با این منبع داده را با مشخصات جدید تازه می کند.

در صورتی که نوع منبع داده فعال نباشد، یک استثنا ایجاد می کند. از متدهای SpreadsheetApp#enable...Execution() برای فعال کردن اجرای داده برای نوع منبع داده خاص استفاده کنید.

مولفه های

نام تایپ کنید شرح
spec DataSourceSpec مشخصات منبع داده برای به روز رسانی با.

برگشت

DataSource - منبع داده.

مجوز

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

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

updateSpec(spec, refreshAllLinkedObjects)

مشخصات منبع داده را به روز می کند و data source sheets مرتبط را با مشخصات جدید تازه می کند.

در صورتی که نوع منبع داده فعال نباشد، یک استثنا ایجاد می کند. از متدهای SpreadsheetApp#enable...Execution() برای فعال کردن اجرای داده برای نوع منبع داده خاص استفاده کنید.

مولفه های

نام تایپ کنید شرح
spec DataSourceSpec مشخصات منبع داده برای به روز رسانی با.
refreshAllLinkedObjects Boolean اگر true ، تمام اشیاء منبع داده مرتبط با این منبع داده را نیز بازخوانی می کند.

برگشت

DataSource - منبع داده.

مجوز

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

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

waitForAllDataExecutionsCompletion(timeoutInSeconds)

صبر می کند تا تمام اجرای فعلی اشیاء منبع داده پیوند شده کامل شود و پس از تعداد ثانیه های ارائه شده به پایان می رسد. در صورتی که اجراها در زمان اتمام کامل نشده باشند، استثنا می‌کند، اما اجرای داده‌ها را لغو نمی‌کند.

مولفه های

نام تایپ کنید شرح
timeoutInSeconds Integer زمان انتظار برای اجرای داده ها، در چند ثانیه. حداکثر 300 ثانیه است.

مجوز

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

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets