Class DataSourceSheet

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

الوصول إلى ورقة مصدر البيانات الحالية وتعديلها. لإنشاء ورقة بيانات مصدر بيانات جديدة، استخدِم Spreadsheet.insertDataSourceSheet(spec).

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

الطُرق

الطريقةنوع الإرجاعوصف قصير
addFilter(columnName, filterCriteria)DataSourceSheetإضافة فلتر تم تطبيقه على ورقة مصدر البيانات.
asSheet()Sheetتعرض ورقة مصدر البيانات ككائن ورقة عادي.
autoResizeColumn(columnName)DataSourceSheetتغيير الحجم التلقائي لعرض العمود المحدد.
autoResizeColumns(columnNames)DataSourceSheetتغيّر تلقائيًا عرض الأعمدة المحددة.
forceRefreshData()DataSourceSheetإعادة تحميل بيانات هذا العنصر بغض النظر عن الحالة الحالية.
getColumnWidth(columnName)Integerلعرض عرض العمود المحدّد.
getDataSource()DataSourceالحصول على مصدر البيانات المرتبط به العنصر.
getFilters()DataSourceSheetFilter[]عرض جميع الفلاتر المطبّقة على ورقة مصدر البيانات.
getSheetValues(columnName)Object[]عرض جميع قيم ورقة مصدر البيانات لاسم العمود المقدّم.
getSheetValues(columnName, startRow, numRows)Object[]تعرض جميع قيم ورقة مصدر البيانات لاسم العمود المقدّم من صف البدء المقدّم (استنادًا إلى 1) وما يصل إلى numRows المقدّمة.
getSortSpecs()SortSpec[]تحصل على جميع مواصفات الترتيب في ورقة مصدر البيانات.
getStatus()DataExecutionStatusتحصل على حالة تنفيذ البيانات للعنصر.
refreshData()DataSourceSheetلإعادة تحميل بيانات العنصر.
removeFilters(columnName)DataSourceSheetيزيل جميع الفلاتر المطبّقة على عمود ورقة مصدر البيانات.
removeSortSpec(columnName)DataSourceSheetيزيل مواصفات الترتيب في عمود في ورقة بيانات المصدر.
setColumnWidth(columnName, width)DataSourceSheetلضبط عرض العمود المحدد.
setColumnWidths(columnNames, width)DataSourceSheetلضبط عرض الأعمدة المحددة.
setSortSpec(columnName, ascending)DataSourceSheetلضبط مواصفات الترتيب في عمود في ورقة بيانات المصدر.
setSortSpec(columnName, sortOrder)DataSourceSheetلضبط مواصفات الترتيب في عمود في ورقة بيانات المصدر.
waitForCompletion(timeoutInSeconds)DataExecutionStatusالانتظار حتى اكتمال عملية التنفيذ الحالية، وستنتهي المهلة بعد عدد الثواني المقدَّم.

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

addFilter(columnName, filterCriteria)

إضافة فلتر تم تطبيقه على ورقة مصدر البيانات.

المَعلمات

الاسمالنوعالوصف
columnNameStringاسم العمود الذي تريد تطبيق هذا الفلتر عليه
filterCriteriaFilterCriteriaمعايير الفلتر المطلوب تطبيقها.

تذكرة ذهاب وعودة

DataSourceSheet - ورقة بيانات مصدر البيانات، لسلسلة الطرق.

التفويض

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

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

asSheet()

تعرض ورقة مصدر البيانات ككائن ورقة عادي.

تذكرة ذهاب وعودة

Sheet — ورقة البيانات العادية.

التفويض

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

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

autoResizeColumn(columnName)

تغيير الحجم التلقائي لعرض العمود المحدد.

المَعلمات

الاسمالنوعالوصف
columnNameStringاسم العمود

تذكرة ذهاب وعودة

DataSourceSheet - ورقة مصدر البيانات هذه، للسلسلة.

التفويض

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

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

autoResizeColumns(columnNames)

تغيّر تلقائيًا عرض الأعمدة المحددة.

المَعلمات

الاسمالنوعالوصف
columnNamesString[]قائمة أسماء الأعمدة المطلوب تعديلها

تذكرة ذهاب وعودة

DataSourceSheet - ورقة مصدر البيانات هذه، للسلسلة.

التفويض

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

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

forceRefreshData()

إعادة تحميل بيانات هذا العنصر بغض النظر عن الحالة الحالية. لمزيد من التفاصيل، يمكنك الاطّلاع على refreshData().

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

تذكرة ذهاب وعودة

DataSourceSheet — كائن البيانات.

التفويض

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

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

getColumnWidth(columnName)

لعرض عرض العمود المحدّد.

المَعلمات

الاسمالنوعالوصف
columnNameStringاسم العمود

تذكرة ذهاب وعودة

Integer — عرض العمود أو null، إذا كان العمود يستخدِم العرض التلقائي.

التفويض

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

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

getDataSource()

الحصول على مصدر البيانات المرتبط به العنصر.

تذكرة ذهاب وعودة

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

التفويض

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

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

getFilters()

