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 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 souhaitant développer des applications clientes capables d'interagir avec Google Sites.
C'est un document de référence. il part du principe que vous comprenez les concepts présentés dans le guide du protocole et les idées générales qui sous-tendent 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é est un flux contenant les 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 "site" ou un domaine G Suite.
siteName est le nom du site tel qu'il apparaît dans l'URL de sa page de destination: 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 inclut le contenu actuel et modifiable du site.
L'URI GET
de ce flux pour un site appartenant à un domaine particulier est le suivant:
https://sites.google.com/feeds/content/domainName/siteName/[contentEntryID]
domainName est "site" ou un domaine G Suite.
siteName est le nom du site tel qu'il apparaît dans l'URL de sa page de destination: 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 du site (publiés).
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 :
émission d'une requête GET
via le flux de contenu:
Paramètre | Description | Type | Remarques |
---|---|---|---|
ancestor |
Demande uniquement 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 un parent, le parent d'un parent, etc. |
include-deleted |
Spécifie 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 l'afficher. |
kind |
Spécifie le ou les genres 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
template |
parent |
Demande uniquement les entrées qui ont 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 lequel extraire du contenu. Exemple : path=/path/to/page . |
Flux de révision
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 "site" ou un domaine G Suite.
siteName est le nom du site tel qu'il apparaît dans l'URL de sa page de destination: 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
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. Il peut aussi être utilisées pour créer, copier ou modifier le nom d'un site existant.
Voici l'URI du flux de la fiche Sites:
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 requêtes compatibles: GET
, POST
, PUT
Le flux de site accepte les paramètres (facultatifs) suivants lorsqu'il envoie une requête GET
pour répertorier des sites:
Paramètre | Description | Type | Remarques |
---|---|---|---|
include-all-sites |
Répertorier tous les sites que l'utilisateur du domaine G Suite peut au moins consulter. | booléen | Ce paramètre ne s'applique que lorsqu'il répertorie les sites d'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 LCA permet de répertorier et/ou de modifier les autorisations de partage (LCA) d'un site Google.
Voici l'URI du flux de la fiche Sites:
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 requêtes compatibles: GET
, POST
, PUT
, DELETE
Référence des paramètres de requête Google Sites
Paramètres de requête compatibles avec 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 textuelles complètes)
Consultez la liste des paramètres propres à chaque flux pour chaque flux ci-dessus.