API گوگل داکز به شما امکان میدهد اسناد را در گوگل داکز ایجاد و ویرایش کنید.
برنامهها میتوانند با API اسناد (Docs API) ادغام شوند تا اسناد بینقصی را از دادههای ارائه شده توسط کاربر و سیستم ایجاد کنند. API اسناد به شما امکان میدهد:
- خودکارسازی فرآیندها
- ایجاد مستندات به صورت انبوه
- قالببندی اسناد
- ایجاد فاکتور یا قرارداد
- بازیابی ویژگیهای خاص اشیاء
در زیر لیستی از اصطلاحات رایج مورد استفاده در API اسناد آمده است:
- شناسه سند
شناسه منحصر به فرد برای یک سند. این یک رشته خاص است که شامل حروف، اعداد و برخی کاراکترهای خاص است که به یک سند اشاره میکند و میتواند از URL سند گرفته شود. شناسههای سند ثابت هستند، حتی اگر نام سند تغییر کند. برای اطلاعات بیشتر در مورد نحوه یافتن شناسه، به شناسه سند مراجعه کنید.
https://docs.google.com/document/d/DOCUMENT_ID/edit- عنصر
ساختاری که یک سند را تشکیل میدهد. عناصر سطح بالای یک سند شامل
Body،DocumentStyleوListمیشوند.- سند گوگل ورک اسپیس
فایلی که یک برنامه Google Workspace، مانند Google Docs، ایجاد میکند. قالب نوع MIME برای Docs،
application/vnd.google-apps.documentاست. برای فهرستی از انواع MIME، به انواع MIME پشتیبانیشده توسط Google Workspace و Google Drive مراجعه کنید.- فهرست
بیشتر عناصر درون بدنه محتوا دارای ویژگیهای
startIndexوendIndexهستند. این ویژگیها نشاندهندهی فاصلهی شروع و پایان یک عنصر نسبت به ابتدای بخش دربرگیرندهی آن هستند.- تصویر درون خطی
تصویری که در متن یک سند ظاهر میشود. این یک پیوست نیست.
- محدوده نامگذاری شده
یک محدوده پیوسته از متن. یک
NamedRangeمجموعهای از محدودهها باnamedRangeIdیکسان است. محدودههای نامگذاری شده به توسعهدهندگان اجازه میدهند بخشهایی از یک سند را با یک برچسب دلخواه تعریف شده توسط کاربر مرتبط کنند تا محتوای آنها بعداً از طریق برنامه قابل خواندن یا ویرایش باشد. یک سند میتواند شامل چندین محدوده نامگذاری شده با نام یکسان باشد، اما هر محدوده نامگذاری شده دارای یک شناسه منحصر به فرد است.- بخش
Body،Header،FooterیاFootnoteکه شامل عناصر ساختاری یا محتوایی هستند. اندیس عناصر درون یک بخش نسبت به ابتدای آن بخش است.- پیشنهاد
تغییرات در یک سند بدون تغییر متن اصلی. اگر مالک پیشنهادات شما را تأیید کند، آنها جایگزین متن اصلی میشوند.
مباحث مرتبط
برای کسب اطلاعات بیشتر در مورد توسعه با APIهای Google Workspace، از جمله مدیریت احراز هویت و مجوز، به «توسعه در Google Workspace» مراجعه کنید.
برای دریافت یک مرور کلی مفهومی از یک سند، به سند مراجعه کنید.
برای یادگیری نحوه پیکربندی و اجرای یک برنامه API Docs، شروع سریع جاوا اسکریپت را امتحان کنید.