Class Document

מסמך

מסמך שמכיל אובייקט אחד או יותר מסוג Tab, שכל אחד מהם מכיל טקסט עשיר וגם רכיבים כמו טבלאות ורשימות.

אפשר לפתוח או ליצור מסמכים באמצעות DocumentApp. 

// Open a document by ID.
var doc = DocumentApp.openById("<my-id>");

// Create and open a document.
doc = DocumentApp.create("Document Title");

שיטות במחלקה Document שמאפשרות לגשת לתוכן טקסט ולשנות אותן ישירות, פועלות לפי הכרטיסייה הפעילה (בסקריפטים המקושרים או על הכרטיסייה הראשונה (אם אין כרטיסייה פעילה). סקריפטים מסתמכים על אפשר להעביר את ה-methods האלה (לדוגמה, getBody()) לתמיכה בכרטיסיות באמצעות getTabs() ואז Tab.asDocumentTab().

שיטות

שיטהסוג הערך המוחזרתיאור קצר
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.
getActiveTab()Tabהפונקציה מקבלת את Tab שפעיל כרגע במסמך.
getAs(contentType)Blobאחזור של התוכן הנוכחי של Document כ-blob מהסוג שצוין.
getBlob()Blobאחזור של התוכן הנוכחי של Document כ-blob.
getBody()Bodyאחזור Body של הכרטיסייה הראשונה. עבור סקריפטים שמקושרים למסמך, המערכת מאחזרת את DocumentBodySection של הכרטיסייה הפעילה.
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.
getTab(tabId)Tabהפונקציה מקבלת את Tab עם המזהה שצוין.
getTabs()Tab[]הפונקציה מקבלת את כל הפריטים מסוג Tab שלא בתצוגת עץ, שהם חלק מהמסמך.
getUrl()Stringאחזור של כתובת ה-URL כדי לגשת למסמך הנוכחי.
getViewers()User[]הפונקציה מקבלת את רשימת הצופים והמגיבים של הDocument הזה.
newPosition(element, offset)Positionיוצר Position חדש, שהוא הפניה למיקום בכרטיסייה, ביחס בכרטיסייה הראשונה, או הכרטיסייה הפעילה, עבור סקריפטים שמקושרים למסמך.
newRange()RangeBuilderיצירת ה-builder שמשמש לבניית אובייקטים של Range מרכיבי כרטיסייה Tab הראשון או, עבור סקריפטים שמקושרים המסמך, הכרטיסייה הפעילה.
removeEditor(emailAddress)Documentהסרה של המשתמש הנתון מרשימת העורכים של Document.
removeEditor(user)Documentהסרה של המשתמש הנתון מרשימת העורכים של Document.
removeViewer(emailAddress)Documentהסרה של המשתמש הנתון מרשימת הצופים והמגיבים של Document.
removeViewer(user)Documentהסרה של המשתמש הנתון מרשימת הצופים והמגיבים של Document.
saveAndClose()voidשמירה של Document הנוכחי.
setActiveTab(tabId)voidמגדיר את Tab שנבחר על ידי המשתמש במסמך הנוכחי לכרטיסייה עם המזהה שצוין.
setCursor(position)Documentמגדיר את סמן המשתמש, בהינתן Position.
setLanguage(languageCode)Documentמגדיר את קוד השפה של המסמך.
setName(name)Documentמגדיר את כותרת המסמך.
setSelection(range)Documentמגדיר את בחירת המשתמש בכרטיסייה הפעילה, בהינתן Range.

מסמכי תיעוד מפורטים

addBookmark(position)

הפונקציה מוסיפה Bookmark ב-Position הנתון לכרטיסייה הראשונה, או, עבור סקריפטים מקושרים למסמך, הכרטיסייה הפעילה. כדי להוסיף להוסיף לסימניות בכל כרטיסייה, יש להשתמש בשיטה DocumentTab.addBookmark(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(DOCUMENT_ID);

// Gets the active or first tab's 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());

}

פרמטרים

שםסוגתיאור
positionPositionהמיקום של הסימנייה החדשה.

חזרה

Bookmark – הסימנייה החדשה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addEditor(emailAddress)

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

פרמטרים

שםסוגתיאור
emailAddressStringכתובת האימייל של המשתמש להוספה.

חזרה

Document – Document, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addEditor(user)

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

פרמטרים

שםסוגתיאור
userUserייצוג של המשתמש שצריך להוסיף.

חזרה

Document – Document, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addEditors(emailAddresses)

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

פרמטרים

שםסוגתיאור
emailAddressesString[]מערך כתובות אימייל של המשתמשים שרוצים להוסיף.

חזרה

Document – Document, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addFooter()

מוסיף קטע של כותרת תחתונה, אם לא קיים, לכרטיסייה הראשונה, או, לסקריפטים שמקושרים למסמך, הכרטיסייה הפעילה. כדי להוסיף כותרת תחתונה בכרטיסייה כלשהי, יש להשתמש בשיטה DocumentTab.addFooter(). 

// 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(DOCUMENT_ID);

// Adds a footer to the document's active or first tab.
const footer = doc.addFooter();

// Sets the footer text to 'This is a footer.'
footer.setText('This is a footer');

חזרה

FooterSection – הכותרת התחתונה של הכרטיסייה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addHeader()

מוסיף קטע כותרת, אם לא קיים, לכרטיסייה הראשונה, או לסקריפטים שמקושרים למסמך, הכרטיסייה הפעילה. כדי להוסיף כותרת בכרטיסייה כלשהי, יש להשתמש בשיטה DocumentTab.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(DOCUMENT_ID);

// Adds a header to the document's active or first tab.
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 שיש לו שם ומזהה לשימוש לאחזר מאוחר יותר, בכרטיסייה הראשונה, או את הכרטיסייה הפעילה, עבור סקריפטים שמקושרים למסמך. כדי להוסיף NamedRange בכל כרטיסייה, צריך להשתמש בשיטה DocumentTab.addNamedRange(name, range). השמות לא ייחודיות, כמה טווחים שונים באותו מסמך יכולים להשתמש באותו שם, כמו מחלקה ב-HTML. לעומת זאת, מזהים הם ייחודיים במסמך, כמו מזהה ב-HTML. אחרי שמוסיפים NamedRange למסמך, אי אפשר לשנות אותו, אלא רק להסיר אותו.

כל סקריפט שניגשים למסמך יכול לגשת אל NamedRange. כדי להימנע מכך בניגוד לסקריפטים, מומלץ להוסיף מחרוזת ייחודית לשמות של טווחים. 

// Creates a named range that includes every table in the active tab.
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]);
}
// Adds the named range to the document's active tab.
doc.addNamedRange('Document tables', rangeBuilder.build());

