Method: spreadsheets.values.batchClear

يؤدي إلى محو نطاق واحد أو أكثر من القيم من جدول بيانات. يجب أن يحدِّد المتصل رقم تعريف جدول البيانات ونطاقًا واحدًا أو أكثر. يتم محو القيم فقط، مع الاحتفاظ بجميع السمات الأخرى في الخلية (مثل التنسيق والتحقّق من صحة البيانات).

طلب HTTP

POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchClear

يستخدم عنوان URL بنية gRPC Transcode.

معلّمات المسار

المَعلمات
spreadsheetId

string

رقم تعريف جدول البيانات المطلوب تعديله

نص الطلب

يحتوي نص الطلب على بيانات بالبنية التالية:

تمثيل JSON 
{
  "ranges": [
    string
  ]
}
الحقول
ranges[]

string

النطاقات التي يجب محوها بتدوين A1 أو تدوين R1C1

نص الاستجابة

الاستجابة عند محو نطاق من القيم في جدول بيانات

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "spreadsheetId": string,
  "clearedRanges": [
    string
  ]
}
الحقول
spreadsheetId

string

جدول البيانات الذي تم تطبيق التحديثات عليه.
clearedRanges[]

string

النطاقات التي تم محوها، بتدوين A1 إذا كانت الطلبات لنطاق غير محدود أو نطاقًا أكبر من حدود ورقة البيانات، تكون هذه هي النطاقات الفعلية التي تم محوها ويتم ربطها بحدود ورقة البيانات.

نطاقات الأذونات

يتطلب ذلك أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets

لمزيد من المعلومات، اطّلِع على دليل التفويض.