סקירה כללית על 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. הערכים האלה מציינים את ההיסט של ההתחלה והסוף של רכיב, ביחס להתחלה של הקטע שמכיל אותו.
- תמונה מוטבעת
תמונה שמופיעה ברצף הטקסט במסמך. זה לא קובץ מצורף.
- טווח תאים בעל שם
טווח רציף של טקסט. NamedRange הוא אוסף של טווחים עם אותו namedRangeId. טווחים עם שמות מאפשרים למפתחים לשייך חלקים במסמך לתווית שרירותית שהוגדרה על ידי המשתמש, כדי שיהיה אפשר לקרוא או לערוך את התוכן שלהם באופן פרוגרמטי בהמשך. מסמך יכול להכיל כמה טווחי תאים בעלי שם עם אותו שם, אבל לכל טווח תאים בעל שם יש מזהה ייחודי.
- פלח
התג Body, Header, Footer או Footnote שמכיל רכיבים של מבנה או תוכן. האינדקסים של הרכיבים בקטע הם יחסיים לתחילת הקטע.
- הצעה
שינויים במסמך בלי לשנות את הטקסט המקורי. אם הבעלים יאשרו את ההצעות, השינויים יחליפו את הטקסט המקורי.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-08-29 (שעון UTC).
[null,null,["עדכון אחרון: 2025-08-29 (שעון UTC)."],[],[],null,["# Google Docs API overview\n\nThe Google Docs API lets you create and modify documents in Google Docs.\n\nApplications can integrate with the Docs API to create polished\ndocuments from both user and system-provided data. The Docs API lets\nyou:\n\n- Automate processes\n- Create documentation in bulk\n- Format documents\n- Generate invoices or contracts\n- Retrieve specific attributes of objects\n\nThe following is a list of common terms used in the Docs API:\n\n*Document ID*\n\n: The unique identifier for a document. It's a particular string containing\n letters, numbers, and some special characters that reference a document and\n it can be derived from the document's URL. Document IDs are stable, even if\n the document name changes. For more information on how to find the ID, see\n [Document ID](/workspace/docs/api/concepts/document#document-id).\n\n https://docs.google.com/document/d/\u003cvar translate=\"no\"\u003eDOCUMENT_ID\u003c/var\u003e/edit\n\n*Element*\n\n: The structure that makes up a document. Top-level elements of a document\n include the [`Body`](/workspace/docs/api/reference/rest/v1/documents#body),\n [`DocumentStyle`](/workspace/docs/api/reference/rest/v1/documents#documentstyle), and\n [`List`](/workspace/docs/api/reference/rest/v1/documents#list).\n\n*Google Workspace document*\n\n: A file that a Google Workspace application, like Google Docs, creates.\n The MIME type format for Docs is\n `application/vnd.google-apps.document`. For a list of MIME types, see [Google Workspace and Google Drive supported MIME types](/drive/api/guides/mime-types).\n\n*Index*\n\n: Most *elements* within the content body have the `startIndex` and `endIndex`\n properties. These indicate the offset of an element's beginning and end,\n relative to the beginning of its enclosing *segment*.\n\n*Inline image*\n\n: An image that appears in the flow of text within a document. It's not an\n attachment.\n\n*Named range*\n\n: A contiguous range of text. A\n [`NamedRange`](/workspace/docs/api/reference/rest/v1/documents#namedrange) is a\n collection of ranges with the same `namedRangeId`. Named ranges allow\n developers to associate parts of a document with an arbitrary user-defined\n label so their contents can be programmatically read or edited later. A\n document can contain multiple named ranges with the same name, but every\n named range has a unique ID.\n\n*Segment*\n\n: The `Body`, [`Header`](/workspace/docs/api/reference/rest/v1/documents#header),\n [`Footer`](/workspace/docs/api/reference/rest/v1/documents#footer), or\n [`Footnote`](/workspace/docs/api/reference/rest/v1/documents#footnote) containing\n structural or content *elements* . The *indexes* of the elements within a\n segment are relative to the beginning of that segment.\n\n*Suggestion*\n\n: Changes to a document without changing the original text. If the owner\n approves your suggestions, they replace the original text.\n\nRelated topics\n--------------\n\n- To learn about developing with Google Workspace APIs, including handling\n authentication and authorization, refer to [Develop on\n Google Workspace](/workspace/guides/get-started).\n\n- To get a conceptual overview of a document, see\n [Document](/workspace/docs/api/concepts/document).\n\n- To learn how to configure and run a Docs API app, try the\n [JavaScript quickstart](/workspace/docs/api/quickstart/js)."]]