פרמטרים

שםסוגתיאור
nameStringהשם של הטווח, שלא חייב להיות ייחודי. שמות של טווחים חייבים להיות באורך של 1-256 תווים.
rangeRangeטווח הרכיבים שישויכו לשם; הטווח יכול להיות הבחירה הפעילה, תוצאת חיפוש או הטווח שנוצר באופן ידני באמצעות newRange().

חזרה

NamedRange — NamedRange.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addViewer(emailAddress)

הוספה של המשתמש הנתון לרשימת הצופים ב-Document. אם המשתמש כבר ברשימת העורכים, לשיטה הזו אין השפעה.

פרמטרים

שםסוגתיאור
emailAddressStringכתובת האימייל של המשתמש להוספה.

חזרה

Document – Document, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addViewer(user)

הוספה של המשתמש הנתון לרשימת הצופים ב-Document. אם המשתמש כבר ברשימת העורכים, לשיטה הזו אין השפעה.

פרמטרים

שםסוגתיאור
userUserייצוג של המשתמש שצריך להוסיף.

חזרה

Document – Document, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addViewers(emailAddresses)

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

פרמטרים

שםסוגתיאור
emailAddressesString[]מערך כתובות אימייל של המשתמשים שרוצים להוסיף.

חזרה

Document – Document, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getActiveTab()

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

// Display a dialog box that shows the title of the tab that the
// user is currently viewing.
const tab = DocumentApp.getActiveDocument().getActiveTab();
DocumentApp.getUi().alert('ID of selected tab: ' + tab.getTitle());

חזרה

Tab – Tab שפעיל כרגע, או null אם הסקריפט לא קשור אל את המסמך.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

  • 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(DOCUMENT_ID);

// 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());

פרמטרים

שםסוגתיאור
contentTypeStringסוג ה-MIME שאליו יש להמיר; המערכת תומכת ב-'application/pdf' וב-'text/markdown'.

חזרה

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(DOCUMENT_ID);

// Retrieves the current document's contents as a blob and logs it to the console.
console.log(doc.getBlob().getContentType());

חזרה

Blob – המסמך הנוכחי כ-blob.

getBody()

אחזור Body של הכרטיסייה הראשונה. עבור סקריפטים שמקושרים למסמך, המערכת מאחזרת את DocumentBodySection של הכרטיסייה הפעילה. כדי לקבל את DocumentBodySection של כרטיסייה כלשהי, יש להשתמש בשיטה DocumentTab.getBody().

