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)

تنشئ عمودًا مَحسوبًا. لا تتوفّر هذه الطريقة إلا لمصادر بيانات 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