דף זה תורגם על ידי Cloud Translation API.

Class Site

הוצא משימוש. המחלקה הזו הוצאה משימוש ואין להשתמש בה בסקריפטים חדשים.

אובייקט שמייצג אתר שנוצר באמצעות Google Sites.

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
`addEditor(emailAddress)`	`Site`	מוסיף את המשתמש הנתון לרשימת העורכים של `Site`.
`addEditor(user)`	`Site`	מוסיף את המשתמש הנתון לרשימת העורכים של `Site`.
`addEditors(emailAddresses)`	`Site`	מוסיף את מערך המשתמשים הנתון לרשימת העורכים של `Site`.
`addViewer(emailAddress)`	`Site`	מוסיף את המשתמש הנתון לרשימת הצופים ב`Site`.
`addViewer(user)`	`Site`	מוסיף את המשתמש הנתון לרשימת הצופים ב`Site`.
`addViewers(emailAddresses)`	`Site`	הוספה של מערך המשתמשים הנתון לרשימת הצופים של `Site`.
`getEditors()`	`User[]`	הפונקציה מקבלת את רשימת העורכים של `Site`.
`getViewers()`	`User[]`	הצגת רשימת הצופים והמגיבים ב`Site` הזה.
`removeEditor(emailAddress)`	`Site`	מסיר את המשתמש הנתון מרשימת העורכים של `Site`.
`removeEditor(user)`	`Site`	מסיר את המשתמש הנתון מרשימת העורכים של `Site`.
`removeViewer(emailAddress)`	`Site`	מסיר את המשתמש הנתון מרשימת הצופים והמגיבים ב`Site`.
`removeViewer(user)`	`Site`	מסיר את המשתמש הנתון מרשימת הצופים והמגיבים ב`Site`.

שיטות שהוצאו משימוש

