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

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

הצעה

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