כרטיסיות יכולות להכיל סוגים שונים של קטעים (לדוגמה, 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(DOCUMENT_ID);

// Gets the active or first tab's 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 עם המזהה הנתון בכרטיסייה הראשונה, או הכרטיסייה הפעילה עבור סקריפטים שמקושרים למסמך. כדי לקבל להוסיף לסימניות בכל כרטיסייה, יש להשתמש בשיטה DocumentTab.getBookmark(id). השיטה הזו מחזירה את הערך 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(DOCUMENT_ID);

// Gets the bookmark by its ID in the document's active or first tab.
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.');
}

פרמטרים

שםסוגתיאור
idStringהמזהה של Bookmark.

חזרה

Bookmark – Bookmark עם המזהה הנתון, או null אם לא Bookmark כזה קיים בכרטיסייה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getBookmarks()

הפונקציה מקבלת את כל Bookmark האובייקטים בכרטיסייה הראשונה, או את הכרטיסייה הפעילה של סקריפטים שמקושרים למסמך. כדי לקבל את כל ההטבות סימניות בכל כרטיסייה, יש להשתמש בשיטה DocumentTab.getBookmarks(). 

// 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(DOCUMENT_ID);

// Gets all of the bookmarks in the document's active or first tab.
const bookmarks = doc.getBookmarks();

// Logs the number of bookmarks in the tab 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()

קבלת רשימת העורכים של Document.

חזרה

User[] – מערך משתמשים עם הרשאת עריכה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getFooter()

אחזור הקטע הכותרת התחתונה של הכרטיסייה הראשונה, או עבור סקריפטים שמקושרים למסמך, הכותרת התחתונה של הכרטיסייה הפעילה . כדי להציג את הקטע 'כותרת תחתונה' של כרטיסייה כלשהי, צריך להשתמש בשיטה DocumentTab.getFooter(). 

// 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(DOCUMENT_ID);

// Gets the text of the active or first tab's footer and logs it to the console.
console.log(doc.getFooter().getText());

חזרה

FooterSection – הכותרת התחתונה של הכרטיסייה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getFootnotes()

אחזור כל רכיבי Footnote בגוף הכרטיסייה הראשונה, או, בסקריפטים שמקושרים למסמך, גוף הכרטיסייה הפעילה. כדי לקבל את כל הערות השוליים בכל כרטיסייה, יש להשתמש בשיטה DocumentTab.getFootnotes().

קריאות ל-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(DOCUMENT_ID);

// Gets the first footnote in the active or first tab's body.
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()

אחזור של קטע הכותרת של הכרטיסייה הראשונה, או עבור סקריפטים שמקושרים למסמך, הכותרת של הכרטיסייה הפעילה . כדי לקבל את קטע הכותרת של כרטיסייה כלשהי, צריך להשתמש בשיטה DocumentTab.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(DOCUMENT_ID);

// Gets the text of the active or first tab'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()

קבלת קוד השפה של המסמך. זוהי השפה שמוצגת בתפריט File (קובץ) של עורך המסמכים &gt; שפה, שאינה השפה שהמסמך מכיל בפועל.

חזרה

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 עם המזהה הנתון בכרטיסייה הראשונה, או הכרטיסייה הפעילה עבור סקריפטים שמקושרים למסמך. כדי לקבל את NamedRange עם המזהה הנתון בכל כרטיסייה, משתמשים בפונקציה DocumentTab.getNamedRangeById(id) . השיטה הזו מחזירה את הערך null אם לא קיים NamedRange כזה בכרטיסייה. שמות הן לא בהכרח ייחודיות, גם בין הכרטיסיות. כמה טווחים שונים באותה כרטיסייה משתפים את אותו השם, בדומה למחלקה ב-HTML. לעומת זאת, מזהים הם ייחודיים בכרטיסייה, כמו מזהה ב-HTML.

פרמטרים

שםסוגתיאור
idStringהמזהה של הטווח שהוא ייחודי בכרטיסייה.

חזרה

NamedRange – NamedRange עם המזהה הנתון, או null אם לא קיים טווח כזה הכרטיסייה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getNamedRanges()

הפונקציה מקבלת את כל NamedRange האובייקטים בכרטיסייה הראשונה, או את הכרטיסייה הפעילה של סקריפטים שמקושרים למסמך. כדי לקבל את כל ההטבות NamedRange אובייקטים בכל כרטיסייה, משתמשים ב-method DocumentTab.getNamedRanges().

