Esta página foi traduzida pela API Cloud Translation.

Class Site

Obsoleto. Esta classe foi descontinuada e não pode ser usada em novos scripts.

Um objeto que representa um site Google.

Métodos

Método	Tipo de retorno	Breve descrição
`addEditor(emailAddress)`	`Site`	Adiciona o usuário especificado à lista de editores do `Site`.
`addEditor(user)`	`Site`	Adiciona o usuário especificado à lista de editores do `Site`.
`addEditors(emailAddresses)`	`Site`	Adiciona a matriz de usuários especificada à lista de editores do `Site`.
`addViewer(emailAddress)`	`Site`	Adiciona o usuário especificado à lista de leitores do `Site`.
`addViewer(user)`	`Site`	Adiciona o usuário especificado à lista de leitores do `Site`.
`addViewers(emailAddresses)`	`Site`	Adiciona a matriz de usuários especificada à lista de leitores para o `Site`.
`getEditors()`	`User[]`	Recebe a lista de editores deste `Site`.
`getViewers()`	`User[]`	Recebe a lista de leitores e comentadores deste `Site`.
`removeEditor(emailAddress)`	`Site`	Remove o usuário especificado da lista de editores do `Site`.
`removeEditor(user)`	`Site`	Remove o usuário especificado da lista de editores do `Site`.
`removeViewer(emailAddress)`	`Site`	Remove o usuário especificado da lista de leitores e comentadores do `Site`.
`removeViewer(user)`	`Site`	Remove o usuário especificado da lista de leitores e comentadores do `Site`.

Métodos obsoletos

Método	Tipo de retorno	Breve descrição
`addCollaborator(email)`	`Site`	Adicionar um novo colaborador ao site
`addCollaborator(user)`	`Site`	Adicionar um novo colaborador ao site
`addOwner(email)`	`Site`	Adicionar um novo proprietário ao site
`addOwner(user)`	`Site`	Adicionar um novo proprietário ao site
`createAnnouncement(title, html, parent)`	`Page`	Criar um novo aviso
`createAnnouncementsPage(title, name, html)`	`Page`	Crie uma nova página de avisos.
`createComment(inReplyTo, html, parent)`	`Comment`	Obsoleto.
`createFileCabinetPage(title, name, html)`	`Page`	Crie uma nova página de arquivo.
`createListItem(html, columnNames, values, parent)`	`ListItem`	Obsoleto.
`createListPage(title, name, html, columnNames)`	`Page`	Criar uma nova página de lista.
`createPageFromTemplate(title, name, template)`	`Page`	Use um modelo para criar uma página.
`createWebAttachment(title, url, parent)`	`Attachment`	Obsoleto.
`createWebPage(title, name, html)`	`Page`	Crie uma nova página da Web.
`deleteSite()`	`void`	Exclui este site.
`getAllDescendants()`	`Page[]`	Recebe uma matriz de páginas descendentes (diretas e indiretas), até um limite de 200 páginas.
`getAllDescendants(options)`	`Page[]`	Recebe uma matriz de páginas descendentes com argumentos avançados opcionais.
`getAnnouncements()`	`Page[]`	Recupera uma lista de avisos para o site Google especificado.
`getAnnouncementsPages()`	`Page[]`	Recupera uma lista de páginas de avisos do site Google especificado.
`getAttachments()`	`Attachment[]`	Recupera uma lista de anexos do site Google especificado.
`getChildByName(name)`	`Page`	Recebe uma página filha específica.
`getChildren()`	`Page[]`	Recebe uma matriz de páginas filhas, até um limite de 200 páginas.
`getChildren(options)`	`Page[]`	Recebe uma matriz de páginas filhas com argumentos avançados opcionais.
`getCollaborators()`	`User[]`	Recupera a lista de colaboradores do site.
`getComments()`	`Comment[]`	Recupera uma lista de comentários para o site Google especificado.
`getFileCabinetPages()`	`Page[]`	Recupera uma lista de páginas de arquivo do Site do Google fornecido.
`getListItems()`	`ListItem[]`	Recupera uma lista de itens de lista do site do Google Site fornecido.
`getListPages()`	`Page[]`	Recupera uma lista de páginas de lista de sites do Google Site especificado.
`getName()`	`String`	Retornar o nome do site
`getOwners()`	`User[]`	Recupera a lista de proprietários do site.
`getSelfLink()`	`String`	Recupera o URL do feed desse site.
`getSiteName()`	`String`	Retornar o siteName do site
`getSummary()`	`String`	Retornar o resumo do site
`getTemplates()`	`Page[]`	Retorna todas as páginas de modelo.
`getTheme()`	`String`	Define o tema do site
`getTitle()`	`String`	Retorna o título do site
`getUrl()`	`String`	Recupera o URL desse site.
`getWebAttachments()`	`Attachment[]`	Recupera uma lista de anexos da Web para o site Google especificado.
`getWebPages()`	`Page[]`	Recupera uma lista de páginas da web para o Google Site fornecido.
`removeCollaborator(email)`	`Site`	Remove um colaborador do site por e-mail do usuário
`removeCollaborator(user)`	`Site`	Remove um colaborador do site
`removeOwner(email)`	`Site`	Remove o proprietário do site por e-mail do usuário
`removeOwner(user)`	`Site`	Remove o proprietário do site
`search(query)`	`Page[]`	Recebe uma matriz de páginas descendentes que correspondem a uma consulta de pesquisa, até um limite de 200 páginas.
`search(query, options)`	`Page[]`	Recebe uma matriz de páginas descendentes que correspondem a uma consulta de pesquisa, com argumentos avançados opcionais.
`setSummary(summary)`	`Site`	Definir o resumo do site
`setTheme(theme)`	`Site`	Define o tema do site
`setTitle(title)`	`Site`	Defina o título do site

