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

Class Site

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

Объект, представляющий сайт Google.

Методы

Метод	Тип возврата	Краткое описание
`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.
`getAnnouncementsPages()`	`Page[]`	Получает список страниц объявлений для данного сайта Google.
`getAttachments()`	`Attachment[]`	Получает список вложений для данного сайта Google.
`getChildByName(name)`	`Page`	Получает определенную дочернюю страницу.
`getChildren()`	`Page[]`	Получает массив дочерних страниц, максимум 200 страниц.
`getChildren(options)`	`Page[]`	Получает массив дочерних страниц с необязательными расширенными аргументами.
`getCollaborators()`	`User[]`	Получает список соавторов сайта.
`getComments()`	`Comment[]`	Получает список комментариев для данного сайта Google.
`getFileCabinetPages()`	`Page[]`	Получает список страниц картотеки для данного сайта Google.
`getListItems()`	`ListItem[]`	Получает список элементов списка сайта для данного сайта Google.
`getListPages()`	`Page[]`	Получает список страниц списка сайтов для данного сайта Google.
`getName()`	`String`	Вернуть имя сайта
`getOwners()`	`User[]`	Получает список владельцев сайта.
`getSelfLink()`	`String`	Получает URL-адрес канала этого сайта.
`getSiteName()`	`String`	Вернуть имя сайта
`getSummary()`	`String`	Вернуть сводку веб-сайта
`getTemplates()`	`Page[]`	Возвращает все страницы шаблона.
`getTheme()`	`String`	Получает тему сайта
`getTitle()`	`String`	Вернуть название сайта
`getUrl()`	`String`	Получает URL-адрес этого сайта.
`getWebAttachments()`	`Attachment[]`	Получает список веб-вложений для данного сайта Google.
`getWebPages()`	`Page[]`	Получает список веб-страниц для данного сайта Google.
`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)`

Параметры

Имя	Тип	Описание
`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 находится на общем диске, который пользователь может получить доступ.

Для файлов на Диске это также удаляет пользователя из списка зрителей.

Параметры

Имя	Тип	Описание
`emailAddress`	`String`	Адрес электронной почты пользователя, которого необходимо удалить.

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

Site — Этот Site для создания цепочек.

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

https://sites.google.com/feeds

`removeEditor(user)`

Для файлов на Диске это также удаляет пользователя из списка зрителей.

Параметры

Имя	Тип	Описание
`user`	`User`	Представление пользователя, которого нужно удалить.

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

Site — Этот Site для создания цепочки.

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

https://sites.google.com/feeds

`removeViewer(emailAddress)`

Удаляет данного пользователя из списка зрителей и комментаторов Site . Этот метод не имеет эффекта, если пользователь является редактором, а не зрителем или комментатором. Этот метод также не блокирует доступ пользователей к Site , если они принадлежат к классу пользователей, имеющих общий доступ — например, если Site используется всем доменом пользователя или если Site находится на общем диске, который пользователь может получить доступ.

Для файлов Диска это также удаляет пользователя из списка редакторов.

Параметры

Имя	Тип	Описание
`emailAddress`	`String`	Адрес электронной почты пользователя, которого необходимо удалить.

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

Site — Site для создания цепочек.

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

https://sites.google.com/feeds

`removeViewer(user)`

Удаляет данного пользователя из списка зрителей и комментаторов Site . Этот метод не имеет эффекта, если пользователь является редактором, а не зрителем. Этот метод также не блокирует доступ пользователей к Site , если они принадлежат к классу пользователей, имеющих общий доступ — например, если Site используется всем доменом пользователя или если Site находится на общем диске, который пользователь может получить доступ.

Для файлов Диска это также удаляет пользователя из списка редакторов.

Параметры

Имя	Тип	Описание
`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)`

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

Устарело. Заменено на createComment on 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.

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.

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.

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.

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.

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.

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

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

Вернуть имя сайта

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

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

String — имя сайта.

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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.

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.

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 — экземпляр сайта для цепочки методов.

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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 — экземпляр сайта для цепочки методов.

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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 — экземпляр сайта для цепочки методов.

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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 — экземпляр сайта для цепочки методов.

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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() недопустимое значение. Скрипт выдаст ошибку службы и вернет исчерпывающий список доступных тем. Список доступных тем также доступен в разделе «Управление сайтом» -> «Темы». Строки названия темы обычно такие же, как имя темы на странице «Темы», в нижнем регистре, с удаленными пробелами и специальными символами. Например, строка для «Терра: Вода» будет «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

Class Site Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.

Методы

Устаревшие методы

Подробная документация

addEditor(emailAddress)

Параметры

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

Авторизация

addEditor(user)

Параметры

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

Авторизация

addEditors(emailAddresses)

Параметры

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

Авторизация

addViewer(emailAddress)

Параметры

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

Авторизация

addViewer(user)

Параметры

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

Авторизация

addViewers(emailAddresses)

Параметры

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

Авторизация

getEditors()

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

Авторизация

getViewers()

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

Авторизация

removeEditor(emailAddress)

Параметры

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

Авторизация

removeEditor(user)

Параметры

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

Авторизация

removeViewer(emailAddress)

Параметры

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

Авторизация

removeViewer(user)

Параметры

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

Авторизация

Устаревшие методы

addCollaborator(email)

Параметры

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

Авторизация

addCollaborator(user)

Параметры

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

Авторизация

addOwner(email)

Параметры

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

Авторизация

addOwner(user)

Параметры

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

Авторизация

createAnnouncement(title, html, parent)

Параметры

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

Авторизация

createAnnouncementsPage(title, name, html)

Параметры

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

Авторизация

createComment(inReplyTo, html, parent)

Параметры

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

Авторизация

createFileCabinetPage(title, name, html)

Class Site

`addEditor(emailAddress)`

`addEditor(user)`

`addEditors(emailAddresses)`

`addViewer(emailAddress)`

`addViewer(user)`

`addViewers(emailAddresses)`

`getEditors()`

`getViewers()`

`removeEditor(emailAddress)`

`removeEditor(user)`

`removeViewer(emailAddress)`

`removeViewer(user)`

`addCollaborator(email)`

`addCollaborator(user)`

`addOwner(email)`

`addOwner(user)`

`createAnnouncement(title, html, parent)`

`createAnnouncementsPage(title, name, html)`

`createComment(inReplyTo, html, parent)`

`createFileCabinetPage(title, name, html)`

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

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

`createPageFromTemplate(title, name, template)`

`createWebAttachment(title, url, parent)`

`createWebPage(title, name, html)`

`deleteSite()`

`getAllDescendants()`

`getAllDescendants(options)`

`getAnnouncements()`

`getAnnouncementsPages()`

`getAttachments()`

`getChildByName(name)`

`getChildren()`

`getChildren(options)`

`getCollaborators()`

`getComments()`

`getFileCabinetPages()`

`getListItems()`

`getListPages()`

`getName()`