Class DataSource

تنظيم صفحاتك في مجموعات يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
مصدر البيانات

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

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

الطُرق

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

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

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