Documentação detalhada

`addEditor(emailAddress)`

Adiciona o usuário especificado à lista de editores do Site. Se o usuário já estiver na lista de espectadores, esse método o removerá da lista.

Parâmetros

Nome	Tipo	Descrição
`emailAddress`	`String`	O endereço de e-mail do usuário a ser adicionado.

Retorno

Site: este Site, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`addEditor(user)`

Adiciona o usuário especificado à lista de editores do Site. Se o usuário já estiver na lista de espectadores, esse método o removerá da lista.

Parâmetros

Nome	Tipo	Descrição
`user`	`User`	Uma representação do usuário a ser adicionado.

Retorno

Site: este Site, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`addEditors(emailAddresses)`

Adiciona a matriz de usuários especificada à lista de editores do Site. Se algum dos usuários já estiver na lista de espectadores, esse método o removerá da lista de espectadores.

Parâmetros

Nome	Tipo	Descrição
`emailAddresses`	`String[]`	Uma matriz de endereços de e-mail dos usuários a serem adicionados.

Retorno

Site: este Site, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`addViewer(emailAddress)`

Adiciona o usuário especificado à lista de leitores do Site. Se o usuário já estiver na lista de editores, esse método não terá efeito.

Parâmetros

Nome	Tipo	Descrição
`emailAddress`	`String`	O endereço de e-mail do usuário a ser adicionado.

Retorno

Site: este Site, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`addViewer(user)`

Adiciona o usuário especificado à lista de leitores do Site. Se o usuário já estiver na lista de editores, esse método não terá efeito.

Parâmetros

Nome	Tipo	Descrição
`user`	`User`	Uma representação do usuário a ser adicionado.

Retorno

Site: este Site, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`addViewers(emailAddresses)`

Adiciona a matriz de usuários especificada à lista de leitores para o Site. Se algum dos usuários já estiver na lista de editores, esse método não terá efeito para ele.

Parâmetros

