Guia de referência

Este documento contém a documentação de referência detalhada do protocolo bruto (XML e HTTP) da API de dados do Google Sites.

Este documento não contém informações sobre as bibliotecas de cliente de linguagem de programação. Para obter informações de referência sobre a biblioteca cliente, consulte os links das seções específicas de linguagem de programação do Guia do desenvolvedor.

Público-alvo

Este documento se destina a programadores que desejam criar aplicativos cliente que possam interagir com o Google Sites.

É um documento de referência e pressupõe que você entende os conceitos apresentados no guia de protocolos e as ideias gerais por trás do protocolo de APIs de dados do Google.

Tipos de feed do Google Sites

A API de dados do Google Sites fornece os seguintes tipos de feeds:

Feed de atividades

O Feed de atividades contém descrições de todas as atividades em um site.

O URI GET deste feed para um site de um domínio específico é:

https://sites.google.com/feeds/activity/domainName/siteName/[activityEntryID]

domainName é "site" ou um domínio do G Suite.

siteName é o nome do site como aparece no URL da página de destino do site: http://sites.google.com/a/domainName/siteName/.

Todas as solicitações para este feed precisam ser autenticadas.

Tipos de solicitação compatíveis: GET

Feed de conteúdo

O feed de conteúdo contém o conteúdo atual e editável do site.

O URI GET deste feed para um site de um domínio específico é:

https://sites.google.com/feeds/content/domainName/siteName/[contentEntryID]

domainName é "site" ou um domínio do G Suite.

siteName é o nome do site como aparece no URL da página de destino: http://sites.google.com/a/domainName/siteName.

As solicitações para este feed podem ou não exigir autenticação, dependendo das configurações (publicadas) do site.

Tipos de solicitação com suporte: GET, POST, PUT, DELETE

Além dos parâmetros de consulta padrão da API Data, a API Sites Data permite os seguintes parâmetros opcionais que emitem solicitações GET usando o feed de conteúdo:

Parâmetro Descrição Tipo Observações
ancestor Solicita apenas entradas que tenham o ancestral especificado. string Informe o ID da entrada ancestral desejada. Por exemplo, 0123456789. Retorna todas as entradas que têm o ancestral especificado como pai, pai de um pai e assim por diante.
include-deleted Especifica se as entradas excluídas serão incluídas. boolean Os valores possíveis são true ou false. O padrão é false.
include-draft Especifica se entradas de rascunho serão incluídas. boolean Os valores possíveis são true ou false. O padrão é false. Você precisa ser proprietário ou autor do rascunho para vê-lo.
kind Especifica os tipos de entradas de conteúdo a serem retornadas. Eles seguem o tipo de página dentro do Google Sites. lista de strings separada por vírgulas Os valores possíveis são announcement, announcementspage, attachment, comment, filecabinet, listitem, listpage, webpage, webattachment, template.
parent Solicita apenas entradas que tenham o pai especificado. string Informe o ID da entrada pai. Por exemplo, 0123456789.
path Solicita conteúdo em uma determinada hierarquia de páginas string O caminho para uma subpágina em um site para o qual buscar conteúdo. Por exemplo, path=/path/to/page.

Feed de revisão

O feed de revisão contém revisões históricas do conteúdo do site.

O URI GET deste feed para um site de um domínio específico é:

https://sites.google.com/feeds/revision/domainName/siteName/contentEntryID/[revisionEntryID]

domainName é "site" ou um domínio do G Suite.

siteName é o nome do site como aparece no URL da página de destino: http://sites.google.com/a/domainName/siteName.

Todas as solicitações para este feed precisam ser autenticadas.

Tipos de solicitação compatíveis: GET

Feed de sites

O feed de site pode ser usado para listar os Google Sites de que um usuário é proprietário ou tem permissões de visualização. Ela também pode ser usada para criar novos sites, copiar um site ou modificar o nome de um site existente.

O URI do feed da listagem do Google Sites é:

https://sites.google.com/feeds/site/domainName/[siteName]

domainName é "site" ou um domínio do G Suite.

Todas as solicitações para este feed precisam ser autenticadas.

Tipos de solicitação com suporte: GET, POST, PUT

O feed de site suporta os seguintes parâmetros (opcionais) ao emitir uma solicitação GET para sites de informações do produto:

Parâmetro Descrição Tipo Observações
include-all-sites Lista todos os sites que podem ser pelo menos visualizados pelo usuário no domínio do G Suite. boolean Ele só é aplicável à listagem de sites para um domínio do G Suite. Os valores possíveis são true ou false. O padrão é false.
with-mappings Inclui os mapeamentos de endereço da Web em uma entrada do site. boolean Os valores possíveis são true ou false. O padrão é false.

Feed da ACL

O feed da ACL pode ser usado para listar e/ou modificar as permissões de compartilhamento (ACLs) de um site Google.

O URI do feed da listagem do Google Sites é:

https://sites.google.com/feeds/acl/site/domainName/siteName/[aclEntryID]

domainName é "site" ou um domínio do G Suite.

Todas as solicitações para este feed precisam ser autenticadas.

Tipos de solicitação com suporte: GET, POST, PUT, DELETE

Referência de parâmetros de consulta do Google Sites

Parâmetros de consulta compatíveis com o protocolo da API Google Data:

  • max-results
  • published-max (somente feed de conteúdo)
  • published-min (somente feed de conteúdo)
  • start-index
  • updated-max
  • updated-min
  • q (consultas de texto completas)

Consulte cada feed acima para uma lista de parâmetros específicos do feed.

Voltar ao início