שיטה	סוג הערך שמוחזר	תיאור קצר
`addCollaborator(email)`	`Site`	הוספת שותף עריכה חדש לאתר
`addCollaborator(user)`	`Site`	הוספת שותף עריכה חדש לאתר
`addOwner(email)`	`Site`	הוספת בעלים חדש לאתר
`addOwner(user)`	`Site`	הוספת בעלים חדש לאתר
`createAnnouncement(title, html, parent)`	`Page`	יצירת הודעה חדשה
`createAnnouncementsPage(title, name, html)`	`Page`	יצירת דף הודעות חדש.
`createComment(inReplyTo, html, parent)`	`Comment`	הוּצא משימוש.
`createFileCabinetPage(title, name, html)`	`Page`	יצירת דף חדש של ספריית קבצים.
`createListItem(html, columnNames, values, parent)`	`ListItem`	הוּצא משימוש.
`createListPage(title, name, html, columnNames)`	`Page`	יצירת דף רשימה חדש.
`createPageFromTemplate(title, name, template)`	`Page`	יצירת דף חדש מתבנית.
`createWebAttachment(title, url, parent)`	`Attachment`	הוּצא משימוש.
`createWebPage(title, name, html)`	`Page`	יצירת דף אינטרנט חדש.
`deleteSite()`	`void`	מחיקת האתר הזה.
`getAllDescendants()`	`Page[]`	הפונקציה מקבלת מערך של דפי צאצא (ישירים ועקיף), עד להגבלה של 200 דפים.
`getAllDescendants(options)`	`Page[]`	הפונקציה מקבלת מערך של דפי צאצא עם ארגומנטים מתקדמים אופציונליים.
`getAnnouncements()`	`Page[]`	מאחזר רשימת הודעות לאתר שנוצר באמצעות Google Sites.
`getAnnouncementsPages()`	`Page[]`	מאחזר רשימה של דפי הודעות עבור האתר הנתון ב-Google Sites.
`getAttachments()`	`Attachment[]`	מאחזר רשימה של קבצים מצורפים לאתר שנוצר באמצעות Google Sites.
`getChildByName(name)`	`Page`	הפונקציה מקבלת דף צאצא מסוים.
`getChildren()`	`Page[]`	מקבל מערך של דפי צאצא, עד 200 דפים.
`getChildren(options)`	`Page[]`	הפונקציה מקבלת מערך של דפי צאצא, עם ארגומנטים מתקדמים אופציונליים.
`getCollaborators()`	`User[]`	אחזור רשימת שותפי העריכה עבור האתר
`getComments()`	`Comment[]`	שולפת רשימת תגובות לאתר שנוצר באמצעות Google Sites.
`getFileCabinetPages()`	`Page[]`	אחזור של רשימת דפים של ספריית קבצים לאתר שנוצר באמצעות Google Sites.
`getListItems()`	`ListItem[]`	מאחזר רשימה של פריטים ברשימת אתרים לאתר שנוצר באמצעות Google Sites.
`getListPages()`	`Page[]`	מאחזר רשימה של דפי רשימת אתרים עבור אתר Google הנתון.
`getName()`	`String`	החזרת שם האתר
`getOwners()`	`User[]`	אחזור רשימת הבעלים של האתר
`getSelfLink()`	`String`	מאחזר את כתובת ה-URL של הפיד של האתר הזה.
`getSiteName()`	`String`	החזר את siteName של האתר
`getSummary()`	`String`	הצגת תקציר של האתר
`getTemplates()`	`Page[]`	הפונקציה מחזירה את כל דפי התבניות.
`getTheme()`	`String`	מקבל את העיצוב של האתר
`getTitle()`	`String`	החזרת כותרת האתר
`getUrl()`	`String`	מאחזר את כתובת ה-URL של האתר הזה.
`getWebAttachments()`	`Attachment[]`	מאחזר רשימה של קבצים מצורפים באינטרנט לאתר שנוצר באמצעות Google Sites.
`getWebPages()`	`Page[]`	מאחזר רשימה של דפי אינטרנט עבור האתר הנתון ב-Google Sites.
`removeCollaborator(email)`	`Site`	הסרת שותף עריכה מהאתר לפי כתובת האימייל של המשתמש
`removeCollaborator(user)`	`Site`	הסרת שותף עריכה מהאתר
`removeOwner(email)`	`Site`	הסרת בעלים מהאתר לפי כתובת האימייל של המשתמש
`removeOwner(user)`	`Site`	הסרת בעלים מהאתר
`search(query)`	`Page[]`	הפונקציה מקבלת מערך של דפי צאצא שתואמים לשאילתת חיפוש, עד 200 דפים.
`search(query, options)`	`Page[]`	הפונקציה מקבלת מערך של דפי צאצא שתואמים לשאילתת חיפוש, עם ארגומנטים מתקדמים אופציונליים.
`setSummary(summary)`	`Site`	הגדרת סיכום של האתר
`setTheme(theme)`	`Site`	מגדיר את העיצוב של האתר
`setTitle(title)`	`Site`	הגדרת כותרת האתר

תיעוד מפורט

`addEditor(emailAddress)`

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

פרמטרים

שם	תיאור	התיאור
`emailAddress`	`String`	כתובת האימייל של המשתמש שיש להוסיף.

החזרות

Site – Site, לשרשור.

הרשאות

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

https://sites.google.com/feeds

`addEditor(user)`

פרמטרים

שם	תיאור	התיאור
`user`	`User`	ייצוג של המשתמש להוספה.

החזרות

Site – Site, לשרשור.

הרשאות

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

https://sites.google.com/feeds

`addEditors(emailAddresses)`

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

פרמטרים

שם	תיאור	התיאור
`emailAddresses`	`String[]`	מערך של כתובות אימייל של המשתמשים להוספה.

החזרות

Site – Site, לשרשור.

הרשאות

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

https://sites.google.com/feeds

`addViewer(emailAddress)`

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

פרמטרים

שם	תיאור	התיאור
`emailAddress`	`String`	כתובת האימייל של המשתמש שיש להוסיף.

החזרות

Site – Site, לשרשור.

הרשאות

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

https://sites.google.com/feeds

`addViewer(user)`

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

פרמטרים

שם	תיאור	התיאור
`user`	`User`	ייצוג של המשתמש להוספה.

החזרות

Site – Site, לשרשור.

הרשאות

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

https://sites.google.com/feeds

`addViewers(emailAddresses)`

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

פרמטרים

שם	תיאור	התיאור
`emailAddresses`	`String[]`	מערך של כתובות אימייל של המשתמשים להוספה.

החזרות

Site – Site, לשרשור.

הרשאות

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

https://sites.google.com/feeds

`getEditors()`

