Class SitesApp

SitesApp

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

ליצור אתרים באמצעות Google Sites ולגשת אליהם.

מאפיינים שהוצאו משימוש

נכס	תיאור	התיאור
AttachmentType	AttachmentType
PageType	PageType

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

שיטה	סוג הערך שמוחזר	תיאור קצר
copySite(domain, name, title, summary, site)	Site	יצירת אתר חדש על ידי העתקת אתר קיים.
createSite(domain, name, title, summary)	Site	יצירת אתר חדש.
getActivePage()	Page	מחזירה את הדף הפעיל, אם הסקריפט מתארח במאגר או null אחרת.
getActiveSite()	Site	מחזירה את הקונטיינר הפעיל, אם הסקריפט מתארח במאגר, או null.
getAllSites(domain)	Site[]	מאחזר את 200 האתרים הראשונים ששייכים לדומיין הזה.
getAllSites(domain, start, max)	Site[]	אחזור של כל האתרים ששייכים לדומיין הזה.
getPageByUrl(url)	Page	מאחזר דף לפי כתובת אתר.
getSite(name)	Site	מאחזר אתר עבור האתר הנתון שנוצר באמצעות Google Sites, אם המשתמש הוא צרכן שאין לו דומיין מתארח.
getSite(domain, name)	Site	אחזור אתר לאתר שנוצר באמצעות Google Sites.
getSiteByUrl(url)	Site	אחזור של אתר לפי כתובת URL.
getSites()	Site[]	מאחזר את הדף הראשון של משתמש ב-Google Sites, אם המשתמש הוא צרכן שאין לו דומיין מתארח.
getSites(start, max)	Site[]	אחזור של Google Sites עבור משתמש בין הגבולות הנקובים, אם המשתמש הוא צרכן שאין לו דומיין מתארח.
getSites(domain)	Site[]	אחזור של הדף הראשון ב-Google Sites ששייך למשתמש הזה בדומיין.
getSites(domain, start, max)	Site[]	מאחזר את כל האתרים ששייכים למשתמש הזה בדומיין הזה בטווח הנתון.

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

copySite(domain, name, title, summary, site)

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

יצירת אתר חדש על ידי העתקת אתר קיים.

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

// This creates a site. Note that this only works for Google Workspace domains.
// There is no version of this API for consumer accounts.
var site = SitesApp.createSite("examplepetstore.com",
                               "homepage",
                               "My Home Page",
                               "This is a new site I created!");

var siteCopy = SitesApp.copySite("examplepetstore.com",
                                 "homepage-clone",
                                 "Cloned Home Page",
                                 "Begun, these clone wars have.",
                                 site);

פרמטרים

שם	תיאור	התיאור
domain	String	הדומיין המתארח ב-Google Workspace, למשל examplepetstore.com.
name	String	שם מרחב האינטרנט שנמצא בכתובת ה-URL, למשל mySite.
title	String	שם האתר
summary	String	תיאור האתר
site	Site	האתר שממנו רוצים להעתיק. זה יכול להיות אתר או תבנית. אם הפרמטר הוא אתר קיים, כל התוכן של האתר יועתק. אם האתר הנתון הוא תבנית, נוצר אתר חדש על סמך התבנית הזו.

החזרות

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

הרשאות

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

• https://sites.google.com/feeds

---

createSite(domain, name, title, summary)

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

יצירת אתר חדש.

// This creates a site. Note that this only works for Google Workspace domains.
// There is no version of this API for consumer accounts.
var site = SitesApp.createSite("examplepetstore.com",
                               "homepage",
                               "My Home Page",
                               "This is a new site I created!");

פרמטרים

שם	תיאור	התיאור
domain	String	הדומיין המתארח ב-Google Workspace, למשל examplepetstore.com.
name	String	שם הנתיב שמופיע בכתובת ה-URL. למשל: mySite.
title	String	שם האתר.
summary	String	תיאור האתר.

החזרות

Site - האתר שנוצר.

הרשאות

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

• https://sites.google.com/feeds

---

getActivePage()

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

מחזירה את הדף הפעיל, אם הסקריפט מתארח במאגר או null אחרת.

var site = SitesApp.getActivePage();

החזרות

Page - המאגר הפעיל אם הוא דף אתרים.

הרשאות

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

• https://sites.google.com/feeds

---

getActiveSite()

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

מחזירה את הקונטיינר הפעיל, אם הסקריפט מתארח במאגר, או null.

var site = SitesApp.getActiveSite();

החזרות

Site - המאגר הפעיל אם מדובר באתר.

הרשאות

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

• https://sites.google.com/feeds

---

getAllSites(domain)

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

מאחזר את 200 האתרים הראשונים ששייכים לדומיין הזה. כדי לקבל את כל האתרים, יש להשתמש בשיטה getAllSites(domain, start, max) כדי לדפדף בתוצאות.

// This writes the first page of sites belonging to a Google Workspace
// domain to the log.
var sites = SitesApp.getAllSites("examplepetstore.com.");
for(var i in sites) {
  Logger.log(sites[i].getUrl());
}

פרמטרים

שם	תיאור	התיאור
domain	String	הדומיין המתארח ב-Google Workspace, למשל examplepetstore.com.

החזרות

Site[] - מערך של אתרים ששייכים לדומיין.

הרשאות

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

• https://sites.google.com/feeds

---

