Guia de referência

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

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

Público-alvo

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

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

Tipos de feed do Google Sites

A API Google Sites Data oferece os seguintes tipos de feeds:

Feed de atividades

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

O URI GET desse 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 conforme 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 é um feed que contém o conteúdo atual e editável do site.

O URI GET do 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 conforme 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ção compatíveis: GET, POST, PUT, DELETE

Além dos parâmetros de consulta padrão da API Data, a API Data para sites permite os seguintes parâmetros opcionais para emitir a 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 é necessário incluir entradas excluídas. booleano Os valores possíveis são true ou false. O padrão é false.
include-draft Especifica se as entradas de rascunho devem ser incluídas. booleano Os valores possíveis são true ou false. O padrão é false. Você precisa ser proprietário ou autor do rascunho para visualizá-lo.
kind Especifica os tipos de entradas de conteúdo a serem retornadas. 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 tenham 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 em que o conteúdo será buscado. Por exemplo, path=/path/to/page.

Feed de revisão

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

O URI GET desse 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 conforme 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 do site

O feed de sites pode ser usado para listar os Sites Google que um usuário possui 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ção com suporte: GET, POST, PUT

O feed de sites aceita os seguintes parâmetros (opcionais) ao emitir uma solicitação GET para listar sites:

Parâmetro Descrição Tipo Observações
include-all-sites Liste todos os sites que podem ser acessados pelo usuário no domínio do G Suite. booleano Este parâmetro é aplicável apenas ao listar 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ços da Web em uma entrada de site. booleano Os valores possíveis são true ou false. O padrão é false.

Feed da ACL

O feed de ACL pode ser usado para listar e/ou modificar as permissões de compartilhamento (ACLs) de um site do 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 este feed precisam ser autenticadas.

Tipos de solicitação aceitos: GET, POST, PUT e DELETE

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

Parâmetros de consulta com suporte do protocolo da API Data do Google:

  • 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