Este documento fornece a documentação de referência detalhada para o protocolo bruto (XML e HTTP) da API de dados do Google Sites.
Este documento não contém informações sobre as bibliotecas-cliente de linguagem de programação. Para obter informações de referência da biblioteca 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; É necessário que você entenda os conceitos apresentados no guia de protocolos e as ideias gerais por trás do protocolo das 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 é 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 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 é um feed que contém o conteúdo atual e editável do site.
O URI GET
desse 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 do site: 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 de dados, a API de dados do Google Sites permite os seguintes parâmetros opcionais
emitir solicitação GET
usando o feed de conteúdo:
Parâmetro | Descrição | Tipo | Observações |
---|---|---|---|
ancestor |
Solicita apenas entradas que tenham o ancestral especificado. | string | Forneça 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 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 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 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 | Forneça o ID da entrada pai. Por exemplo, 0123456789 . |
path |
Solicita conteúdo sob 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 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 site
O feed de site pode ser usado para listar os sites do Google de um usuário ou para os quais ele tem permissões de visualização. Também pode ser usados para criar novos sites, copiar um site ou modificar o nome de um site existente.
O URI do feed da 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 este feed precisam ser autenticadas.
Tipos de solicitação compatíveis: 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 visualizados 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 do site. | booleano | 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 Google Site.
O URI do feed da 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 compatíveis: 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)
Veja cada feed acima para uma lista de parâmetros específicos dele.