הפונקציה מקבלת את רשימת העורכים של Site.

החזרות

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

הרשאות

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

https://sites.google.com/feeds

`getViewers()`

הצגת רשימת הצופים והמגיבים בSite הזה.

החזרות

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

הרשאות

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

https://sites.google.com/feeds

`removeEditor(emailAddress)`

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

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

פרמטרים

שם	תיאור	התיאור
`emailAddress`	`String`	כתובת האימייל של המשתמש שיש להסיר.

החזרות

Site – Site, לשרשור.

הרשאות

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

https://sites.google.com/feeds

`removeEditor(user)`

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

פרמטרים

שם	תיאור	התיאור
`user`	`User`	ייצוג של המשתמש שיש להסיר.

החזרות

Site – Site, לשרשור.

הרשאות

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

https://sites.google.com/feeds

`removeViewer(emailAddress)`

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

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

פרמטרים

שם	תיאור	התיאור
`emailAddress`	`String`	כתובת האימייל של המשתמש שיש להסיר.

החזרות

Site – Site לשרשור.

הרשאות

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

https://sites.google.com/feeds

`removeViewer(user)`

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

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

פרמטרים

שם	תיאור	התיאור
`user`	`User`	ייצוג של המשתמש שיש להסיר.

החזרות

Site – Site לשרשור.

הרשאות

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

https://sites.google.com/feeds

שיטות שהוצאו משימוש

`addCollaborator(email)`

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

הוספת שותף עריכה חדש לאתר

var site = SitesApp.getSite("example.com", "mysite");
site.addCollaborator("eric@example.com");

פרמטרים

שם	תיאור	התיאור
`email`	`String`	כתובת האימייל של המשתמש שיש להוסיף כשותף עריכה

החזרות

Site – האתר הזה לשרשורים

הרשאות

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

https://sites.google.com/feeds

`addCollaborator(user)`

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

הוספת שותף עריכה חדש לאתר

var site = SitesApp.getSite("example.com", "mysite");
var currentUser = Session.getActiveUser();
site.addCollaborator(currentUser);

פרמטרים

שם	תיאור	התיאור
`user`	`User`	המשתמש להוספה כשותף עריכה

החזרות

Site – האתר הזה לשרשורים

הרשאות

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

https://sites.google.com/feeds

`addOwner(email)`

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

הוספת בעלים חדש לאתר

var site = SitesApp.getSite("example.com", "mysite");
site.addOwner("eric@example.com");

פרמטרים

שם	תיאור	התיאור
`email`	`String`	כתובת האימייל של המשתמש שיש להוסיף כבעלים

החזרות

Site – האתר הזה לשרשורים

הרשאות

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

https://sites.google.com/feeds

`addOwner(user)`

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

הוספת בעלים חדש לאתר

var site = SitesApp.getSite("example.com", "mysite");
var currentUser = Session.getActiveUser();
site.addOwner(currentUser);

פרמטרים

שם	תיאור	התיאור
`user`	`User`	המשתמש שצריך להוסיף כבעלים

החזרות

Site – האתר הזה לשרשורים

הרשאות

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

https://sites.google.com/feeds

`createAnnouncement(title, html, parent)`

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

יצירת הודעה חדשה

פרמטרים

שם	תיאור	התיאור
`title`	`String`	כותרת של דף הודעות שצריך ליצור
`html`	`String`	גוף ה-HTML של הדף
`parent`	`Page`	דף ההורה

החזרות

Page – Page שנוצר

הרשאות

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

https://sites.google.com/feeds

`createAnnouncementsPage(title, name, html)`

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

יצירת דף הודעות חדש. הערה: אתר או דף הורה לא יכול להכיל יותר מ-500 דפי צאצא.

// This method can be called from both a Site instance
// as well as a Page instance
var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];

site.createAnnouncementsPage("New Announcement",
                             "new-announcement",
                             "<h1>Your announcement goes here</h1>");

page.createAnnouncementsPage("New Announcement",
                             "new-announcement-child",
                             "<h1>Your announcement goes here</h1>");

פרמטרים

שם	תיאור	התיאור
`title`	`String`	כותרת הדף
`name`	`String`	שם הדף
`html`	`String`	תוכן הדף

החזרות

Page – Page שנוצר לאחרונה

