Class DataSource

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 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)

تُنشئ عمودًا محسوبًا.

المَعلمات

الاسمالنوعالوصف
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()

لإنشاء جدول مصدر بيانات من مصدر البيانات هذا في الخلية الأولى من ورقة بيانات جديدة. كتأثير جانبي، يجعل الورقة الجديدة الورقة النشطة.

استرجاع الكرة

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()

تعرض جميع الأعمدة المحسوبة في مصدر البيانات.

استرجاع الكرة

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