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

הצעה

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

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

• כדי ללמוד על פיתוח עם Google Workspace APIs, כולל טיפול אימות והרשאה, ראו פיתוח Google Workspace

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

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