הרשאות

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

https://sites.google.com/feeds

`createComment(inReplyTo, html, parent)`

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

הוּצא משימוש. הוחלפה באפשרות 'יצירת תגובה' בתאריך Page.

יצירת תגובה חדשה.

פרמטרים

שם	תיאור	התיאור
`inReplyTo`	`String`	כתובת URL של פיד GData - חסרת משמעות ושבורה
`html`	`String`	תוכן התגובה
`parent`	`Page`	ההורה שהתגובות מופיעות בו

החזרות

Comment – Comment שנוצר לאחרונה

הרשאות

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

https://sites.google.com/feeds

`createFileCabinetPage(title, name, html)`

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

יצירת דף חדש של ספריית קבצים. הערה: אתר או דף הורה לא יכול להכיל יותר מ-500 דפי צאצא.

// This method can be called from either a site or a page.
var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];

site.createFileCabinetPage("New File Cabinet",
                           "new-file-cabinet",
                           "<h1>Your HTML here</h1>");

page.createFileCabinetPage("New File Cabinet",
                             "new-file-cabinet-child",
                             "<h1>Your HTML here</h1>");

פרמטרים

שם	תיאור	התיאור
`title`	`String`	כותרת הדף
`name`	`String`	שם הדף
`html`	`String`	תוכן הדף

החזרות

Page – Page שנוצר לאחרונה

הרשאות

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

https://sites.google.com/feeds

`createListItem(html, columnNames, values, parent)`

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

הוּצא משימוש. הוחלף על ידי createListItem בתאריך Page.

יצירת ListItem חדש.

פרמטרים

שם	תיאור	התיאור
`html`	`String`	תוכן הפריט - חסר משמעות ושבור.
`columnNames`	`String[]`	שמות של עמודות, שלא נחוצים
`values`	`String[]`	ערכי העמודה
`parent`	`Page`	ההורה ListPage

החזרות

ListItem – ListItem לשרשור.

הרשאות

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

https://sites.google.com/feeds

`createListPage(title, name, html, columnNames)`

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

יצירת דף רשימה חדש. הערה: אתר או דף הורה לא יכול להכיל יותר מ-500 דפי צאצא.

// This method can be called from either a site or a page.
var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];

site.createListPage("New List Page",
                    "new-list-page",
                    "<h1>Your List Page HTML here</h1>",
                    [ "col1", "col2" ]);

page.createListPage("New List Page",
                    "new-list-page-child",
                    "<h1>Your List Page HTML here</h1>",
                    [ "col1", "col2" ]);

פרמטרים

שם	תיאור	התיאור
`title`	`String`	כותרת הדף
`name`	`String`	שם הדף
`html`	`String`	תוכן הדף
`columnNames`	`String[]`	שמות העמודות שבהן נעשה שימוש ברשימה

החזרות

Page – Page שנוצר לאחרונה

הרשאות

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

https://sites.google.com/feeds

`createPageFromTemplate(title, name, template)`

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

יצירת דף חדש מתבנית. הערה: אתר או דף הורה לא יכול להכיל יותר מ-500 דפי צאצא.

// This method can be called from either a site or a page.
var site = SitesApp.getSite("example.com", "mysite");
var template = site.getTemplates()[0];

// If an invalid template is passed, this will throw an "Invalid Argument" error.
site.createPageFromTemplate("ClonedPage", "cloned-page", template);

פרמטרים

שם	תיאור	התיאור
`title`	`String`	כותרת הדף
`name`	`String`	שם הדף
`template`	`Page`	דף התבנית

החזרות

Page – Page שנוצר לאחרונה

הרשאות

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

https://sites.google.com/feeds

`createWebAttachment(title, url, parent)`

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

הוּצא משימוש. הוחלף על ידי createWebAttachment בתאריך Page.

יצירת קובץ מצורף חדש באינטרנט.

פרמטרים

שם	תיאור	התיאור
`title`	`String`	הכותרת של הקובץ המצורף
`url`	`String`	כתובת ה-URL של הקובץ המצורף
`parent`	`Page`	דף ההורה

החזרות

Attachment – הקובץ המצורף לשרשור.

הרשאות

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

https://sites.google.com/feeds

`createWebPage(title, name, html)`

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

