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 obtenir des informations de référence sur les bibliothèques clientes, consultez les liens dans les sections spécifiques aux langages 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. Il suppose que vous comprenez les concepts présentés dans le guide du protocole et les idées générales du 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é est un flux contenant des descriptions de toutes les activités d'un site.
L'URI GET de ce flux pour un site dans un domaine spécifique est le suivant :
https://sites.google.com/feeds/activity/domainName/siteName/[activityEntryID]
domainName est "site" ou 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 demandes acceptés : GET
Flux de contenu
Le flux de contenu est un flux contenant le contenu actuel et modifiable du site.
L'URI GET de ce flux pour un site dans un domaine spécifique est :
https://sites.google.com/feeds/content/domainName/siteName/[contentEntryID]
domainName est "site" ou 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.
L'authentification peut être requise ou non pour les requêtes adressées à ce flux, en fonction des paramètres (publiés) du site.
Types de demandes acceptés : GET, POST, PUT, DELETE
En plus des paramètres de requête standard de l'API Data, l'API Sites Data autorise les paramètres facultatifs suivants pour l'envoi d'une requête GET à l'aide du flux de contenu :
| Paramètre | Description | Type | Remarques |
|---|---|---|---|
ancestor |
Ne demande que les entrées qui ont 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 le parent, le parent du 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 entrées brouillons doivent être incluses. | 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. Ils suivent le 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 qui ont le parent spécifié. | chaîne | Indiquez l'ID de l'entrée parente. Exemple : 0123456789. |
path |
Demander du contenu sous une certaine hiérarchie de pages | chaîne | Chemin d'accès à une sous-page d'un site pour lequel récupérer du contenu. Exemple : path=/path/to/page. |
Flux de révisions
Le flux de révisions est un flux contenant l'historique des révisions du contenu du site.
L'URI GET de ce flux pour un site dans un domaine spécifique est :
https://sites.google.com/feeds/revision/domainName/siteName/contentEntryID/[revisionEntryID]
domainName est "site" ou 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 demandes acceptés : GET
Flux de site
Le flux de sites peut être utilisé pour lister les sites Google Sites dont un utilisateur est propriétaire ou pour lesquels il dispose d'autorisations d'affichage. Vous pouvez également l'utiliser 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 "site" ou un domaine G Suite.
Toutes les requêtes adressées à ce flux doivent être authentifiées.
Types de demandes acceptés : GET, POST, PUT
Le flux de sites accepte les paramètres facultatifs suivants lorsque vous envoyez une requête GET pour lister les sites :
| Paramètre | Description | Type | Remarques |
|---|---|---|---|
include-all-sites |
Liste 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 ACL
Le flux LCA peut être utilisé pour lister et/ou modifier les autorisations de partage (LCA) 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 "site" ou un domaine G Suite.
Toutes les requêtes adressées à ce flux doivent être authentifiées.
Types de demandes acceptés : GET, POST, PUT, DELETE
Référence des paramètres de requête Google Sites
Paramètres de requête compatibles du protocole Google Data API :
max-resultspublished-max(flux de contenu uniquement)published-min(flux de contenu uniquement)start-indexupdated-maxupdated-minq(requêtes en texte intégral)
Consultez chaque flux ci-dessus pour obtenir la liste des paramètres spécifiques à ce flux.