סקירה כללית על Google Docs API

בעזרת Google Docs API אפשר ליצור ולשנות מסמכים ב-Google Docs.

אפליקציות יכולות להשתלב עם Docs API כדי ליצור מסמכים מלוטשים מנתונים שהמשתמשים והמערכת מספקים. בעזרת Docs API אפשר:

• אוטומציה של תהליכים
• יצירת מסמכים בכמות גדולה
• עיצוב מסמכים
• יצירת חשבוניות או חוזים
• אחזור של מאפיינים ספציפיים של אובייקטים

ריכזנו כאן רשימה של מונחים נפוצים שמשמשים ב-Docs API:

מזהה המסמך

המזהה הייחודי של המסמך. זו מחרוזת מסוימת שמכילה אותיות, מספרים ותווים מיוחדים מסוימים שמפנים למסמך, ואפשר לגזור אותה מכתובת ה-URL של המסמך. מזהי המסמכים הם יציבים, גם אם השם של המסמך משתנה. מידע נוסף על איתור המזהה זמין במאמר בנושא מזהה מסמך.

https://docs.google.com/document/d/DOCUMENT_ID/edit

רכיב

המבנה שמרכיב את המסמך. רכיבים ברמה העליונה של מסמך כוללים את Body,‏ DocumentStyle ו-List.

מסמך Google Workspace

קובץ שנוצר על ידי אפליקציית Google Workspace, כמו Google Docs. הפורמט של סוג ה-MIME ב-Docs הוא application/vnd.google-apps.document. רשימת סוגי MIME מופיעה במאמר סוגי MIME שנתמכים ב-Google Workspace וב-Google Drive.

Index

לרוב הרכיבים בגוף התוכן יש את המאפיינים startIndex ו-endIndex. הערכים האלה מציינים את ההיסט של ההתחלה והסוף של רכיב, ביחס להתחלה של הקטע שמקיף אותו.

תמונה מוטבעת

תמונה שמופיעה ברצף הטקסט במסמך. זה לא קובץ מצורף.

טווח תאים בעל שם

טווח רציף של טקסט. ‫A NamedRange is a collection of ranges with the same namedRangeId. טווחים עם שמות מאפשרים למפתחים לשייך חלקים במסמך לתווית שרירותית שהוגדרה על ידי המשתמש, כדי שיהיה אפשר לקרוא או לערוך את התוכן שלהם באופן פרוגרמטי בהמשך. מסמך יכול להכיל כמה טווחי תאים בעלי שם עם אותו שם, אבל לכל טווח תאים בעל שם יש מזהה ייחודי.

פלח

התג Body, Header,‏ Footer או Footnote שמכיל רכיבים של מבנה או תוכן. האינדקסים של הרכיבים בקטע הם יחסיים לתחילת הקטע.

הצעה

שינויים במסמך בלי לשנות את הטקסט המקורי. אם הבעלים יאשרו את ההצעות, השינויים יחליפו את הטקסט המקורי.

נושאים קשורים

• מידע על פיתוח באמצעות ממשקי API של Google Workspace, כולל טיפול באימות ובמתן הרשאות, זמין במאמר פיתוח ב-Google Workspace.

• כדי לקבל סקירה כללית של מסמך, אפשר לעיין במאמר בנושא מסמך.

• כדי ללמוד איך להגדיר ולהריץ אפליקציה של Docs API, אפשר לנסות את המדריך למתחילים בנושא JavaScript.