יצירת דף אינטרנט חדש. הערה: אתר או דף הורה לא יכול להכיל יותר מ-500 דפי צאצא.

// This method can be called from either a site or a page.
var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];

site.createAnnouncementsPage("New Announcement",
                             "new-announcement",
                             "<h1>Your announcement goes here</h1>");

page.createAnnouncementsPage("New Announcement",
                             "new-announcement-child",
                             "<h1>Your announcement goes here</h1>");

פרמטרים

שם	תיאור	התיאור
`title`	`String`	כותרת הדף
`name`	`String`	שם הדף
`html`	`String`	תוכן הדף

החזרות

Page – Page שנוצר לאחרונה

הרשאות

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

https://sites.google.com/feeds

`deleteSite()`

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

מחיקת האתר הזה.

var site = SitesApp.getSite('example.com', 'mysite');
site.deleteSite();

הרשאות

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

https://sites.google.com/feeds

`getAllDescendants()`

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

הפונקציה מקבלת מערך של דפי צאצא (ישירים ועקיף), עד להגבלה של 200 דפים.

var site = SitesApp.getSite("example.com", "mysite");
var pages = site.getAllDescendants();

החזרות

Page[] – מערך של דפי צאצא ישירים ועקיפים

הרשאות

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

https://sites.google.com/feeds

`getAllDescendants(options)`

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

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

var site = SitesApp.getSite("example.com", "mysite");
var descendants = site.getAllDescendants({
  type: SitesApp.PageType.WEB_PAGE,
  start: 0,
  max: 25,
  includeDrafts: false,
  includeDeleted: true,
  search: "target"
});

for(var i in descendants) {
  Logger.log(descendants[i].getName());
}

פרמטרים

שם	תיאור	התיאור
`options`	`Object`	שדות אובייקט JavaScript המוגדרים בקטע 'ארגומנטים מתקדמים' למטה

פרמטרים מתקדמים

שם	תיאור	התיאור
`type`	`PageType[]`	מקבלים רק דפים מהסוג הזה
`start`	`Integer`	התחל את התוצאות כאן
`max`	`Integer`	מספר התוצאות המקסימלי (ברירת מחדל 200)
`includeDrafts`	`Boolean`	האם לכלול דפי טיוטות (ברירת המחדל היא False)
`includeDeleted`	`Boolean`	האם לכלול דפים שנמחקו (ברירת המחדל היא False)
`search`	`String`	מחזירים רק דפים שתואמים לשאילתה הזו

החזרות

Page[] – מערך של דפי צאצא ישירים ועקיפים מהסוג הנתון

הרשאות

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

https://sites.google.com/feeds

`getAnnouncements()`

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

מאחזר רשימת הודעות לאתר שנוצר באמצעות Google Sites.

var site = SitesApp.getSite("example.com", "mysite");

var pages = site.getAnnouncements();
for(var i in pages) {
  Logger.log(pages[i].getTitle());
}

החזרות

Page[] – מערך של מופעי @link Page} להודעות

הרשאות

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

https://sites.google.com/feeds

`getAnnouncementsPages()`

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

מאחזר רשימה של דפי הודעות עבור האתר הנתון ב-Google Sites.

var site = SitesApp.getSite("example.com", "mysite");

var pages = site.getAnnouncementsPages();
for(var i in pages) {
  Logger.log(pages[i].getTitle());
}

החזרות

Page[] – מערך של Page מופעים

הרשאות

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

https://sites.google.com/feeds

`getAttachments()`

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

מאחזר רשימה של קבצים מצורפים לאתר שנוצר באמצעות Google Sites.

var site = SitesApp.getSite("example.com", "mysite");

var attachments = site.getAttachments();
for(var i in attachments) {
  // Only hosted attachments have content types
  Logger.log(attachments[i].getContentType());
}

החזרות

Attachment[] – מערך של Attachment מופעים

הרשאות

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

https://sites.google.com/feeds

`getChildByName(name)`

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

הפונקציה מקבלת דף צאצא מסוים.

var site = SitesApp.getSite("example.com", "mysite");
var pages = site.getChildByName("childPage");

פרמטרים

שם	תיאור	התיאור
`name`	`String`	שם דף הצאצא

החזרות

Page - דף הצאצא

הרשאות

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

https://sites.google.com/feeds

`getChildren()`

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

