Guide de référence

Ce document fournit une documentation de référence détaillée sur le protocole brut (XML et HTTP) de l'API Google Sites Data.

Ce document ne contient pas d'informations sur les bibliothèques clientes du langage de programmation. Pour obtenir des informations de référence sur les bibliothèques clientes, consultez les liens des sections spécifiques au langage de programmation du guide du développeur.

Audience

Ce document est destiné aux programmeurs qui souhaitent développer des applications clientes capables d'interagir avec Google Sites.

Il s'agit d'un document de référence qui part du principe que vous comprenez les concepts présentés dans le guide du protocole et les idées générales sur le protocole des API Google Data.

Types de flux Google Sites

L'API Google Sites Data fournit les types de flux suivants:

Flux d'activité

Le flux d'activités est un flux contenant des descriptions de toutes les activités d'un site.

L'URI GET de ce flux pour un site appartenant à un domaine particulier est:

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

domainName est soit "site", soit un domaine G Suite.

siteName est le nom du site tel qu'il apparaît dans l'URL de la page de destination du site: http://sites.google.com/a/domainName/siteName/.

Toutes les requêtes adressées à ce flux doivent être authentifiées.

Types de requêtes compatibles: GET

Flux de contenu

Le flux de contenu comporte le contenu actuel du site, qui peut être modifié.

L'URI GET de ce flux pour un site appartenant à un domaine particulier est:

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

domainName est soit "site", soit un domaine G Suite.

siteName est le nom du site tel qu'il apparaît dans l'URL de la page de destination du site: http://sites.google.com/a/domainName/siteName.

Les demandes envoyées à ce flux peuvent nécessiter ou non une authentification, en fonction des paramètres du Site (publié).

Types de requêtes compatibles: GET, POST, PUT, DELETE

En plus des paramètres de requête standards de l'API Data, l'API Sites Data autorise les paramètres facultatifs suivants, qui émettent une requête GET à l'aide du flux de contenu:

Paramètres Description Type Remarques
ancestor Demande uniquement les entrées ayant l'ancêtre spécifié. chaîne Indiquez l'ID de l'entrée d'ancêtre souhaitée. Exemple : 0123456789. Renvoie toutes les entrées ayant l'ancêtre spécifié comme parent, le parent d'un parent, etc.
include-deleted Indique si les entrées supprimées doivent être incluses. boolean Les valeurs possibles sont true ou false. La valeur par défaut est false.
include-draft Indique si les brouillons d'entrées doivent être inclus ou non. boolean Les valeurs possibles sont true ou false. La valeur par défaut est false. Vous devez être le propriétaire ou l'auteur du brouillon pour l'afficher.
kind Spécifie le ou les genres d'entrées de contenu à afficher. Ceux-ci correspondent au type de page dans Google Sites. liste de chaînes séparées par des virgules Les valeurs possibles sont announcement, announcementspage, attachment, comment, filecabinet, listitem, listpage, webpage, webattachment et template.
parent Demande uniquement les entrées ayant le parent spécifié. chaîne Indiquez l'ID de l'entrée parente. Exemple : 0123456789.
path Demande de contenu appartenant à une certaine hiérarchie de pages chaîne Chemin d'accès à une sous-page d'un site dont le contenu doit être récupéré. Exemple : path=/path/to/page.

Flux de révision

Le flux de révision est un flux qui contient l'historique des révisions du contenu du site.

L'URI GET de ce flux pour un site appartenant à un domaine particulier est:

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

domainName est soit "site", soit un domaine G Suite.

siteName est le nom du site tel qu'il apparaît dans l'URL de la page de destination du site: http://sites.google.com/a/domainName/siteName.

Toutes les requêtes adressées à ce flux doivent être authentifiées.

Types de requêtes compatibles: GET

Flux de site

Ce flux permet de répertorier les sites Google appartenant à un utilisateur ou pour lesquels il dispose d'autorisations de consultation. Elle peut également être utilisée pour créer des sites, copier un site ou modifier le nom d'un site existant.

L'URI du flux pour la fiche Sites est le suivant:

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

domainName est soit "site", soit un domaine G Suite.

Toutes les requêtes adressées à ce flux doivent être authentifiées.

Types de requêtes compatibles: GET, POST, PUT

Le flux de site accepte les paramètres (facultatifs) suivants lors de l'envoi d'une requête GET pour lister les sites:

Paramètres Description Type Remarques
include-all-sites Répertorier tous les sites que l'utilisateur peut au moins consulter dans le domaine G Suite boolean Ce paramètre ne s'applique que lors de la création de listes de sites pour un domaine G Suite. Les valeurs possibles sont true ou false. La valeur par défaut est false.
with-mappings Inclut les mappages d'adresses Web dans une entrée de site. boolean Les valeurs possibles sont true ou false. La valeur par défaut est false.

Flux LCA

Le flux LCA permet de répertorier et/ou de modifier les autorisations de partage d'un site Google.

L'URI du flux pour la fiche Sites est le suivant:

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

domainName est soit "site", soit un domaine G Suite.

Toutes les requêtes adressées à ce flux doivent être authentifiées.

Types de requêtes compatibles: GET, POST, PUT, DELETE

Documentation de référence sur les paramètres de requête Google Sites

Paramètres de requête acceptés par le protocole de l'API Google Data:

  • max-results
  • published-max (flux de contenu uniquement)
  • published-min (flux de contenu uniquement)
  • start-index
  • updated-max
  • updated-min
  • q (requêtes en texte intégral)

Reportez-vous à chaque flux ci-dessus pour obtenir la liste des paramètres spécifiques à ce flux.

Haut de page