Guia de referência

Este documento fornece documentação de referência detalhada para o protocolo bruto (XML e HTTP) da API Google Sites Data.

Este documento não contém informações sobre as bibliotecas de cliente da linguagem de programação. Para informações de referência da biblioteca de cliente, consulte os links nas seções específicas da linguagem de programação do guia para desenvolvedores.

Público-alvo

Este documento é destinado a programadores que querem escrever aplicativos cliente que possam interagir com o Google Sites.

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

Tipos de feeds do Google Sites

A API Google Sites Data oferece 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 em 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: http://sites.google.com/a/domainName/siteName/.

Todas as solicitações para esse 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 em 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 esse feed podem ou não exigir autenticação, dependendo das configurações (publicadas) do site.

Tipos de solicitações aceitos: GET, POST, PUT e DELETE

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

Parâmetro Descrição Tipo Observações
ancestor Solicita apenas entradas que têm 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 do pai e assim por diante.
include-deleted Especifica se as entradas excluídas devem ser incluídas. booleano Os valores possíveis são true ou false. O padrão é false.
include-draft Especifica se as entradas de rascunho serão incluídas. booleano Os valores possíveis são true ou false. O padrão é false. Você precisa ser o proprietário ou autor do rascunho para acessá-lo.
kind Especifica os tipos de entradas de conteúdo a serem retornados. Elas seguem o tipo de página no Google Sites. lista de strings separadas por vírgulas Os valores possíveis são announcement, announcementspage, attachment, comment, filecabinet, listitem, listpage, webpage, webattachment, template.
parent Solicita apenas entradas que têm o pai especificado. string Informe o ID da entrada principal. 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 buscar conteúdo. Por exemplo, path=/path/to/page.

Feed de revisão

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

O URI GET deste feed para um site em 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 esse feed precisam ser autenticadas.

Tipos de solicitação compatíveis: GET

Feed de site

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

O URI do feed para a listagem de sites é:

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

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

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

Tipos de solicitações aceitos: GET, POST, PUT

O feed de site é compatível com os seguintes parâmetros (opcionais) ao emitir uma solicitação GET para listar sites:

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. booleano Esse parâmetro só é aplicável ao listar sites de 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ços da Web em uma entrada de site. booleano Os valores possíveis são true ou false. O padrão é false.

Feed de ACL

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

O URI do feed para a listagem de 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 esse feed precisam ser autenticadas.

Tipos de solicitações aceitos: GET, POST, PUT e DELETE

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

Parâmetros de consulta compatíveis do protocolo 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 completo)

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

Voltar ao início