מקבל מערך של דפי צאצא, עד 200 דפים.

var site = SitesApp.getSite("example.com", "mysite");
var pages = site.getChildren();

החזרות

Page[] – מערך של דפי צאצא ישירים

הרשאות

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

https://sites.google.com/feeds

`getChildren(options)`

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

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

var site = SitesApp.getSite("example.com", "mysite");
var childPages = site.getChildren({
  type: SitesApp.PageType.WEB_PAGE,
  start: 0,
  max: 25,
  includeDrafts: false,
  includeDeleted: true,
  search: "target"
});

for(var i in childPages) {
  Logger.log(childPages[i].getName());
}

פרמטרים

שם	תיאור	התיאור
`options`	`Object`	שדות אובייקט JavaScript המוגדרים בקטע 'ארגומנטים מתקדמים' למטה

פרמטרים מתקדמים

שם	תיאור	התיאור
`type`	`PageType[]`	מקבלים רק דפים מהסוג הזה
`start`	`Integer`	התחל את התוצאות כאן
`max`	`Integer`	מספר התוצאות המקסימלי (ברירת מחדל 200)
`includeDrafts`	`Boolean`	האם לכלול דפי טיוטות (ברירת המחדל היא False)
`includeDeleted`	`Boolean`	האם לכלול דפים שנמחקו (ברירת המחדל היא False)
`search`	`String`	מחזירים רק דפים שתואמים לשאילתה הזו

החזרות

Page[] – מערך של דפי צאצא ישירים מהסוג הנתון

הרשאות

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

https://sites.google.com/feeds

`getCollaborators()`

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

אחזור רשימת שותפי העריכה עבור האתר

var collaborators = SitesApp.getSite('example.com', 'mysite').getCollaborators();
for(var i in collaborators) {
  Logger.log(collaborators[i].getEmail())
}

החזרות

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

הרשאות

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

https://sites.google.com/feeds

`getComments()`

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

שולפת רשימת תגובות לאתר שנוצר באמצעות Google Sites.

var site = SitesApp.getSite("example.com", "mysite");

var comments = site.getComments();
for(var i in comments) {
  Logger.log(comments[i].getContent());
}

החזרות

Comment[] – מערך של Comment מופעים

הרשאות

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

https://sites.google.com/feeds

`getFileCabinetPages()`

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

אחזור של רשימת דפים של ספריית קבצים לאתר שנוצר באמצעות Google Sites.

var site = SitesApp.getSite("example.com", "mysite");

var pages = site.getFileCabinetPages();
for(var i in pages) {
  Logger.log(pages[i].getTitle());
}

החזרות

Page[] – מערך של Page מופעים

הרשאות

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

https://sites.google.com/feeds

`getListItems()`

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

מאחזר רשימה של פריטים ברשימת אתרים לאתר שנוצר באמצעות Google Sites.

var site = SitesApp.getSite("example.com", "mysite");

var listItems = site.getListItems();
for(var i in listItems) {
  Logger.log(listItems[i].getLastUpdated());
}

החזרות

ListItem[] – מערך של ListItem מופעים

הרשאות

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

https://sites.google.com/feeds

`getListPages()`

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

מאחזר רשימה של דפי רשימת אתרים עבור אתר Google הנתון.

var site = SitesApp.getSite("example.com", "mysite");

var pages = site.getListPages();
for(var i in pages) {
  Logger.log(pages[i].getTitle());
}

החזרות

Page[] – מערך של Page מופעים

הרשאות

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

https://sites.google.com/feeds

`getName()`

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

החזרת שם האתר

var name = SitesApp.getSite('example.com', 'mysite').getName();

החזרות

String – שם המופע של האתר הזה

הרשאות

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

https://sites.google.com/feeds

`getOwners()`

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

אחזור רשימת הבעלים של האתר

var owners = SitesApp.getSite('example.com', 'mysite').getOwners();
for(var i in owners) {
  Logger.log(owners[i].getEmail())
}

החזרות

User[] – מערך שמכיל User מופעים שמייצגים בעלים

הרשאות

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

https://sites.google.com/feeds

`getSelfLink()`

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

מאחזר את כתובת ה-URL של הפיד של האתר הזה.

var site = SitesApp.getSite('example.com', 'mysite');
var url = site.getSelfLink();

