Class DataSource

منبع داده

دسترسی و تغییر منبع داده موجود. برای ایجاد جدول منبع داده با منبع داده جدید، به DataSourceTable مراجعه کنید.

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

روش‌ها

روش نوع بازگشتی شرح مختصر
cancel All Linked Data Source Object Refreshes() void تمام به‌روزرسانی‌های در حال اجرای فعلی اشیاء منبع داده‌ی لینک‌شده به این منبع داده را لغو می‌کند.
create Calculated Column(name, formula) Data Source Column یک ستون محاسباتی ایجاد می‌کند.
create Data Source Pivot Table On New Sheet() Data Source Pivot Table یک جدول محوری منبع داده از این منبع داده در اولین سلول یک برگه جدید ایجاد می‌کند.
create Data Source Table On New Sheet() Data Source Table یک جدول منبع داده از این منبع داده در اولین سلول یک برگه جدید ایجاد می‌کند.
get Calculated Column By Name(columnName) Data Source Column |null ستون محاسبه‌شده در منبع داده که با نام ستون مطابقت دارد را برمی‌گرداند.
get Calculated Columns() Data Source Column[] تمام ستون‌های محاسبه‌شده در منبع داده را برمی‌گرداند.
get Columns() Data Source Column[] تمام ستون‌های موجود در منبع داده را برمی‌گرداند.
get Data Source Sheets() Data Source Sheet[] برگه‌های منبع داده مرتبط با این منبع داده را برمی‌گرداند.
get Spec() Data Source Spec مشخصات منبع داده را دریافت می‌کند.
refresh All Linked Data Source Objects() void تمام اشیاء منبع داده مرتبط با منبع داده را به‌روزرسانی می‌کند.
update Spec(spec) Data Source مشخصات منبع داده را به‌روزرسانی می‌کند و اشیاء منبع داده مرتبط با این منبع داده را با مشخصات جدید به‌روزرسانی می‌کند.
update Spec(spec, refreshAllLinkedObjects) Data Source مشخصات منبع داده را به‌روزرسانی می‌کند و data source sheets پیوند داده شده را با مشخصات جدید به‌روزرسانی می‌کند.
wait For All Data Executions Completion(timeoutInSeconds) void منتظر می‌ماند تا تمام اجراهای فعلی اشیاء منبع داده‌ی پیوند شده کامل شوند و پس از تعداد ثانیه‌های ارائه شده، زمان‌بندی خاتمه می‌یابد.

مستندات دقیق

cancelAllLinkedDataSourceObjectRefreshes()

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

این مثال نحوه لغو تمام به‌روزرسانی‌های یک منبع داده را نشان می‌دهد.

SpreadsheetApp.enableBigQueryExecution();
const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
const dataSource = spreadsheet.getDataSources()[0];
dataSource.cancelAllLinkedDataSourceObjectRefreshes();

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

مجوز

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

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

createCalculatedColumn(name, formula)

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

پارامترها

نام نوع توضیحات
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()

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

این روش فقط برای منابع داده BigQuery در دسترس است.

بازگشت

DataSourceTable — جدول منبع داده تازه ایجاد شده.

مجوز

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

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

getCalculatedColumnByName(columnName)

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

پارامترها

نام نوع توضیحات
column Name String نام ستون محاسبه‌شده‌ای که قرار است دریافت شود.

بازگشت

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

مجوز

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

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

getCalculatedColumns()

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

مشخصات منبع داده از نوع DataSourceType.LOOKER یک آرایه خالی برمی‌گرداند.

بازگشت

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 Data Source Spec مشخصات منبع داده‌ای که قرار است به‌روزرسانی شود.

بازگشت

DataSource - منبع داده.

مجوز

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

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

updateSpec(spec, refreshAllLinkedObjects)

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

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

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

پارامترها

نام نوع توضیحات
spec Data Source Spec مشخصات منبع داده‌ای که قرار است به‌روزرسانی شود.
refresh All Linked Objects Boolean اگر true ، تمام اشیاء منبع داده مرتبط با این منبع داده را نیز به‌روزرسانی می‌کند.

بازگشت

DataSource - منبع داده.

مجوز

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

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

waitForAllDataExecutionsCompletion(timeoutInSeconds)

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

پارامترها

نام نوع توضیحات
timeout In Seconds Integer زمان انتظار برای اجرای داده‌ها، بر حسب ثانیه. حداکثر ۳۰۰ ثانیه است.

مجوز

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

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