אפשר לגשת אל NamedRange באמצעות כל סקריפט שניגשים לכרטיסייה. כדי להימנע התנגשויות לא מכוונות בין סקריפטים. כדאי להוסיף מחרוזת ייחודית לשמות של טווחים.

חזרה

NamedRange[] – מערך של האובייקטים NamedRange בכרטיסייה, כולל כמה אובייקטים טווחים בעלי שם זהה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getNamedRanges(name)

הפונקציה מקבלת את כל NamedRange האובייקטים עם השם הנתון בכרטיסייה הראשונה, או לסקריפטים מקושרים למסמך – הכרטיסייה הפעילה. כדי לקבל כל NamedRange האובייקטים בכל כרטיסייה, צריך להשתמש בשיטה DocumentTab.getNamedRanges(name). השמות לא בהכרח ייחודיים, גם בין הכרטיסיות. כמה טווחים שונים אותה כרטיסייה עשויה להיות בעלת אותו שם, בדומה למחלקה ב-HTML. לעומת זאת, מזהים הם ייחודיים בתוך הכרטיסייה, כמו מזהה ב-HTML.

ניתן לגשת אל NamedRange באמצעות כל סקריפט שניגש למסמך. כדי להימנע התנגשויות לא מכוונות בין סקריפטים. כדאי להוסיף מחרוזת ייחודית לשמות של טווחים.

פרמטרים

שםסוגתיאור
nameStringשם הטווח, שאינו בהכרח ייחודי.

חזרה

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

getTab(tabId)

הפונקציה מקבלת את Tab עם המזהה שצוין. השיטה הזו מחזירה את הערך null אם לא קיים Tab כזה. ניתן לגשת לכרטיסיות בכל רמת דירוג.

פרמטרים

שםסוגתיאור
tabIdStringהמזהה של הכרטיסייה שצריך לקבל.

חזרה

Tab – Tab עם המזהה שצוין, או null אם לא קיים Tab כזה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getTabs()

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

כרטיסיות יכולות להכיל כרטיסיות צאצא, כרטיסייה שבתוך כרטיסייה אחרת. יש גישה לכרטיסיות צאצא באמצעות Tab.getChildTabs().

חזרה

Tab[] – הרשימה של כל הפריטים מסוג Tab שהם חלק מהמסמך.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

  • 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 – כתובת ה-URL לגישה למסמך הנוכחי.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getViewers()

הפונקציה מקבלת את רשימת הצופים והמגיבים של הDocument הזה.

חזרה

User[] – מערך של משתמשים עם הרשאת צפייה או תגובה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

newPosition(element, offset)

יוצר Position חדש, שהוא הפניה למיקום בכרטיסייה, ביחס בכרטיסייה הראשונה, או הכרטיסייה הפעילה, עבור סקריפטים שמקושרים למסמך. כדי ליצור Position ביחס למיקום בכל כרטיסייה, יש להשתמש בפונקציה DocumentTab.newPosition(element, offset) . סמן המשתמש מיוצג כ-Position, בין שימושים נוספים. 

// Append a paragraph to the active tab, 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);

פרמטרים

שםסוגתיאור
elementElementהרכיב שצריך להכיל את הרכיב Position החדש; חייב להיות רכיב Text או רכיב קונטיינר כמו Paragraph.
offsetIntegerברכיבי Text, מספר התווים שלפני Position; של רכיבים אחרים, מספר רכיבי הצאצא לפני Position בתוך אותו רכיב קונטיינר.

חזרה

Position — Position החדש.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

newRange()

יצירת ה-builder שמשמש לבניית אובייקטים של Range מרכיבי כרטיסייה Tab הראשון או, עבור סקריפטים שמקושרים המסמך, הכרטיסייה הפעילה. כדי ליצור builder שמשמש לבניית אובייקטים של DocumentRange מרכיבי כרטיסייה בכל כרטיסייה, יש להשתמש בשיטה DocumentTab.newRange(). 

// Change the user's selection to a range that includes every table in the active tab.
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 – ה-builder החדש.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

removeEditor(emailAddress)

הסרה של המשתמש הנתון מרשימת העורכים של Document. בשיטה הזאת לא ניתן חסימת הגישה של משתמשים אל Document אם הם שייכים לקטגוריה של משתמשים גישה כללית – לדוגמה, אם ה-Document משותף עם כל המשתמשים בדומיין, או אם Document נמצא באחסון שיתופי שלמשתמש יש גישה אליו.

