Class SitesApp

Sites App

منسوخ شده است. این کلاس منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

سایت های گوگل را ایجاد کنید و به آنها دسترسی پیدا کنید.

خواص منسوخ شده

اموال	تایپ کنید	توضیحات
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	یک صفحه را بر اساس url بازیابی می کند.
getSite(name)	Site	اگر کاربر مصرف‌کننده‌ای باشد که دامنه میزبانی شده ندارد، یک سایت را برای سایت Google معین بازیابی می‌کند.
getSite(domain, name)	Site	یک سایت را برای سایت Google داده شده بازیابی می کند.
getSiteByUrl(url)	Site	یک سایت را با آدرس اینترنتی بازیابی می کند.
getSites()	Site[]	اگر کاربر مصرف کننده ای باشد که دامنه میزبانی ندارد، صفحه اول سایت ها را برای کاربر بازیابی می کند.
getSites(start, max)	Site[]	در صورتی که کاربر مصرف کننده ای باشد که دامنه میزبانی ندارد، سایت ها را برای کاربر بین محدوده های داده شده بازیابی می کند.
getSites(domain)	Site[]	صفحه اول سایت های متعلق به این کاربر در این دامنه را بازیابی می کند.
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)

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

یک صفحه را بر اساس 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	آدرس عمومی.

بازگشت

Page - نمونه Page مربوط به صفحه در URL یا در صورت عدم وجود صفحه، null .

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

---

getSite(name)

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

اگر کاربر مصرف‌کننده‌ای باشد که دامنه میزبانی شده ندارد، یک سایت را برای سایت Google معین بازیابی می‌کند.

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

پارامترها

نام	تایپ کنید	توضیحات
name	String	نام فضای وب موجود در URL، مانند mySite.

بازگشت

Site - یک نمونه سایت مربوط به یک سایت مصرف کننده.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

---

getSite(domain, name)

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

یک سایت را برای سایت Google داده شده بازیابی می کند.

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

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

یک سایت را با آدرس اینترنتی بازیابی می کند.

// 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	آدرس عمومی.

بازگشت

Site - سایتی که در URL داده شده یافت می شود.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

---

getSites()

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

اگر کاربر مصرف کننده ای باشد که دامنه میزبانی ندارد، صفحه اول سایت ها را برای کاربر بازیابی می کند.

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

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

در صورتی که کاربر مصرف کننده ای باشد که دامنه میزبانی ندارد، سایت ها را برای کاربر بین محدوده های داده شده بازیابی می کند.

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)

منسوخ شده است. این تابع منسوخ شده است و نباید در اسکریپت های جدید استفاده شود.

صفحه اول سایت های متعلق به این کاربر در این دامنه را بازیابی می کند.

// 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