Class DataSource

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)

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

المَعلمات

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

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

المَعلمات

الاسمTypeالوصف
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() لتفعيل تنفيذ البيانات لنوع مصدر بيانات معيّن.

المَعلمات

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

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

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

التفويض

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

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

updateSpec(spec, refreshAllLinkedObjects)

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

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

المَعلمات

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

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

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

التفويض

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

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

waitForAllDataExecutionsCompletion(timeoutInSeconds)

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

المَعلمات

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

التفويض

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

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