عرض جميع الفلاتر المطبّقة على ورقة مصدر البيانات.

تذكرة ذهاب وعودة

DataSourceSheetFilter[]: مصفوفة من جميع الفلاتر المطبّقة على ورقة مصدر البيانات.

التفويض

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

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

getSheetValues(columnName)

عرض جميع قيم ورقة مصدر البيانات لاسم العمود المقدّم.

المَعلمات

الاسمالنوعالوصف
columnNameStringاسم عمود مصدر البيانات لجلب القيم.

تذكرة ذهاب وعودة

Object[] - مصفوفة من قيم واحدة البُعد.

التفويض

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

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

getSheetValues(columnName, startRow, numRows)

تعرض جميع قيم ورقة مصدر البيانات لاسم العمود المقدّم من صف البدء المقدّم (استنادًا إلى 1) وما يصل إلى numRows المقدّمة.

المَعلمات

الاسمالنوعالوصف
columnNameStringاسم عمود مصدر البيانات لجلب القيم.
startRowIntegerموضع الصف لبدء استرجاع القيم.
numRowsIntegerعدد الصفوف المطلوب جلبها.

تذكرة ذهاب وعودة

Object[] - مصفوفة من قيم واحدة البُعد.

التفويض

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

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

getSortSpecs()

تحصل على جميع مواصفات الترتيب في ورقة مصدر البيانات.

تذكرة ذهاب وعودة

SortSpec[] — قائمة بمواصفات الترتيب.

التفويض

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

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

getStatus()

تحصل على حالة تنفيذ البيانات للعنصر.

تذكرة ذهاب وعودة

DataExecutionStatus - حالة تنفيذ البيانات.

التفويض

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

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

refreshData()

لإعادة تحميل بيانات العنصر.

عرض استثناء إذا كان حاليًا في حالة error استخدِم DataSource#updateSpec() لتعديل المواصفات. ننصحك باستخدام الطريقة بدلاً من forceRefreshData() لمنع إجراء تعديلات غير متوقّعة على مصدر البيانات.

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

تذكرة ذهاب وعودة

DataSourceSheet — كائن البيانات.

التفويض

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

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

removeFilters(columnName)

يزيل جميع الفلاتر المطبّقة على عمود ورقة مصدر البيانات.

المَعلمات

الاسمالنوعالوصف
columnNameStringاسم العمود الذي تريد إزالة الفلاتر منه.

تذكرة ذهاب وعودة

DataSourceSheet - ورقة بيانات مصدر البيانات، لسلسلة الطرق.

التفويض

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

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

removeSortSpec(columnName)

يزيل مواصفات الترتيب في عمود في ورقة بيانات المصدر.

المَعلمات

الاسمالنوعالوصف
columnNameStringاسم العمود

تذكرة ذهاب وعودة

DataSourceSheet - ورقة بيانات مصدر البيانات، للسلاسل.

التفويض

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

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

setColumnWidth(columnName, width)

لضبط عرض العمود المحدد.

المَعلمات

الاسمالنوعالوصف
columnNameStringاسم العمود
widthIntegerالعرض الجديد للعمود.

تذكرة ذهاب وعودة

DataSourceSheet - ورقة مصدر البيانات هذه، للسلسلة.

التفويض

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

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

setColumnWidths(columnNames, width)

لضبط عرض الأعمدة المحددة.

المَعلمات

الاسمالنوعالوصف
columnNamesString[]قائمة أسماء الأعمدة المطلوب تعديلها
widthIntegerالعرض الجديد للأعمدة.

تذكرة ذهاب وعودة

DataSourceSheet - ورقة مصدر البيانات هذه، للسلسلة.

التفويض

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

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

setSortSpec(columnName, ascending)

لضبط مواصفات الترتيب في عمود في ورقة بيانات المصدر.

المَعلمات

الاسمالنوعالوصف
columnNameStringاسم العمود للترتيب.
ascendingBooleanإذا true، عليك ترتيب العمود تصاعديًا، وإذا كان false، عليك ترتيب العمود تنازليًا.

تذكرة ذهاب وعودة

DataSourceSheet - ورقة بيانات مصدر البيانات، للسلاسل.

التفويض

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

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

setSortSpec(columnName, sortOrder)

لضبط مواصفات الترتيب في عمود في ورقة بيانات المصدر.

المَعلمات

الاسمالنوعالوصف
columnNameStringاسم العمود للترتيب.
sortOrderSortOrderنظام ترتيب النتائج.

تذكرة ذهاب وعودة

DataSourceSheet - ورقة بيانات مصدر البيانات، للسلاسل.

التفويض

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

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

waitForCompletion(timeoutInSeconds)

الانتظار حتى اكتمال عملية التنفيذ الحالية، وستنتهي المهلة بعد عدد الثواني المقدَّم. عرض استثناء في حال عدم اكتمال التنفيذ عند انتهاء المهلة، مع عدم إلغاء تنفيذ البيانات

المَعلمات

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

تذكرة ذهاب وعودة

DataExecutionStatus - حالة تنفيذ البيانات.

التفويض

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

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