מסמך, שמכיל טקסט עשיר ורכיבים כמו טבלאות ורשימות.
אפשר לפתוח או ליצור מסמכים באמצעות DocumentApp
.
// Open a document by ID. var doc = DocumentApp.openById("<my-id>"); // Create and open a document. doc = DocumentApp.create("Document Title");
שיטות
שיטה | סוג הערך שמוחזר | תיאור קצר |
---|---|---|
addBookmark(position) | Bookmark | הפונקציה הזאת מוסיפה Bookmark ב-Position הנתון. |
addEditor(emailAddress) | Document | מוסיף את המשתמש הנתון לרשימת העורכים של Document . |
addEditor(user) | Document | מוסיף את המשתמש הנתון לרשימת העורכים של Document . |
addEditors(emailAddresses) | Document | מוסיף את מערך המשתמשים הנתון לרשימת העורכים של Document . |
addFooter() | FooterSection | הוספת קטע של כותרת תחתונה למסמך, אם אין קטע כזה. |
addHeader() | HeaderSection | מוסיף קטע של כותרת מסמך, אם אין קטע קיים. |
addNamedRange(name, range) | NamedRange | מוסיף NamedRange , שהוא Range שיש לו שם ומזהה שאפשר להשתמש בהם
לאחזור מאוחר יותר. |
addViewer(emailAddress) | Document | מוסיף את המשתמש הנתון לרשימת הצופים בDocument . |
addViewer(user) | Document | מוסיף את המשתמש הנתון לרשימת הצופים בDocument . |
addViewers(emailAddresses) | Document | הוספה של מערך המשתמשים הנתון לרשימת הצופים של Document . |
getAs(contentType) | Blob | מאחזר את התוכן הנוכחי של Document כ-blob מהסוג שצוין. |
getBlob() | Blob | אחזור התוכן הנוכחי של Document כ-blob. |
getBody() | Body | מאחזר את Body של המסמך הפעיל. |
getBookmark(id) | Bookmark | הפונקציה מקבלת את Bookmark עם המזהה הנתון. |
getBookmarks() | Bookmark[] | הפונקציה מקבלת את כל Bookmark האובייקטים במסמך. |
getCursor() | Position | העברת הסמן של המשתמש למסמך הפעיל. |
getEditors() | User[] | הפונקציה מקבלת את רשימת העורכים של Document . |
getFooter() | FooterSection | אחזור הקטע של הכותרת התחתונה של המסמך, אם קיים. |
getFootnotes() | Footnote[] | אחזור של כל רכיבי Footnote שבגוף המסמך. |
getHeader() | HeaderSection | אחזור הקטע של כותרת המסמך, אם יש כזה. |
getId() | String | שולפת את המזהה הייחודי של המסמך. |
getLanguage() | String | הפונקציה מקבלת את קוד השפה של המסמך. |
getName() | String | אחזור של כותרת המסמך. |
getNamedRangeById(id) | NamedRange | הפונקציה מקבלת את NamedRange עם המזהה הנתון. |
getNamedRanges() | NamedRange[] | הפונקציה מקבלת את כל NamedRange האובייקטים במסמך. |
getNamedRanges(name) | NamedRange[] | הפונקציה מקבלת את כל NamedRange האובייקטים במסמך עם השם הנתון. |
getSelection() | Range | מאחזר את בחירת המשתמש במסמך הפעיל. |
getSupportedLanguageCodes() | String[] | מקבל את כל קודי השפה הנתמכים בקובצי Google Docs. |
getUrl() | String | אחזור של כתובת ה-URL כדי לגשת למסמך הנוכחי. |
getViewers() | User[] | הצגת רשימת הצופים והמגיבים בDocument הזה. |
newPosition(element, offset) | Position | הפונקציה יוצרת Position חדש, שהוא הפניה למיקום במסמך, ביחס לרכיב ספציפי. |
newRange() | RangeBuilder | יוצר כלי לבניית קובץ Range אובייקטים מרכיבי מסמכים. |
removeEditor(emailAddress) | Document | מסיר את המשתמש הנתון מרשימת העורכים של Document . |
removeEditor(user) | Document | מסיר את המשתמש הנתון מרשימת העורכים של Document . |
removeViewer(emailAddress) | Document | מסיר את המשתמש הנתון מרשימת הצופים והמגיבים בDocument . |
removeViewer(user) | Document | מסיר את המשתמש הנתון מרשימת הצופים והמגיבים בDocument . |
saveAndClose() | void | שמירת הערך הנוכחי של Document . |
setCursor(position) | Document | מגדיר את סמן המשתמש במסמך הפעיל, בהינתן Position . |
setLanguage(languageCode) | Document | מגדיר את קוד השפה של המסמך. |
setName(name) | Document | מגדיר את כותרת המסמך. |
setSelection(range) | Document | מגדיר את בחירת המשתמש במסמך הפעיל, בהינתן Range . |
תיעוד מפורט
addBookmark(position)
הפונקציה הזאת מוסיפה Bookmark
ב-Position
הנתון.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('abc123456'); // Gets the document body and adds a paragraph. const paragraph = doc.getBody().appendParagraph('My new paragraph.'); // Creates a position at the first character of the paragraph text. const position = doc.newPosition(paragraph.getChild(0), 0); // Adds a bookmark at the first character of the paragraph text. const bookmark = doc.addBookmark(position); // Logs the bookmark ID to the console. console.log(bookmark.getId()); }
פרמטרים
שם | תיאור | התיאור |
---|---|---|
position | Position | המיקום של הסימנייה החדשה. |
החזרות
Bookmark
- הסימנייה החדשה.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addEditor(emailAddress)
מוסיף את המשתמש הנתון לרשימת העורכים של Document
. אם המשתמש כבר היה ברשימת הצופים, השיטה הזו מקדמת את המשתמש מחוץ לרשימת הצופים.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
emailAddress | String | כתובת האימייל של המשתמש שיש להוסיף. |
החזרות
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addEditor(user)
מוסיף את המשתמש הנתון לרשימת העורכים של Document
. אם המשתמש כבר היה ברשימת הצופים, השיטה הזו מקדמת את המשתמש מחוץ לרשימת הצופים.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
user | User | ייצוג של המשתמש להוספה. |
החזרות
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addEditors(emailAddresses)
מוסיף את מערך המשתמשים הנתון לרשימת העורכים של Document
. אם אחד מהמשתמשים כבר היה ברשימת הצופים, השיטה הזו מקדמת אותו מחוץ לרשימת הצופים.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
emailAddresses | String[] | מערך של כתובות אימייל של המשתמשים להוספה. |
החזרות
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addHeader()
מוסיף קטע של כותרת מסמך, אם אין קטע קיים.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('abc123456'); // Adds a header to the document. const header = doc.addHeader(); // Sets the header text to 'This is a header.' header.setText('This is a header');
החזרות
HeaderSection
- כותרת המסמך.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addNamedRange(name, range)
מוסיף NamedRange
, שהוא Range
שיש לו שם ומזהה שאפשר להשתמש בהם
לאחזור מאוחר יותר. השמות הם לא בהכרח ייחודיים. כמה טווחים שונים באותו מסמך יכולים לחלוק את אותו השם, בדומה למחלקה ב-HTML. לעומת זאת, המזהים הם ייחודיים בתוך המסמך, כמו מזהה ב-HTML. אחרי שמוסיפים NamedRange
למסמך, אי אפשר לשנות אותו, אלא רק להסיר אותו.
כל סקריפט שניגש למסמך יכול לגשת אל NamedRange
. כדי למנוע התנגשויות לא מכוונות בין סקריפטים, כדאי להוסיף מחרוזת ייחודית לשמות של טווחים.
// Creates a named range that includes every table in the document. var doc = DocumentApp.getActiveDocument(); var rangeBuilder = doc.newRange(); var tables = doc.getBody().getTables(); for (var i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } doc.addNamedRange('Document tables', rangeBuilder.build());
פרמטרים
שם | תיאור | התיאור |
---|---|---|
name | String | השם של הטווח אינו חייב להיות ייחודי. שמות הטווחים חייבים להיות באורך של 1-256 תווים. |
range | Range | טווח הרכיבים שיש לשייך לשם. הטווח יכול להיות הבחירה הפעילה, תוצאת חיפוש או שנבנתה באופן ידני באמצעות newRange() . |
החזרות
NamedRange
– NamedRange
.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addViewer(emailAddress)
מוסיף את המשתמש הנתון לרשימת הצופים בDocument
. אם המשתמש כבר היה ברשימת העורכים, לשיטה הזו אין השפעה.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
emailAddress | String | כתובת האימייל של המשתמש שיש להוסיף. |
החזרות
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addViewer(user)
מוסיף את המשתמש הנתון לרשימת הצופים בDocument
. אם המשתמש כבר היה ברשימת העורכים, לשיטה הזו אין השפעה.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
user | User | ייצוג של המשתמש להוספה. |
החזרות
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addViewers(emailAddresses)
הוספה של מערך המשתמשים הנתון לרשימת הצופים של Document
. אם אחד מהמשתמשים כבר היה ברשימת העורכים, לשיטה הזו אין השפעה עליו.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
emailAddresses | String[] | מערך של כתובות אימייל של המשתמשים להוספה. |
החזרות
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAs(contentType)
מאחזר את התוכן הנוכחי של Document
כ-blob מהסוג שצוין.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('abc123456'); // Gets the document as a PDF. const pdf = doc.getAs('application/pdf'); // Logs the name of the PDF to the console. console.log(pdf.getName());
פרמטרים
שם | תיאור | התיאור |
---|---|---|
contentType | String | סוג ה-MIME להמרה. כרגע יש תמיכה רק
ב-'application/pdf' . |
החזרות
Blob
– המסמך הנוכחי כ-blob.
getBlob()
אחזור התוכן הנוכחי של Document
כ-blob.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('abc123456'); // Retrieves the current document's contents as a blob and logs it to the console. console.log(doc.getBlob().getContentType());
החזרות
Blob
– המסמך הנוכחי כ-blob.
getBody()
מאחזר את Body
של המסמך הפעיל.
מסמכים עשויים להכיל סוגים שונים של קטעים (למשל HeaderSection
, FooterSection
). הקטע הפעיל במסמך הוא Body
.
שיטות אלמנט ב-Document
מאצילות ל-Body
הפעיל.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('abc123456'); // Gets the document body. const body = doc.getBody(); // Gets the body text and logs it to the console. console.log(body.getText());
החזרות
Body
- הקטע הפעיל של גוף המסמך.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getBookmark(id)
הפונקציה מקבלת את Bookmark
עם המזהה הנתון. השיטה הזו מחזירה את הערך null
אם לא קיים Bookmark
כזה.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('abc123456'); // Gets the bookmark by its ID. const bookmark = doc.getBookmark('id.xyz654321'); // If the bookmark exists, logs the character offset of its position to the console. // otherwise, logs 'No bookmark exists with the given ID.' to the console. if (bookmark) { console.log(bookmark.getPosition().getOffset()); } else { console.log('No bookmark exists with the given ID.'); }
פרמטרים
שם | תיאור | התיאור |
---|---|---|
id | String | המזהה של Bookmark . |
החזרות
Bookmark
- Bookmark
עם המזהה הנתון, או null
אם לא קיים Bookmark
כזה.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getBookmarks()
הפונקציה מקבלת את כל Bookmark
האובייקטים במסמך.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. const doc = DocumentApp.openById('abc123456'); // Gets all of the bookmarks in the document. const bookmarks = doc.getBookmarks(); // Logs the number of bookmarks in the document to the console. console.log(bookmarks.length);
החזרות
Bookmark[]
- מערך של Bookmark
האובייקטים במסמך.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getCursor()
העברת הסמן של המשתמש למסמך הפעיל. סקריפט יכול לגשת רק לסמן של המשתמש שמריץ את הסקריפט, ורק אם הסקריפט מקושר למסמך.
// Insert some text at the cursor position and make it bold. var cursor = DocumentApp.getActiveDocument().getCursor(); if (cursor) { // Attempt to insert text at the cursor position. If the insertion returns null, the cursor's // containing element doesn't allow insertions, so show the user an error message. var element = cursor.insertText('ಠ‿ಠ'); if (element) { element.setBold(true); } else { DocumentApp.getUi().alert('Cannot insert text here.'); } } else { DocumentApp.getUi().alert('Cannot find a cursor.'); }
החזרות
Position
- ייצוג של סמן המשתמש, או null
אם אין למשתמש
סמן במסמך או אם הסקריפט לא מקושר למסמך.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getEditors()
getFootnotes()
אחזור של כל רכיבי Footnote
שבגוף המסמך.
קריאות אל getFootnotes
גורמות לחזרה על רכיבי המסמך. במסמכים גדולים, כדאי להימנע מקריאות מיותרות לשיטה הזו.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('abc123456'); // Gets the first footnote. const footnote = doc.getFootnotes()[0]; // Logs footnote contents to the console. console.log(footnote.getFootnoteContents().getText());
החזרות
Footnote[]
- הערות השוליים במסמך.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getHeader()
אחזור הקטע של כותרת המסמך, אם יש כזה.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('abc123456'); // Gets the text of the document's header and logs it to the console. console.log(doc.getHeader().getText());
החזרות
HeaderSection
- כותרת המסמך.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getId()
שולפת את המזהה הייחודי של המסמך. מזהה המסמך משמש יחד עם DocumentApp.openById()
לפתיחת מופע של מסמך ספציפי.
החזרות
String
- מזהה המסמך
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getLanguage()
הפונקציה מקבלת את קוד השפה של המסמך. זוהי השפה שמוצגת בקטע קובץ > שפה בעורך המסמך, וייתכן שאינה השפה שבה המסמך מכיל בפועל.
החזרות
String
- שפת המסמך, או null
אם היא לא מוגדרת.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getName()
אחזור של כותרת המסמך.
החזרות
String
- כותרת המסמך
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNamedRangeById(id)
הפונקציה מקבלת את NamedRange
עם המזהה הנתון. השיטה הזו מחזירה את הערך null
אם לא קיים NamedRange
כזה. שמות הם לא בהכרח שמות ייחודיים, כי כמה טווחים שונים באותו מסמך עשויים לחלוק את אותו שם, בדומה למחלקה ב-HTML. לעומת זאת, המזהים הם ייחודיים במסמך, כמו מזהה ב-HTML.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
id | String | במזהה הטווח, שהוא ייחודי במסמך |
החזרות
NamedRange
- NamedRange
עם המזהה הנתון, או null
אם לא קיים טווח כזה
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNamedRanges()
הפונקציה מקבלת את כל NamedRange
האובייקטים במסמך.
ניתן לגשת ל-NamedRange
באמצעות כל סקריפט שניגש למסמך. כדי למנוע התנגשויות לא מכוונות בין סקריפטים, מומלץ להוסיף מחרוזת ייחודית לשמות של טווחים.
החזרות
NamedRange[]
- מערך של האובייקטים NamedRange
במסמך, אולי כולל מספר טווחים עם אותו שם
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNamedRanges(name)
הפונקציה מקבלת את כל NamedRange
האובייקטים במסמך עם השם הנתון. השמות לא צריכים להיות ייחודיים בהכרח. ייתכן שמספר טווחים שונים באותו מסמך יחלקו את אותו שם, בדומה למחלקה ב-HTML. לעומת זאת, המזהים הם ייחודיים בתוך המסמך, כמו מזהה ב-HTML.
ניתן לגשת ל-NamedRange
באמצעות כל סקריפט שניגש למסמך. כדי למנוע התנגשויות לא מכוונות בין סקריפטים, מומלץ להוסיף מחרוזת ייחודית לשמות של טווחים.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
name | String | שם הטווח, שאינו בהכרח ייחודי |
החזרות
NamedRange[]
– מערך של NamedRange
האובייקטים במסמך עם השם הנתון
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getSelection()
מאחזר את בחירת המשתמש במסמך הפעיל. סקריפט יכול לגשת רק לבחירת המשתמש שמפעיל את הסקריפט, ורק אם הסקריפט מקושר למסמך.
// Display a dialog box that tells the user how many elements are included in the selection. var selection = DocumentApp.getActiveDocument().getSelection(); if (selection) { var elements = selection.getRangeElements(); DocumentApp.getUi().alert('Number of selected elements: ' + elements.length); } else { DocumentApp.getUi().alert('Nothing is selected.'); }
החזרות
Range
- ייצוג של בחירת המשתמש. לחלופין, null
אם לא נבחרו
פריטים במסמך, אם נבחר רק סוף פסקה, אם נבחר רק
סוף הפסקה ושורה חדשה, או אם הסקריפט לא מקושר
למסמך.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getSupportedLanguageCodes()
מקבל את כל קודי השפה הנתמכים בקובצי Google Docs.
החזרות
String[]
- מערך של קודי שפה.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getUrl()
אחזור של כתובת ה-URL כדי לגשת למסמך הנוכחי.
var doc = DocumentApp.getActiveDocument(); // Send out the link to open the document. MailApp.sendEmail("<email-address>", doc.getName(), doc.getUrl());
החזרות
String
- כתובת האתר לגישה למסמך הנוכחי
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getViewers()
newPosition(element, offset)
הפונקציה יוצרת Position
חדש, שהוא הפניה למיקום במסמך, ביחס לרכיב ספציפי. סמן המשתמש מיוצג, בין היתר, בתור Position
.
// Append a paragraph, then place the user's cursor after the first word of the new paragraph. var doc = DocumentApp.getActiveDocument(); var paragraph = doc.getBody().appendParagraph('My new paragraph.'); var position = doc.newPosition(paragraph.getChild(0), 2); doc.setCursor(position);
פרמטרים
שם | תיאור | התיאור |
---|---|---|
element | Element | הרכיב שיכיל את ה-Position החדש. הוא צריך להיות
רכיב Text או רכיב מאגר כמו Paragraph |
offset | Integer | לרכיבי Text , מספר התווים לפני Position ;
לרכיבים אחרים, מספר האלמנטים הצאצאים לפני ה-Position
באותו רכיב מאגר |
החזרות
Position
– Position
החדש
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
newRange()
יוצר כלי לבניית קובץ Range
אובייקטים מרכיבי מסמכים.
// Change the user's selection to a range that includes every table in the document. var doc = DocumentApp.getActiveDocument(); var rangeBuilder = doc.newRange(); var tables = doc.getBody().getTables(); for (var i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } doc.setSelection(rangeBuilder.build());
החזרות
RangeBuilder
– כלי היצירה החדש
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeEditor(emailAddress)
מסיר את המשתמש הנתון מרשימת העורכים של Document
. השיטה הזו לא חוסמת את הגישה של משתמשים ל-Document
אם הם שייכים לקטגוריה של משתמשים שיש להם
גישה כללית, למשל אם Document
משותף עם כל הדומיין של המשתמש, או אם Document
נמצא באחסון שיתופי שהמשתמש יכול לגשת אליו.
בקובצי Drive, המשתמש יוסר גם מרשימת הצופים.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
emailAddress | String | כתובת האימייל של המשתמש שיש להסיר. |
החזרות
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeEditor(user)
מסיר את המשתמש הנתון מרשימת העורכים של Document
. השיטה הזו לא חוסמת את הגישה של משתמשים ל-Document
אם הם שייכים לקטגוריה של משתמשים שיש להם
גישה כללית, למשל אם Document
משותף עם כל הדומיין של המשתמש, או אם Document
נמצא באחסון שיתופי שהמשתמש יכול לגשת אליו.
בקובצי Drive, המשתמש יוסר גם מרשימת הצופים.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
user | User | ייצוג של המשתמש שיש להסיר. |
החזרות
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeViewer(emailAddress)
מסיר את המשתמש הנתון מרשימת הצופים והמגיבים בDocument
. לשיטה הזו אין השפעה אם המשתמש הוא עורך, ולא צופה או מגיב. השיטה הזו גם לא חוסמת את הגישה של משתמשים ל-Document
אם הם שייכים לסוג של משתמשים שיש להם גישה כללית, למשל אם Document
משותף עם כל הדומיין של המשתמש, או אם Document
נמצא באחסון שיתופי שלמשתמש יש גישה אליו.
בקובצי Drive, המשתמש יוסר גם מרשימת העורכים.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
emailAddress | String | כתובת האימייל של המשתמש שיש להסיר. |
החזרות
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeViewer(user)
מסיר את המשתמש הנתון מרשימת הצופים והמגיבים בDocument
. לשיטה הזו אין השפעה אם המשתמש הוא עורך ולא צופה. השיטה הזו גם לא חוסמת
את הגישה של משתמשים ל-Document
אם הם שייכים לקטגוריה של משתמשים שיש להם
גישה כללית, למשל אם Document
משותף עם כל הדומיין של המשתמש, או אם ה-Document
נמצא באחסון שיתופי שלמשתמש יש גישה אליו.
בקובצי Drive, המשתמש יוסר גם מרשימת העורכים.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
user | User | ייצוג של המשתמש שיש להסיר. |
החזרות
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
saveAndClose()
שמירת הערך הנוכחי של Document
. גורם לביטול ולהחלה של עדכונים בהמתנה.
השיטה saveAndClose()
מופעלת באופן אוטומטי בסיום הביצוע של הסקריפט, בכל Document
שפתוחה לעריכה.
לא ניתן לערוך Document
שנסגר. באמצעות DocumentApp.openById()
אפשר לפתוח מחדש מסמך נתון לעריכה.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setCursor(position)
מגדיר את סמן המשתמש במסמך הפעיל, בהינתן Position
. סקריפט יכול לגשת רק לסמן של המשתמש שמריץ את הסקריפט, ורק אם הסקריפט מקושר למסמך.
// Append a paragraph, then place the user's cursor after the first word of the new paragraph. var doc = DocumentApp.getActiveDocument(); var paragraph = doc.getBody().appendParagraph('My new paragraph.'); var position = doc.newPosition(paragraph.getChild(0), 2); doc.setCursor(position);
פרמטרים
שם | תיאור | התיאור |
---|---|---|
position | Position | מיקום הסמן החדש |
החזרות
Document
— Document
, לשרשור
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setLanguage(languageCode)
מגדיר את קוד השפה של המסמך. זוהי השפה שמוצגת בקטע קובץ > שפה בעורך המסמך, וייתכן שאינה השפה שבה המסמך מכיל בפועל. יש להשתמש ב-getSupportedLanguageCodes()
כדי לקבל את כל קודי השפה החוקיים.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
languageCode | String | קוד השפה. |
החזרות
Document
– Document
, לשרשור.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setName(name)
setSelection(range)
מגדיר את בחירת המשתמש במסמך הפעיל, בהינתן Range
. סקריפט יכול לגשת רק לבחירת המשתמש שמפעיל את הסקריפט, ורק אם הסקריפט מקושר למסמך.
// Change the user's selection to a range that includes every table in the document. var doc = DocumentApp.getActiveDocument(); var rangeBuilder = doc.newRange(); var tables = doc.getBody().getTables(); for (var i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } doc.setSelection(rangeBuilder.build());
פרמטרים
שם | תיאור | התיאור |
---|---|---|
range | Range | את טווח הרכיבים החדש לבחירה |
החזרות
Document
— Document
, לשרשור
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents