API گوگل شیت (Google Sheets API) یک رابط RESTful است که به شما امکان میدهد دادههای یک صفحه گسترده را بخوانید و تغییر دهید. API شیت به شما امکان میدهد:
- ایجاد صفحات گسترده
- خواندن و نوشتن مقادیر سلولهای صفحه گسترده
- قالببندی صفحهگسترده را بهروزرسانی کنید
- مدیریت صفحات متصل
در زیر لیستی از اصطلاحات رایج مورد استفاده در Sheets API آمده است:
- صفحه گسترده
شیء اصلی در Google Sheets. میتواند شامل چندین
Sheetsباشد که هر کدام اطلاعات ساختاریافتهای درCellsدارند. منبعspreadsheetsیک spreadsheet را نشان میدهد. این منبع حاوی یک مقدار منحصر به فردspreadsheetIdاست.- شناسه صفحه گسترده
- شناسه منحصر به فرد برای یک صفحه گسترده. این یک رشته خاص است که شامل حروف، اعداد و برخی کاراکترهای خاص است که به یک صفحه گسترده اشاره میکند و میتواند از URL صفحه گسترده گرفته شود. شناسههای صفحه گسترده پایدار هستند، حتی اگر نام صفحه گسترده تغییر کند.
https://docs.google.com/spreadsheets/d/SPREADSHEET_ID/edit?gid=SHEET_ID#gid=SHEET_ID- ورق
یک صفحه یا تب در یک صفحه گسترده. منبع
Sheetsنشان دهنده یک صفحه است. این منبع شامل یک مقدار عددی منحصر به فردsheetIdوtitleصفحه به عنوان بخشی از شیءSheetPropertiesاست.- شناسه برگه
- شناسه منحصر به فرد برای یک برگه خاص در یک صفحه گسترده. این یک عدد صحیح خاص است که حاوی اعدادی است که به یک برگه اشاره میکنند و میتوان آن را از URL صفحه گسترده استخراج کرد. شناسههای برگه ثابت هستند، حتی اگر نام برگه تغییر کند. برای مثال، به شناسه صفحه گسترده مراجعه کنید.
- سلول
یک فیلد متنی یا دادهای مجزا در یک برگه. سلولها در ردیفها و ستونها مرتب شدهاند و میتوانند به عنوان طیفی از سلولها گروهبندی شوند. منبع
Cellsهر سلول را نشان میدهد، اما مقدار ID منحصر به فردی ندارد. در عوض، مختصات ردیف و ستون، سلولها را مشخص میکنند.- نمادگذاری A1
- سینتکسی که برای تعریف یک سلول یا محدودهای از سلولها با رشتهای که شامل نام شیت به علاوه مختصات سلول شروع و پایان با استفاده از حروف ستون و شماره ردیف است، استفاده میشود. این روش رایجترین و مفیدترین روش هنگام ارجاع به محدودهای مطلق از سلولها است.
-
Sheet1!A1:B2به تمام سلولهای موجود در دو ردیف و ستون اول Sheet1 اشاره دارد. -
Sheet1!A:Aبه تمام سلولهای موجود در ستون اول Sheet1 اشاره دارد. -
Sheet1!1:2به تمام سلولهای موجود در دو ردیف اول Sheet1 اشاره دارد. -
Sheet1!A5:Aبه تمام سلولهای ستون اول Sheet 1، از ردیف 5 به بعد، اشاره دارد. -
A1:B2به تمام سلولهای دو ردیف و ستون اول اولین شیت قابل مشاهده اشاره دارد. -
Sheet1به تمام سلولهای موجود در Sheet1 اشاره دارد. -
'Jon's_Data'!A1:D5به تمام سلولهای موجود در پنج ردیف و چهار ستون اول یک برگه با نام «Jon's_Data» اشاره دارد. -
'My Custom Sheet'!A:Aبه تمام سلولهای ستون اول برگهای با نام «برگه سفارشی من» اشاره دارد. -
'My Custom Sheet'به تمام سلولهای موجود در «برگه سفارشی من» اشاره دارد.
برای نامهای شیت که دارای فاصله یا کاراکترهای خاص هستند، استفاده از تککوتیشن الزامی است.
نکته : در صورت امکان، از نامهای متمایز برای اشیاء در صفحات گسترده خود استفاده کنید. به عنوان مثال، A1 (بدون علامت نقل قول) به سلول A1 در اولین صفحه قابل مشاهده اشاره دارد.
'A1'به صفحهای با نام A1 اشاره دارد. به طور مشابه، Sheet1 به صفحهای با نام Sheet1 اشاره دارد. با این حال، اگر یک محدوده نامگذاری شده با عنوان "Sheet1" وجود داشته باشد، Sheet1 به محدوده نامگذاری شده و'Sheet1'به صفحه اشاره دارد.- نمادگذاری R1C1
- نحوی که برای تعریف یک سلول یا محدودهای از سلولها با رشتهای که شامل نام برگه به علاوه مختصات سلول شروع و پایان با استفاده از شماره ردیف و شماره ستون است، استفاده میشود. این روش نسبت به نمادگذاری A1 کمتر رایج است، اما میتواند هنگام ارجاع به محدودهای از سلولها نسبت به موقعیت سلول مشخص مفید باشد.
-
Sheet1!R1C1:R2C2به دو سلول اول در دو ردیف بالای Sheet1 اشاره دارد. -
R1C1:R2C2به دو سلول اول در دو ردیف بالای اولین برگه قابل مشاهده اشاره دارد. -
Sheet1!R[3]C[1]به سلولی اشاره دارد که سه ردیف پایینتر و یک ستون در سمت راست سلول فعلی قرار دارد.
- محدوده نامگذاری شده
- یک سلول یا محدودهای از سلولها با نامی دلخواه برای سادهسازی ارجاعات در سراسر برنامه. یک منبع
FilterViewنشاندهندهی یک محدودهی نامگذاری شده است. - محدوده حفاظتشده
- یک سلول یا محدودهای از سلولهای تعریفشده که قابل تغییر نیستند. یک منبع
ProtectedRangeنشاندهنده یک محدوده محافظتشده است.
مباحث مرتبط
برای کسب اطلاعات بیشتر در مورد توسعه با APIهای Google Workspace، از جمله مدیریت احراز هویت و مجوز، به «توسعه در Google Workspace» مراجعه کنید.
برای یادگیری نحوه پیکربندی و اجرای یک برنامه Sheets API، شروع سریع جاوا اسکریپت را امتحان کنید.