החזרות

String – כתובת ה-URL של פיד האתר

הרשאות

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

https://sites.google.com/feeds

`getSiteName()`

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

החזר את siteName של האתר

var site = SitesApp.getSite('example.com', 'mysite');
var url = site.getSelfLink();

החזרות

String - שם האתר (siteName)

הרשאות

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

https://sites.google.com/feeds

`getSummary()`

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

הצגת תקציר של האתר

var summary = SitesApp.getSite('example.com', 'mysite').getSummary();

החזרות

String – סיכום של האתר הזה

הרשאות

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

https://sites.google.com/feeds

`getTemplates()`

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

הפונקציה מחזירה את כל דפי התבניות.

var templates = SitesApp.getSite('example.com', 'mysite').getTemplates();
for(var i in templates) {
  Logger.log(templates[i].getName())
}

החזרות

Page[] – מערך שמכיל Page מופעים שמייצגים תבניות

הרשאות

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

https://sites.google.com/feeds

`getTheme()`

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

מקבל את העיצוב של האתר

var theme = SitesApp.getSite('example.com', 'mysite').getTheme();

החזרות

String – העיצוב של האתר

הרשאות

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

https://sites.google.com/feeds

`getTitle()`

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

החזרת כותרת האתר

var title = SitesApp.getSite('example.com', 'mysite').getTitle();

החזרות

String - הכותרת של האתר הזה

הרשאות

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

https://sites.google.com/feeds

`getUrl()`

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

מאחזר את כתובת ה-URL של האתר הזה.

var url = SitesApp.getSite('example.com', 'mysite').getUrl();

החזרות

String – כתובת ה-URL של מופע האתר הזה

הרשאות

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

https://sites.google.com/feeds

`getWebAttachments()`

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

מאחזר רשימה של קבצים מצורפים באינטרנט לאתר שנוצר באמצעות Google Sites.

var site = SitesApp.getSite("example.com", "mysite");

var attachments = site.getWebAttachments();
for(var i in attachments) {
  // Only web attachments have URLs
  Logger.log(attachments[i].getUrl());
}

החזרות

Attachment[] – מערך של Attachment מופעים

הרשאות

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

https://sites.google.com/feeds

`getWebPages()`

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

מאחזר רשימה של דפי אינטרנט עבור האתר הנתון ב-Google Sites.

var site = SitesApp.getSite("example.com", "mysite");

var pages = site.getWebPages();
for(var i in pages) {
  Logger.log(pages[i].getTitle());
}

החזרות

Page[] – מערך של Page מופעים

הרשאות

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

https://sites.google.com/feeds

`removeCollaborator(email)`

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

הסרת שותף עריכה מהאתר לפי כתובת האימייל של המשתמש

// This snippet removes the user with the given email from the collaborators list
var site = SitesApp.getSite('example.com', 'mysite');
site.removeCollaborator("eric@example.com");

פרמטרים

שם	תיאור	התיאור
`email`	`String`	כתובת האימייל של המשתמש שיש להסיר משותפי העריכה

החזרות

Site – מופע האתר לשרשור ה-method

הרשאות

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

https://sites.google.com/feeds

`removeCollaborator(user)`

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

הסרת שותף עריכה מהאתר

// This snippet removes the current user from the list of collaborators
var site = SitesApp.getSite('example.com', 'mysite');
site.removeCollaborator(Session.getActiveUser());

פרמטרים

שם	תיאור	התיאור
`user`	`User`	משתמש להסרה מרשימת שותפי העריכה

החזרות

Site – מופע האתר לשרשור ה-method

הרשאות

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

https://sites.google.com/feeds

`removeOwner(email)`

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

הסרת בעלים מהאתר לפי כתובת האימייל של המשתמש

// This snippet removes the user with the given email from the owners list
var site = SitesApp.getSite('example.com', 'mysite');
site.removeOwner("eric@example.com");

פרמטרים

שם	תיאור	התיאור
`email`	`String`	כתובת האימייל של המשתמש שיש להסיר מהבעלים

החזרות

Site – מופע האתר לשרשור ה-method

הרשאות

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

https://sites.google.com/feeds

`removeOwner(user)`

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

הסרת בעלים מהאתר

// This snippet removes the current user from the list of owners
var site = SitesApp.getSite('example.com', 'mysite');
site.removeOwner(Session.getActiveUser());