getAllSites(domain, start, max)

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

אחזור של כל האתרים ששייכים לדומיין הזה.

// This writes the a list of sites in domain example.com to the log.
var pageStart = 0;
var pageSize = 50;
while (true) {
  Logger.log("Loading sites starting at %s", pageStart);
  var sites = SitesApp.getAllSites("examplepetstore.com", pageStart, pageSize);
  if (sites.length == 0) {
    break;
  }
  Logger.log("Got %s sites back", sites.length);
  pageStart += sites.length;
  for(var i in sites) {
    Logger.log("Found site: %s", sites[i].getUrl());
  }
}

פרמטרים

שם	תיאור	התיאור
domain	String	הדומיין המתארח ב-Google Workspace, למשל examplepetstore.com.
start	Integer	האינדקס של האתר הראשון שמוחזר.
max	Integer	המספר המקסימלי של תוצאות שיש להחזיר.

החזרות

Site[] - מערך של אתרים ששייכים לדומיין.

הרשאות

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

• https://sites.google.com/feeds

---

getPageByUrl(url)

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

מאחזר דף לפי כתובת אתר.

// This snippet retrieves the page at the given URL.
// Returns null if the page does not exist or if the URL given is invalid.
var page = SitesApp.getPageByUrl(
                    "https://sites.google.com/site/demositeappsscript/mylistpage");
Logger.log(page.getName());

פרמטרים

שם	תיאור	התיאור
url	String	כתובת ה-URL הציבורית.

החזרות

Page - מופע של Page שתואם לדף שבכתובת ה-URL, או ב-null אם הדף לא קיים.

הרשאות

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

• https://sites.google.com/feeds

---

getSite(name)

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

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

// Returns a Site instance
var site = SitesApp.getSite('mysite');

פרמטרים

שם	תיאור	התיאור
name	String	שם מרחב האינטרנט שנמצא בכתובת ה-URL, למשל mySite.

החזרות

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

הרשאות

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

• https://sites.google.com/feeds

---

getSite(domain, name)

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

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

// Returns a Site instance
var site = SitesApp.getSite('example.com', 'mysite');

פרמטרים

שם	תיאור	התיאור
domain	String	הדומיין המתארח ב-Google Workspace, למשל examplepetstore.com.
name	String	שם מרחב האינטרנט שנמצא בכתובת ה-URL, למשל mySite.

החזרות

Site – מופע של אתר שתואם לדומיין מתארח.

הרשאות

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

• https://sites.google.com/feeds

---

getSiteByUrl(url)

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

אחזור של אתר לפי כתובת URL.

// This snippet retrieves the site at the given URL
// Throws an Invalid argument exception if the site does not exist or if
// the URL given is invalid
var site = SitesApp.getSiteByUrl("https://sites.google.com/site/demosite");
Logger.log(site.getName());

פרמטרים

שם	תיאור	התיאור
url	String	כתובת ה-URL הציבורית.

החזרות

Site - אתר שנמצא בכתובת ה-URL הנתונה.

הרשאות

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

• https://sites.google.com/feeds

---

getSites()

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

מאחזר את הדף הראשון של משתמש ב-Google Sites, אם המשתמש הוא צרכן שאין לו דומיין מתארח.

// This writes the first page of sites owned by the user running
// the script to the log.
var sites = SitesApp.getSites();
for(var i in sites) {
  Logger.log(sites[i].getUrl());
}

החזרות

Site[] - מערך של אתרים השייכים למשתמש שמריץ את הסקריפט.

הרשאות

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

• https://sites.google.com/feeds

---

getSites(start, max)

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

אחזור של Google Sites עבור משתמש בין הגבולות הנקובים, אם המשתמש הוא צרכן שאין לו דומיין מתארח.

var sites = SitesApp.getSites(25, 50);
for(var i in sites) {
  Logger.log(sites[i].getUrl());
}

פרמטרים

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

החזרות

Site[] - מערך של כל האתרים שבבעלות המשתמש.

הרשאות

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

• https://sites.google.com/feeds

---

getSites(domain)

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

אחזור של הדף הראשון ב-Google Sites ששייך למשתמש הזה בדומיין.

// This writes the first page of sites owned by the user running
// the script to the log.
var sites = SitesApp.getSites("example.com");
for(var i in sites) {
  Logger.log(sites[i].getUrl());
}

פרמטרים

שם	תיאור	התיאור
domain	String	הדומיין המתארח ב-Google Workspace, למשל examplepetstore.com.

החזרות

Site[] - מערך של אתרים השייכים למשתמש שמריץ את הסקריפט.

הרשאות

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

• https://sites.google.com/feeds

---

getSites(domain, start, max)

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

מאחזר את כל האתרים ששייכים למשתמש הזה בדומיין הזה בטווח הנתון.

// This writes the a list of sites owned by the user running
// the script in positions bounded by the start and max values to the log.
var sites = SitesApp.getSites("example.com", 25, 50);
for(var i in sites) {
  Logger.log(sites[i].getUrl());
}

פרמטרים

שם	תיאור	התיאור
domain	String	הדומיין המתארח ב-Google Workspace, למשל examplepetstore.com.
start	Integer	האינדקס של האתר הראשון שמוחזר.
max	Integer	המספר המקסימלי של תוצאות שיש להחזיר.

החזרות

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

הרשאות

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

• https://sites.google.com/feeds