Class DataSource

DataSource

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

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

الطُرق

الطريقةنوع القيمة التي تم إرجاعهاوصف قصير
cancelAllLinkedDataSourceObjectRefreshes()voidيلغي هذا الإجراء جميع عمليات إعادة التحميل الجارية حاليًا لعناصر مصدر البيانات المرتبطة بمصدر البيانات هذا.
createCalculatedColumn(name, formula)DataSourceColumnتنشئ هذه الدالة عمودًا مَحسوبًا.
createDataSourcePivotTableOnNewSheet()DataSourcePivotTableتُنشئ هذه الدالة جدولاً محوريًا لمصدر البيانات من مصدر البيانات هذا في الخلية الأولى من ورقة جديدة.
createDataSourceTableOnNewSheet()DataSourceTableتُنشئ هذه الدالة جدول مصدر بيانات من مصدر البيانات هذا في الخلية الأولى من ورقة جديدة.
getCalculatedColumnByName(columnName)DataSourceColumn|nullتعرض هذه الدالة العمود المحسوب في مصدر البيانات الذي يتطابق مع اسم العمود.
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: العمود المحسوب الذي يتطابق مع اسم العمود، أو 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