Nome	Tipo	Descrição
`emailAddresses`	`String[]`	Uma matriz de endereços de e-mail dos usuários a serem adicionados.

Retorno

Site: este Site, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`getEditors()`

Recebe a lista de editores deste Site.

Retorno

User[]: uma matriz de usuários com permissão para edição.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`getViewers()`

Recebe a lista de leitores e comentadores deste Site.

Retorno

User[]: uma matriz de usuários com permissão de leitura ou comentário.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`removeEditor(emailAddress)`

Remove o usuário especificado da lista de editores do Site. Esse método não impede que os usuários acessem o Site se eles pertencerem a uma classe de usuários que tenham acesso geral. Por exemplo, se Site for compartilhado com todo o domínio do usuário ou se o Site estiver em um drive compartilhado que o usuário pode acessar.

Nos arquivos do Drive, essa ação também remove o usuário da lista de leitores.

Parâmetros

Nome	Tipo	Descrição
`emailAddress`	`String`	O endereço de e-mail do usuário a ser removido.

Retorno

Site: este Site, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`removeEditor(user)`

Nos arquivos do Drive, essa ação também remove o usuário da lista de leitores.

Parâmetros

Nome	Tipo	Descrição
`user`	`User`	Uma representação do usuário a ser removido.

Retorno

Site: este Site, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`removeViewer(emailAddress)`

Remove o usuário especificado da lista de leitores e comentadores do Site. Esse método não terá efeito se o usuário for um editor, não um leitor ou comentarista. Esse método também não impede que os usuários acessem o Site se eles pertencerem a uma classe de usuários com acesso geral. Por exemplo, se Site for compartilhado com todo o domínio do usuário ou se o Site estiver em um drive compartilhado que o usuário pode acessar.

Nos arquivos do Drive, essa ação também remove o usuário da lista de editores.

Parâmetros

Nome	Tipo	Descrição
`emailAddress`	`String`	O endereço de e-mail do usuário a ser removido.

Retorno

Site: esse Site para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`removeViewer(user)`

Remove o usuário especificado da lista de leitores e comentadores do Site. Esse método não terá efeito se o usuário for um editor, não um visualizador. Esse método também não impede que os usuários acessem o Site se eles pertencerem a uma classe de usuários com acesso geral, por exemplo, se Site for compartilhado com todo o domínio do usuário ou se o Site estiver em um drive compartilhado que o usuário pode acessar.

Nos arquivos do Drive, essa ação também remove o usuário da lista de editores.

Parâmetros

Nome	Tipo	Descrição
`user`	`User`	Uma representação do usuário a ser removido.

Retorno

Site: esse Site para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

Métodos obsoletos

`addCollaborator(email)`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Adicionar um novo colaborador ao site

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

Parâmetros

Nome	Tipo	Descrição
`email`	`String`	O e-mail do usuário a ser adicionado como colaborador

Retorno

Site: este site para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`addCollaborator(user)`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Adicionar um novo colaborador ao site

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

Parâmetros

Nome	Tipo	Descrição
`user`	`User`	Usuário a ser adicionado como colaborador

Retorno

Site: este site para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`addOwner(email)`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Adicionar um novo proprietário ao site

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

Parâmetros

Nome	Tipo	Descrição
`email`	`String`	O e-mail do usuário a ser adicionado como proprietário

Retorno

Site: este site para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`addOwner(user)`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Adicionar um novo proprietário ao site

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

Parâmetros

Nome	Tipo	Descrição
`user`	`User`	O usuário a ser adicionado como proprietário

Retorno

Site: este site para encadeamento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`createAnnouncement(title, html, parent)`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Criar um novo aviso

Parâmetros

Nome	Tipo	Descrição
`title`	`String`	O título da página de avisos que será criada
`html`	`String`	O corpo HTML da página
`parent`	`Page`	Página principal

Retorno

Page: o Page criado

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`createAnnouncementsPage(title, name, html)`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Crie uma nova página de avisos. Um site principal ou uma página não podem ter mais de 500 páginas filhas.

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