בקובצי Drive, המשתמש יוסר גם מרשימת הצופים.

פרמטרים

שםסוגתיאור
emailAddressStringכתובת האימייל של המשתמש להסרה.

חזרה

Document – Document, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

removeEditor(user)

הסרה של המשתמש הנתון מרשימת העורכים של Document. בשיטה הזאת לא ניתן חסימת הגישה של משתמשים אל Document אם הם שייכים לקטגוריה של משתמשים גישה כללית – לדוגמה, אם ה-Document משותף עם כל המשתמשים בדומיין, או אם Document נמצא באחסון שיתופי שלמשתמש יש גישה אליו.

בקובצי Drive, המשתמש יוסר גם מרשימת הצופים.

פרמטרים

שםסוגתיאור
userUserייצוג של המשתמש שצריך להסיר.

חזרה

Document – Document, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

removeViewer(emailAddress)

הסרה של המשתמש הנתון מרשימת הצופים והמגיבים של Document. הזה ל-method אין השפעה אם המשתמש הוא עורך, לא צופה או מגיב. השיטה הזאת גם לא חוסמת את הגישה של משתמשים אל Document אם הם שייכים לקטגוריה של משתמשים יש גישה כללית – לדוגמה, אם ה-Document משותף עם המשתמש בכל הדומיין, או אם הקובץ Document נמצא באחסון שיתופי שלמשתמש יש גישה אליו.

בקובצי Drive, המשתמש יוסר גם מרשימת העורכים.

פרמטרים

שםסוגתיאור
emailAddressStringכתובת האימייל של המשתמש להסרה.

חזרה

Document – ה-Document הזה לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

removeViewer(user)

הסרה של המשתמש הנתון מרשימת הצופים והמגיבים של Document. הזה ל-method אין השפעה אם המשתמש הוא עורך ולא צופה. השיטה הזו גם לא חוסמת למשתמשים לגשת אל Document אם הם שייכים לקטגוריה של משתמשים שיש להם גישה - לדוגמה, אם ה-Document משותף עם כל הדומיין של המשתמש, או אם הקובץ Document נמצא באחסון שיתופי שלמשתמש יש גישה אליו.

בקובצי Drive, המשתמש יוסר גם מרשימת העורכים.

פרמטרים

שםסוגתיאור
userUserייצוג של המשתמש שצריך להסיר.

חזרה

Document – ה-Document הזה לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

  • 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

setActiveTab(tabId)

מגדיר את Tab שנבחר על ידי המשתמש במסמך הנוכחי לכרטיסייה עם המזהה שצוין. 

const doc = DocumentApp.getActiveDocument()

// Sets the user's selected tab by its ID.
// TODO(developer): Replace the ID with your own.
const tab = doc.setActiveTab(TAB_ID);

פרמטרים

שםסוגתיאור
tabIdStringמזהה הכרטיסייה שרוצים להגדיר כפעילה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setCursor(position)

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

הוספה של Position מ-Tab לא פעיל תגרום להחלפת הכרטיסייה הפעילה של המשתמש. 

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();

// Append a paragraph, then place the user's cursor after the first word of the new paragraph.
var paragraph = documentTab.getBody().appendParagraph('My new paragraph.');
var position = documentTab.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

פרמטרים

שםסוגתיאור
positionPositionהמיקום החדש של הסמן.

חזרה

Document – Document, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setLanguage(languageCode)

מגדיר את קוד השפה של המסמך. זוהי השפה שמוצגת בתפריט File (קובץ) של עורך המסמכים &gt; שפה, שאינה השפה שהמסמך מכיל בפועל. יש להשתמש ב-getSupportedLanguageCodes() כדי לקבל את כל קודי השפה התקינים.

פרמטרים

שםסוגתיאור
languageCodeStringקוד השפה.

חזרה

Document – Document, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setName(name)

מגדיר את כותרת המסמך.

פרמטרים

שםסוגתיאור
nameStringהכותרת החדשה של המסמך.

חזרה

Document – המסמך הנוכחי.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setSelection(range)

מגדיר את בחירת המשתמש בכרטיסייה הפעילה, בהינתן Range. סקריפט יכול רק לגשת ולבחור במשתמש שהריץ את הסקריפט, ורק אם הסקריפט מקושר למסמך. 

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();

// Change the user's selection to a range that includes every table in the document.
var rangeBuilder = documentTab.newRange();
var tables = documentTab.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

פרמטרים

שםסוגתיאור
rangeRangeטווח הרכיבים החדש לבחירה.

חזרה

Document – Document, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents