סקירה כללית על 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 שמכילים רכיבי תוכן או מבניים. האינדקסים של הרכיבים בתוך פלח נקבעים ביחס לתחילת הפלח.

הצעה

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