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