Эта страница переведена с помощью Cloud Translation API.

Class SitesApp

Устарело. Этот класс устарел и не должен использоваться в новых сценариях.

Создавайте Сайты Google и получайте к ним доступ.

Устаревшие свойства

Свойство	Тип	Описание
`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`	Получает сайт по URL.
`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`	Публичный URL-адрес.

Возвращаться

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

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Получает сайт по 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()`

Устарело. Эта функция устарела и не должна использоваться в новых скриптах.

Получает первую страницу Сайтов для пользователя, если пользователь является потребителем и не имеет размещенного домена.

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