Parâmetros

Nome	Tipo	Descrição
`title`	`String`	o título da página
`name`	`String`	o nome da página
`html`	`String`	o conteúdo da página

Retorno

Page: o Page recém-criado

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`createComment(inReplyTo, html, parent)`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Obsoleto. Substituído por createComment em Page.

Criar um novo comentário.

Parâmetros

Nome	Tipo	Descrição
`inReplyTo`	`String`	um URL de feed GData - sem sentido e corrompido
`html`	`String`	o conteúdo do comentário
`parent`	`Page`	o elemento pai em que os comentários aparecem

Retorno

Comment: o Comment recém-criado

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`createFileCabinetPage(title, name, html)`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Crie uma nova página de arquivo. Um site ou página pai não pode ter mais de 500 páginas filhos.

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

Parâmetros

Nome	Tipo	Descrição
`title`	`String`	o título da página
`name`	`String`	o nome da página
`html`	`String`	o conteúdo da página

Retorno

Page: a Page recém-criada

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

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

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Obsoleto. Substituído por createListItem em Page.

Crie um novo ListItem.

Parâmetros

Nome	Tipo	Descrição
`html`	`String`	o conteúdo do item: sem sentido e corrompido.
`columnNames`	`String[]`	os nomes das colunas, que são desnecessárias
`values`	`String[]`	os valores das colunas
`parent`	`Page`	o ListPage principal

Retorno

ListItem: o ListItem para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

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

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Criar uma nova página de lista. Uma página ou um site pai não pode ter mais de 500 páginas filhas.

// 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" ]);

Parâmetros

Nome	Tipo	Descrição
`title`	`String`	o título da página
`name`	`String`	o nome da página
`html`	`String`	o conteúdo da página
`columnNames`	`String[]`	os nomes das colunas usadas para a lista

Retorno

Page: a Page recém-criada

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`createPageFromTemplate(title, name, template)`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Use um modelo para criar uma página. Um site principal ou uma página não podem ter mais de 500 páginas filhas.

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

Parâmetros

Nome	Tipo	Descrição
`title`	`String`	o título da página
`name`	`String`	o nome da página
`template`	`Page`	a página do modelo

Retorno

Page: o Page recém-criado

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`createWebAttachment(title, url, parent)`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Obsoleto. Substituído por createWebAttachment em Page.

Crie um novo anexo da Web.

Parâmetros

Nome	Tipo	Descrição
`title`	`String`	o título do anexo
`url`	`String`	o URL do anexo
`parent`	`Page`	página principal

Retorno

Attachment: é o anexo para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`createWebPage(title, name, html)`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Crie uma nova página da Web. Uma página ou um site pai não pode ter mais de 500 páginas filhas.

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

Parâmetros

Nome	Tipo	Descrição
`title`	`String`	o título da página
`name`	`String`	o nome da página
`html`	`String`	o conteúdo da página

Retorno

Page: a Page recém-criada

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`deleteSite()`

Obsoleto. Esse método não está implementado no momento e vai ficar indisponível no futuro.

Exclui este site.

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

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`getAllDescendants()`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Recebe uma matriz de páginas descendentes (diretas e indiretas), até um limite de 200 páginas.

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

Retorno

Page[]: uma matriz de páginas filhas diretas e indiretas.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`getAllDescendants(options)`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Recebe uma matriz de páginas descendentes com argumentos avançados opcionais.

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());
}

Parâmetros

Nome	Tipo	Descrição
`options`	`Object`	Campos do objeto JavaScript definidos na seção "Argumentos avançados" abaixo

Parâmetros avançados

Nome	Tipo	Descrição
`type`	`PageType[]`	obter apenas páginas desse tipo
`start`	`Integer`	começar os resultados aqui
`max`	`Integer`	o número máximo de resultados (padrão 200)
`includeDrafts`	`Boolean`	se quer incluir páginas de rascunho (falso padrão)
`includeDeleted`	`Boolean`	se é necessário incluir páginas excluídas (padrão false)
`search`	`String`	só retorna páginas que correspondem a essa consulta

