نمای کلی API Sheets Google

Google Sheets API یک رابط RESTful است که به شما امکان می‌دهد داده‌های صفحه‌گسترده را بخوانید و تغییر دهید. رایج ترین کاربردهای این API شامل وظایف زیر است:

  • صفحات گسترده ایجاد کنید
  • خواندن و نوشتن مقادیر سلول های صفحه گسترده
  • قالب بندی صفحه گسترده را به روز کنید
  • صفحات متصل را مدیریت کنید

در زیر لیستی از اصطلاحات رایج مورد استفاده در این API آمده است:

صفحه گسترده

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

https://docs.google.com/spreadsheets/d/ spreadsheetId /edit#gid=0

ورق

یک صفحه یا برگه در یک صفحه گسترده. یک منبع Sheet هر برگه را نشان می دهد و یک عنوان منحصر به فرد و مقدار sheetId عددی دارد. می‌توانید شناسه برگه را در URL کاربرگ‌نگار Google پیدا کنید:

https://docs.google.com/spreadsheets/d/aBC-123_xYz/edit#gid= sheetId

سلول

یک فیلد جداگانه از متن یا داده در یک برگه. سلول ها در ردیف ها و ستون ها مرتب شده اند و می توانند به عنوان یک محدوده از سلول ها گروه بندی شوند. یک منبع CellData هر سلول را نشان می دهد، اما یک مقدار 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 یک محدوده محافظت شده را نشان می دهد.
  • برای آشنایی با توسعه با Google Workspace APIها، از جمله رسیدگی به احراز هویت و مجوز، به Develop on Google Workspace مراجعه کنید.

  • برای آشنایی با نحوه پیکربندی و اجرای برنامه Sheets API، نمای کلی Quickstarts را بخوانید.