פרמטרים

שם	תיאור	התיאור
`user`	`User`	משתמש שיש להסיר מרשימת הבעלים

החזרות

Site – מופע האתר לשרשור ה-method

הרשאות

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

https://sites.google.com/feeds

`search(query)`

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

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

var site = SitesApp.getSite("example.com", "mysite");
var matches = site.search("targetText");

for(var i in matches) {
  Logger.log(matches[i].getName());
}

פרמטרים

שם	תיאור	התיאור
`query`	`String`	את שאילתת החיפוש בטקסט המלא להתאמה

החזרות

Page[] – מערך של דפי צאצא ישירים ועקיפים מהסוג הנתון

הרשאות

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

https://sites.google.com/feeds

`search(query, options)`

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

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

var site = SitesApp.getSite("example.com", "mysite");
var childPages = site.getChildren({
  type: SitesApp.PageType.WEB_PAGE,
  start: 0,
  max: 25,
  includeDrafts: false,
  includeDeleted: true,
  search: "target"
});

for(var i in childPages) {
  Logger.log(childPages[i].getName());
}

פרמטרים

שם	תיאור	התיאור
`query`	`String`	את שאילתת החיפוש בטקסט המלא להתאמה
`options`	`Object`	שדות אובייקט JavaScript המוגדרים בקטע 'ארגומנטים מתקדמים' למטה

פרמטרים מתקדמים

שם	תיאור	התיאור
`type`	`PageType[]`	מקבלים רק דפים מהסוג הזה
`start`	`Integer`	התחל את התוצאות כאן
`max`	`Integer`	מספר התוצאות המקסימלי (ברירת מחדל 200)
`includeDrafts`	`Boolean`	האם לכלול דפי טיוטות (ברירת המחדל היא False)
`includeDeleted`	`Boolean`	האם לכלול דפים שנמחקו (ברירת המחדל היא False)

החזרות

Page[] – מערך של דפי צאצא ישירים ועקיפים מהסוג הנתון

הרשאות

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

https://sites.google.com/feeds

`setSummary(summary)`

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

הגדרת סיכום של האתר

var site = SitesApp.getSite("example.com", "mysite");
// All of the setter methods return the site instance so setters
// can be chained
site.setTitle("My Site")
    .setSummary("This is my site")
    .setTheme("simple");

פרמטרים

שם	תיאור	התיאור
`summary`	`String`	סיכום מחרוזת שמתאר את האתר

החזרות

Site – האתר לשרשור שיטות

הרשאות

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

https://sites.google.com/feeds

`setTheme(theme)`

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

מגדיר את העיצוב של האתר

העיצוב חייב להיות מחרוזת עיצוב חוקית. כדי לקבל את הרשימה המלאה, כותבים שיטת בדיקה ומעבירים ערך לא תקין ל-setTheme(). הסקריפט יגרום לשגיאה בשירות ויחזיר רשימה מקיפה של העיצובים הזמינים. רשימת העיצובים זמינה גם בקטע 'ניהול אתר' > 'עיצובים'. מחרוזות של שמות עיצובים בדרך כלל זהות לשם העיצוב בדף 'עיצובים' באותיות קטנות, עם רווחים ותווים מיוחדים. לדוגמה, המחרוזת של "Terra: Water" תהיה "terrawater".

var site = SitesApp.getSite("example.com", "mysite");
// All of the setter methods return the site instance so setters
// can be chained
site.setTitle("My Site")
    .setSummary("This is my site")
    .setTheme("simple");

פרמטרים

שם	תיאור	התיאור
`theme`	`String`	שם מחרוזת לעיצוב שיוגדר עבור `Site`

החזרות

Site – האתר לשרשור שיטות

הרשאות

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

https://sites.google.com/feeds

`setTitle(title)`

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

הגדרת כותרת האתר

var site = SitesApp.getSite("example.com", "mysite");
// All of the setter methods return the site instance so setters
// can be chained
site.setTitle("My Site")
    .setSummary("This is my site")
    .setTheme("simple");

פרמטרים

שם	תיאור	התיאור
`title`	`String`	השם החדש של האתר

החזרות

Site – האתר לשרשור שיטות

הרשאות

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

https://sites.google.com/feeds