Retorno

Page[]: uma matriz de páginas filhas diretas e indiretas do tipo especificado

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`getAnnouncements()`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Recupera uma lista de avisos para o site Google especificado.

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

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

Retorno

Page[]: uma matriz de instâncias de aviso @link Page}

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`getAnnouncementsPages()`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Recupera uma lista de páginas de avisos do site Google especificado.

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

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

Retorno

Page[]: uma matriz de instâncias de Page.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`getAttachments()`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Recupera uma lista de anexos do site Google especificado.

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());
}

Retorno

Attachment[]: uma matriz de instâncias de Attachment.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`getChildByName(name)`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Recebe uma página filha específica.

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

Parâmetros

Nome	Tipo	Descrição
`name`	`String`	o nome da página secundária

Retorno

Page: a página filha

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`getChildren()`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Recebe uma matriz de páginas filhas, até um limite de 200 páginas.

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

Retorno

Page[]: uma matriz de páginas filhas diretas.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`getChildren(options)`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Recebe uma matriz de páginas filhas com argumentos avançados opcionais.

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());
}

Parâmetros

Nome	Tipo	Descrição
`options`	`Object`	Campos do objeto JavaScript definidos na seção "Argumentos avançados" abaixo

Parâmetros avançados

Nome	Tipo	Descrição
`type`	`PageType[]`	obter apenas páginas desse tipo
`start`	`Integer`	começar os resultados aqui
`max`	`Integer`	o número máximo de resultados (padrão 200)
`includeDrafts`	`Boolean`	se quer incluir páginas de rascunho (falso padrão)
`includeDeleted`	`Boolean`	se é necessário incluir páginas excluídas (padrão false)
`search`	`String`	só retorna páginas que correspondem a essa consulta

Retorno

Page[]: uma matriz de páginas filhas diretas do tipo especificado

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`getCollaborators()`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Recupera a lista de colaboradores do site.

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

Retorno

User[]: uma matriz contendo instâncias de User que representam os colaboradores.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`getComments()`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Recupera uma lista de comentários para o site Google especificado.

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

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

Retorno

Comment[]: uma matriz de instâncias de Comment.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`getFileCabinetPages()`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Recupera uma lista de páginas de arquivo do Site do Google fornecido.

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

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

Retorno

Page[]: uma matriz de instâncias de Page.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`getListItems()`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Recupera uma lista de itens de lista do site do Google Site fornecido.

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

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

Retorno

ListItem[]: uma matriz de instâncias de ListItem.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`getListPages()`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Recupera uma lista de páginas de lista de sites do Google Site especificado.

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

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

Retorno

Page[]: uma matriz de instâncias de Page.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`getName()`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Retornar o nome do site

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

Retorno

String: o nome da instância do site

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`getOwners()`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Recupera a lista de proprietários do site.

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

Retorno

User[]: uma matriz contendo instâncias de User que representam os proprietários.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`getSelfLink()`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Recupera o URL do feed desse site.

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

Retorno

String: o URL do feed deste site

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`getSiteName()`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Retornar o siteName do site

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

Retorno

String: o siteName do site.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`getSummary()`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Retornar o resumo do site

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

Retorno

String: o resumo do site.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`getTemplates()`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Retorna todas as páginas de modelo.

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

Retorno

Page[]: uma matriz contendo instâncias de Page que representam modelos.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`getTheme()`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Define o tema do site

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

Retorno

String: o tema deste site.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`getTitle()`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Retorna o título do site

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

Retorno

String: o título do site

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`getUrl()`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Recupera o URL desse site.

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

Retorno

String: o URL desta instância do site

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`getWebAttachments()`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Recupera uma lista de anexos da Web para o site Google especificado.

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());
}

