סקירה כללית על 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.

אינדקס

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

תמונה בתוך שורה

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

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

טווח טקסט רציף. NamedRange הוא אוסף של טווחים עם אותו namedRangeId. טווחים עם שמות מאפשרים למפתחים לשייך חלקים של מסמך לתווית שרירותית שהוגדרה על ידי המשתמש, כדי שתוכלו לקרוא או לערוך את התוכן שלהם באופן פרוגרמטי בהמשך. מסמך יכול להכיל כמה טווחי תאים עם שם זהה, אבל לכל טווח תאים בעל שם יש מזהה ייחודי.

פלח

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

הצעה

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

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

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

• מסמך – סקירה כללית מושגית של מסמך.

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