الوصول إلى ورقة مصدر البيانات الحالية وتعديلها. لإنشاء ورقة بيانات مصدر بيانات جديدة، استخدِم 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)
إضافة فلتر تم تطبيقه على ورقة مصدر البيانات.
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
columnName | String | اسم العمود الذي تريد تطبيق هذا الفلتر عليه |
filterCriteria | FilterCriteria | معايير الفلتر المطلوب تطبيقها. |
تذكرة ذهاب وعودة
DataSourceSheet
- ورقة بيانات مصدر البيانات، لسلسلة الطرق.
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
asSheet()
autoResizeColumn(columnName)
تغيير الحجم التلقائي لعرض العمود المحدد.
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
columnName | String | اسم العمود |
تذكرة ذهاب وعودة
DataSourceSheet
- ورقة مصدر البيانات هذه، للسلسلة.
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
autoResizeColumns(columnNames)
تغيّر تلقائيًا عرض الأعمدة المحددة.
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
columnNames | String[] | قائمة أسماء الأعمدة المطلوب تعديلها |
تذكرة ذهاب وعودة
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)
لعرض عرض العمود المحدّد.
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
columnName | String | اسم العمود |
تذكرة ذهاب وعودة
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)
عرض جميع قيم ورقة مصدر البيانات لاسم العمود المقدّم.
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
columnName | String | اسم عمود مصدر البيانات لجلب القيم. |
تذكرة ذهاب وعودة
Object[]
- مصفوفة من قيم واحدة البُعد.
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSheetValues(columnName, startRow, numRows)
تعرض جميع قيم ورقة مصدر البيانات لاسم العمود المقدّم من صف البدء المقدّم (استنادًا إلى 1) وما يصل إلى numRows
المقدّمة.
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
columnName | String | اسم عمود مصدر البيانات لجلب القيم. |
startRow | Integer | موضع الصف لبدء استرجاع القيم. |
numRows | Integer | عدد الصفوف المطلوب جلبها. |
تذكرة ذهاب وعودة
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)
يزيل جميع الفلاتر المطبّقة على عمود ورقة مصدر البيانات.
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
columnName | String | اسم العمود الذي تريد إزالة الفلاتر منه. |
تذكرة ذهاب وعودة
DataSourceSheet
- ورقة بيانات مصدر البيانات، لسلسلة الطرق.
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
removeSortSpec(columnName)
يزيل مواصفات الترتيب في عمود في ورقة بيانات المصدر.
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
columnName | String | اسم العمود |
تذكرة ذهاب وعودة
DataSourceSheet
- ورقة بيانات مصدر البيانات، للسلاسل.
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setColumnWidth(columnName, width)
لضبط عرض العمود المحدد.
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
columnName | String | اسم العمود |
width | Integer | العرض الجديد للعمود. |
تذكرة ذهاب وعودة
DataSourceSheet
- ورقة مصدر البيانات هذه، للسلسلة.
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setColumnWidths(columnNames, width)
لضبط عرض الأعمدة المحددة.
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
columnNames | String[] | قائمة أسماء الأعمدة المطلوب تعديلها |
width | Integer | العرض الجديد للأعمدة. |
تذكرة ذهاب وعودة
DataSourceSheet
- ورقة مصدر البيانات هذه، للسلسلة.
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setSortSpec(columnName, ascending)
لضبط مواصفات الترتيب في عمود في ورقة بيانات المصدر.
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
columnName | String | اسم العمود للترتيب. |
ascending | Boolean | إذا true ، عليك ترتيب العمود تصاعديًا، وإذا كان false ، عليك ترتيب العمود تنازليًا. |
تذكرة ذهاب وعودة
DataSourceSheet
- ورقة بيانات مصدر البيانات، للسلاسل.
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setSortSpec(columnName, sortOrder)
لضبط مواصفات الترتيب في عمود في ورقة بيانات المصدر.
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
columnName | String | اسم العمود للترتيب. |
sortOrder | SortOrder | نظام ترتيب النتائج. |
تذكرة ذهاب وعودة
DataSourceSheet
- ورقة بيانات مصدر البيانات، للسلاسل.
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
waitForCompletion(timeoutInSeconds)
الانتظار حتى اكتمال عملية التنفيذ الحالية، وستنتهي المهلة بعد عدد الثواني المقدَّم. عرض استثناء في حال عدم اكتمال التنفيذ عند انتهاء المهلة، مع عدم إلغاء تنفيذ البيانات
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
timeoutInSeconds | Integer | وقت الانتظار لتنفيذ البيانات، بالثواني الحد الأقصى هو 300 ثانية. |
تذكرة ذهاب وعودة
DataExecutionStatus
- حالة تنفيذ البيانات.
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets