Method: spreadsheets.values.batchGet

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

طلب HTTP

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

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

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

المَعلمات
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)

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

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

يتطلب ذلك أحد نطاقات 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

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