Class DataSource

مصدر البيانات

الوصول إلى مصدر البيانات الحالي وتعديله لإنشاء جدول مصدر بيانات باستخدام مصدر بيانات جديد، اطّلِع على DataSourceTable.

لا تستخدِم هذه الفئة إلا مع البيانات المرتبطة بقاعدة بيانات.

الطُرق

الطريقةنوع القيمة التي يتم عرضهاوصف قصير
cancelAllLinkedDataSourceObjectRefreshes()voidتلغي هذه الخطوة جميع عمليات إعادة التحميل الجارية حاليًا لعناصر مصدر البيانات المرتبطة بمصدر البيانات هذا.
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تنتظر هذه الدالة حتى تكتمل جميع عمليات التنفيذ الحالية لعناصر مصادر البيانات المرتبطة، وتنتهي مهلة الانتظار بعد العدد المقدَّم من الثواني.

مستندات تفصيلية

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.

المعلمات

الاسمالنوعالوصف
nameStringاسم العمود المحسوب
formulaStringصيغة العمود المحسوب

الإرجاع

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)

تعرِض هذه الدالة العمود المحسوب في مصدر البيانات الذي يتطابق مع اسم العمود.

المعلمات

الاسمالنوعالوصف
columnNameStringاسم العمود المحسوب المطلوب الحصول عليه.

الإرجاع

DataSourceColumn: العمود المحسوب الذي يتطابق مع اسم العمود، أو 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() لتفعيل تنفيذ البيانات لنوع مصدر بيانات معيّن.

يُلقي استثناءً إذا كان نوع مواصفات مصدر البيانات مختلفًا عن نوع مصدر البيانات الحالي.

المعلمات

الاسمالنوعالوصف
specDataSourceSpecمواصفات مصدر البيانات المطلوب تعديلها

الإرجاع

DataSource: مصدر البيانات

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:

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

updateSpec(spec, refreshAllLinkedObjects)

تعديل مواصفات مصدر البيانات وإعادة تحميل data source sheets المرتبط بالمواصفات الجديدة

يُعرِض استثناءً إذا لم يكن نوع مصدر البيانات مفعّلاً. استخدِم طرق SpreadsheetApp#enable...Execution() لتفعيل تنفيذ البيانات لنوع مصدر بيانات معيّن.

يُلقي استثناءً إذا كان نوع مواصفات مصدر البيانات مختلفًا عن نوع مصدر البيانات الحالي.

المعلمات

الاسمالنوعالوصف
specDataSourceSpecمواصفات مصدر البيانات المطلوب تعديلها
refreshAllLinkedObjectsBooleanإذا كانت true، تتم أيضًا إعادة تحميل جميع عناصر مصدر البيانات المرتبطة بمصدر البيانات هذا.

الإرجاع

DataSource: مصدر البيانات

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:

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

waitForAllDataExecutionsCompletion(timeoutInSeconds)

تنتظر هذه الدالة حتى تكتمل جميع عمليات التنفيذ الحالية لعناصر مصادر البيانات المرتبطة، وتنتهي مهلة الانتظار بعد العدد المقدَّم من الثواني. يُلقي استثناءً إذا لم تكتمل عمليات التنفيذ عند انتهاء المهلة، ولكنّه لا يلغي عمليات تنفيذ البيانات.

المعلمات

الاسمالنوعالوصف
timeoutInSecondsIntegerوقت الانتظار لتنفيذ البيانات، بالثواني ويبلغ الحد الأقصى 300 ثانية.

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:

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