Retorno

Attachment[]: uma matriz de instâncias de Attachment.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`getWebPages()`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Recupera uma lista de páginas da web para o Google Site fornecido.

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

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

Retorno

Page[]: uma matriz de instâncias de Page.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`removeCollaborator(email)`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Remove um colaborador do site por e-mail do usuário

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

Parâmetros

Nome	Tipo	Descrição
`email`	`String`	O e-mail do usuário que será removido dos colaboradores

Retorno

Site: a instância do site para encadeamento de métodos.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`removeCollaborator(user)`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Remove um colaborador do site

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

Parâmetros

Nome	Tipo	Descrição
`user`	`User`	Um usuário a ser removido da lista de colaboradores

Retorno

Site: a instância do site para encadeamento de métodos.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`removeOwner(email)`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Remove o proprietário do site por e-mail do usuário

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

Parâmetros

Nome	Tipo	Descrição
`email`	`String`	O e-mail do usuário a ser removido dos proprietários

Retorno

Site: a instância do site para encadeamento de métodos.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`removeOwner(user)`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Remove o proprietário do site

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

Parâmetros

Nome	Tipo	Descrição
`user`	`User`	Um usuário a ser removido da lista de proprietários

Retorno

Site: a instância do site para encadeamento de métodos.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`search(query)`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Recebe uma matriz de páginas descendentes que correspondem a uma consulta de pesquisa, até um limite de 200 páginas.

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

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

Parâmetros

Nome	Tipo	Descrição
`query`	`String`	a consulta de pesquisa de texto completo para corresponder

Retorno

Page[]: uma matriz de páginas filhas diretas e indiretas do tipo especificado

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`search(query, options)`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Recebe uma matriz de páginas descendentes que correspondem a uma consulta de pesquisa, com argumentos avançados opcionais.

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());
}

Parâmetros

Nome	Tipo	Descrição
`query`	`String`	a consulta de pesquisa de texto completo para corresponder
`options`	`Object`	Campos do objeto JavaScript definidos na seção "Argumentos avançados" abaixo

Parâmetros avançados

Nome	Tipo	Descrição
`type`	`PageType[]`	obter apenas páginas desse tipo
`start`	`Integer`	começar os resultados aqui
`max`	`Integer`	o número máximo de resultados (padrão 200)
`includeDrafts`	`Boolean`	se quer incluir páginas de rascunho (falso padrão)
`includeDeleted`	`Boolean`	se é necessário incluir páginas excluídas (padrão false)

Retorno

Page[]: uma matriz de páginas filhas diretas e indiretas do tipo especificado

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`setSummary(summary)`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Definir o resumo do site

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");

Parâmetros

Nome	Tipo	Descrição
`summary`	`String`	Um resumo de string que descreve o site

Retorno

Site: o site para o encadeamento de métodos.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`setTheme(theme)`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Define o tema do site

O tema precisa ser uma string de tema válida. Para ver uma lista completa, crie um método de teste e transmita um valor inválido para setTheme(). O script vai gerar um erro de serviço e retornar uma lista completa de temas disponíveis. A lista de temas disponíveis também está disponível em "Gerenciar site" -> "Temas". As strings de nome do tema geralmente são iguais ao nome na página "Temas" em letras minúsculas, sem espaços e caracteres especiais. Por exemplo, a string para "Terra: Água" seria "terra-água".

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");

Parâmetros

Nome	Tipo	Descrição
`theme`	`String`	um nome de string para o tema definido para esse `Site`

Retorno

Site: o site para o encadeamento de métodos.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds

`setTitle(title)`

Obsoleto. Esta função foi descontinuada e não pode ser usada em novos scripts.

Defina o título do site

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");

Parâmetros

Nome	Tipo	Descrição
`title`	`String`	o novo título do site

Retorno

Site: o site para o encadeamento de métodos.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

https://sites.google.com/feeds