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 de langage de programmation. Pour plus d'informations sur les bibliothèques clientes, consultez les liens figurant dans les sections spécifiques au langage de programmation du guide du développeur.
Audience
Ce document est destiné aux programmeurs qui souhaitent écrire des applications clientes pouvant 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 derrière 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 contient des descriptions de toutes les activités d'un site.
L'URI GET de ce flux pour un site appartenant à un domaine particulier est le suivant:
https://sites.google.com/feeds/activity/domainName/siteName/[activityEntryID]
domainName est soit "site", soit un domaine G Suite.
siteName correspond au 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 contient le contenu actuel et modifiable du site.
L'URI GET de ce flux pour un site dans un domaine donné est le suivant :
https://sites.google.com/feeds/content/domainName/siteName/[contentEntryID]
domainName est soit "site", soit un domaine G Suite.
siteName correspond au 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 requêtes envoyées à ce flux peuvent nécessiter ou non une authentification, en fonction des paramètres (publiés) du site.
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 émettant une requête GET à l'aide du flux de contenu:
| Paramètre | Description | Type | Remarques |
|---|---|---|---|
ancestor |
Ne demande que les entrées ayant l'ancêtre spécifié. | chaîne | Indiquez l'ID de l'entrée ancêtre souhaitée. Exemple : 0123456789. Renvoie toutes les entrées dont l'ancêtre spécifié est un parent, le parent d'un parent, etc. |
include-deleted |
Indique si les entrées supprimées doivent être incluses. | booléen | 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. | booléen | 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 pouvoir l'afficher. |
kind |
Spécifie le ou les types d'entrées de contenu à renvoyer. Elles correspondent au type de page dans Google Sites. | liste de chaînes séparées par une virgule | Les valeurs possibles sont announcement, announcementspage, attachment, comment, filecabinet, listitem, listpage, webpage, webattachment et template. |
parent |
Ne demande que les entrées ayant le parent spécifié. | chaîne | Indiquez l'ID de l'entrée parente. Exemple : 0123456789. |
path |
Demande du contenu sous une certaine hiérarchie de pages | chaîne | Chemin d'accès à une sous-page d'un site pour laquelle extraire du contenu. Exemple : path=/path/to/page. |
Flux de révisions
Le flux de révisions contient l'historique des révisions du contenu du site.
L'URI GET de ce flux pour un site appartenant à un domaine particulier est le suivant:
https://sites.google.com/feeds/revision/domainName/siteName/contentEntryID/[revisionEntryID]
domainName est soit "site", soit un domaine G Suite.
siteName correspond au 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 acceptés : GET
Flux de site
Le flux de sites peut être utilisé pour répertorier les sites Google Sites d'un utilisateur ou pour lesquels il dispose d'autorisations d'affichage. Vous pouvez également l'utiliser pour créer des sites, en copier un ou modifier le nom d'un site existant.
Voici l'URI du flux de la fiche Google Sites:
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 acceptés : GET, POST et PUT
Le flux de sites accepte les paramètres (facultatifs) suivants lorsque vous envoyez une requête GET pour les sites de fiche :
| Paramètre | Description | Type | Remarques |
|---|---|---|---|
include-all-sites |
Liste de tous les sites que l'utilisateur peut au moins consulter dans le domaine G Suite. | booléen | Ce paramètre ne s'applique que lorsque vous listez des 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. | booléen | Les valeurs possibles sont true ou false. La valeur par défaut est false. |
Flux LCA
Le flux de LCA permet de lister et/ou de modifier les autorisations de partage (LCA) d'un site Google.
L'URI du flux de 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 demandes adressées à ce flux doivent être authentifiées.
Types de requêtes compatibles: GET, POST, PUT, DELETE
Référence des paramètres de requête Google Sites
Paramètres de requête acceptés du protocole de l'API Google Data :
max-resultspublished-max(flux de contenu uniquement)published-min(flux de contenu uniquement)start-indexupdated-maxupdated-minq(requêtes textuelles complètes)
Consultez chaque flux ci-dessus pour obtenir la liste des paramètres spécifiques à ce flux.