Method: spreadsheets.values.batchGet

تعرض نطاقًا واحدًا أو أكثر من القيم من جدول بيانات. على المتصل تحديد معرّف جدول البيانات ونطاق واحد أو أكثر.

طلب HTTP

GET https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchGet

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المعلمات
spreadsheetId

string

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

مَعلمات طلب البحث

المعلمات
ranges[]

string

نمط A1 أو نمط R1C1 للنطاق الذي تريد استرداد القيم منه
majorDimension

enum (Dimension)

السمة الرئيسية التي يجب أن تستخدِمها النتائج

على سبيل المثال، إذا كانت بيانات جدول البيانات هي: A1=1,B1=2,A2=3,B2=4، يؤدي طلب ranges=["A1:B2"],majorDimension=ROWS إلى عرض [[1,2],[3,4]]، في حين يؤدي طلب ranges=["A1:B2"],majorDimension=COLUMNS إلى عرض [[1,3],[2,4]].
valueRenderOption

enum (ValueRenderOption)

كيفية تمثيل القيم في الإخراج الخيار التلقائي للعرض هو ValueRenderOption.FORMATTED_VALUE.
dateTimeRenderOption

enum (DateTimeRenderOption)

كيفية عرض التواريخ والأوقات والمدد في الإخراج يتم تجاهل هذا الإجراء إذا كان valueRenderOption هو FORMATTED_VALUE. الخيار التلقائي لعرض التاريخ والوقت هو SERIAL_NUMBER.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

الردّ عند استرداد أكثر من نطاق واحد من القيم في جدول بيانات

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

تمثيل JSON 
{
  "spreadsheetId": string,
  "valueRanges": [
    {
      object (ValueRange)
    }
  ]
}
الحقول
spreadsheetId

string

رقم تعريف جدول البيانات الذي تم استرجاع البيانات منه.
valueRanges[]

object (ValueRange)

القيم المطلوبة. يكون ترتيب ValueRanges هو نفسه ترتيب النطاقات المطلوبة.

نطاقات التفويض

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

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

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