Method: spreadsheets.get

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

به طور پیش‌فرض، داده‌های درون شبکه‌ها بازگردانده نمی‌شوند. می‌توانید داده‌های شبکه را به یکی از دو روش زیر وارد کنید:

  • با استفاده از پارامتر URL fields در HTTP، یک ماسک فیلد مشخص کنید که فیلدهای مورد نظر شما را فهرست کند.

  • پارامتر URL includeGridData را روی true تنظیم کنید. اگر یک ماسک فیلد تنظیم شده باشد، پارامتر includeGridData نادیده گرفته می‌شود.

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

برای بازیابی فقط زیرمجموعه‌هایی از داده‌های صفحه‌گسترده، از پارامتر URL ranges استفاده کنید. محدوده‌ها با استفاده از نمادگذاری A1 مشخص می‌شوند. می‌توانید یک سلول واحد (مثلاً A1 ) یا چندین سلول (مثلاً A1:D5 ) تعریف کنید. همچنین می‌توانید سلول‌هایی از سایر برگه‌های درون همان صفحه‌گسترده (مثلاً Sheet2!A1:C4 ) دریافت کنید یا چندین محدوده را به طور همزمان بازیابی کنید (مثلاً ?ranges=A1:D5&ranges=Sheet2!A1:C4 ). محدود کردن محدوده، فقط بخش‌هایی از صفحه‌گسترده را که با محدوده‌های درخواستی تلاقی دارند، برمی‌گرداند.

درخواست HTTP

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

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

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

پارامترها
spreadsheetId

string

صفحه گسترده مورد درخواست.

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

پارامترها
ranges[]

string

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

includeGridData

boolean

اگر داده‌های شبکه‌ای باید برگردانده شوند، صحیح است. اگر در درخواست، ماسک فیلد تنظیم شده باشد، این پارامتر نادیده گرفته می‌شود.

excludeTablesInBandedRanges

boolean

اگر جداول باید در محدوده‌های نواری حذف شوند، مقدار صحیح (true) و اگر تنظیم نشده باشند، مقدار غلط (false) برمی‌گرداند.

commentsViewMode

enum ( CommentsViewMode )

حالت نمایش نظرات برای اعمال به صفحه‌گسترده. این حالت امکان مشاهده صفحه‌گسترده را با نظرات حذف شده یا اضافه شده فراهم می‌کند. اگر نظری مشخص نشده باشد، COMMENTS_VIEW_MODE_OMITTED استفاده می‌شود.

درخواست بدنه

بدنه درخواست باید خالی باشد.

بدنه پاسخ

در صورت موفقیت، بدنه پاسخ شامل نمونه‌ای از Spreadsheet است.

دامنه‌های مجوز

به یکی از حوزه‌های 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

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