Method: spreadsheets.values.batchGet

یک یا چند محدوده از مقادیر را از یک صفحه‌گسترده برمی‌گرداند. تماس گیرنده باید شناسه صفحه گسترده و یک یا چند محدوده را مشخص کند.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

پارامترها
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 باشد، این نادیده گرفته می‌شود. گزینه پیش‌فرض render dateTime 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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.