Class DataSource

منبع داده

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

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

روش ها

روش نوع برگشت شرح مختصر
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 ستون محاسبه شده را در منبع داده که با نام ستون مطابقت دارد برمی‌گرداند.
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 صبر می کند تا تمام اجرای فعلی اشیاء منبع داده پیوند شده کامل شود و پس از تعداد ثانیه های ارائه شده به پایان می رسد.

مستندات دقیق

cancel All Linked Data Source Object Refreshes()

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

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

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

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

مجوز

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

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

create Calculated Column(name, formula)

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

پارامترها

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

بازگشت

Data Source Column - ستون محاسبه شده تازه ایجاد شده.

مجوز

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

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

create Data Source Pivot Table On New Sheet()

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

بازگشت

Data Source Pivot Table - جدول محوری منبع داده جدید ایجاد شده است.

مجوز

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

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

create Data Source Table On New Sheet()

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

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

بازگشت

Data Source Table - جدول منبع داده جدید ایجاد شده.

مجوز

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

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

get Calculated Column By Name(columnName)

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

پارامترها

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

بازگشت

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

مجوز

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

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

get Calculated Columns()

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

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

بازگشت

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

مجوز

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

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

get Columns()

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

بازگشت

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

مجوز

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

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

get Data Source Sheets()

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

بازگشت

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

مجوز

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

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

get Spec()

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

بازگشت

Data Source Spec - مشخصات منبع داده.

مجوز

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

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

refresh All Linked Data Source Objects()

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

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

مجوز

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

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

update Spec(spec)

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

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

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

پارامترها

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

بازگشت

Data Source - منبع داده.

مجوز

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

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

update Spec(spec, refreshAllLinkedObjects)

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

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

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

پارامترها

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

بازگشت

Data Source - منبع داده.

مجوز

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

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

wait For All Data Executions Completion(timeoutInSeconds)

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

پارامترها

نام تایپ کنید توضیحات
timeout In Seconds Integer زمان انتظار برای اجرای داده ها، در چند ثانیه. حداکثر 300 ثانیه است.

مجوز

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

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