Guide de référence

Important: Il s'agit d'une ancienne version de cette page. Pour obtenir la dernière version, utilisez les liens de la barre de navigation de gauche.

Ce document fournit une documentation de référence détaillée sur le protocole brut (XML et HTTP) de l'API Blogger 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 des sections spécifiques au langage de programmation du guide du développeur.

Sommaire

Audience

Ce document s'adresse aux programmeurs qui souhaitent écrire des applications clientes pouvant interagir avec Blogger.

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 développeur et les idées générales derrière le protocole des API Google Data.

Types de flux Blogger

Blogger propose deux représentations du contenu de votre blog dans les flux: les flux complets et les flux récapitulatifs. Un flux complet contient des articles de blog complets, tandis qu'un flux récapitulatif ne contient qu'un court extrait de chaque article.

Le propriétaire d'un blog peut spécifier, à l'aide des paramètres de l'IUG, si le blog fournit un flux complet ou un flux récapitulatif aux agrégateurs et aux syndicateurs.

Lorsque votre application cliente envoie une requête non authentifiée pour un flux, elle reçoit le type de flux spécifié par le propriétaire du blog.

Toutefois, lorsque votre application cliente envoie une requête authentifiée, elle reçoit toujours un flux complet, quel que soit ce que le propriétaire du blog a spécifié.

Référence des paramètres de requête Blogger

L'API Blogger Data est compatible avec la quasi-totalité des paramètres de requête standards de l'API Google Data.

Blogger n'est pas compatible avec les paramètres q (recherche de texte) et author.

Les paramètres de requête updated-min et updated-max sont ignorés, sauf si le paramètre orderby est défini sur updated. Par exemple, l'URL suivante récupère tous les articles de blog qui ont été mis à jour du 16 mars 2008 au 24 mars 2008:

http://www.blogger.com/feeds/blogID/posts/default?updated-min=2008-03-16T00:00:00&updated-max=2008-03-24T23:59:59&orderby=updated

Référence des éléments Blogger

L'API Blogger Data n'utilise que des éléments Atom standards. Pour en savoir plus, consultez les spécifications du format de syndication Atom 1.0 et le protocole de publication Atom.

Le reste de cette section fournit quelques remarques spécifiques sur l'utilisation de certains éléments standards par Blogger.

Entrées brouillons

Un brouillon d'article de blog est marqué à l'aide de l'élément d'extension <app:draft> défini dans le document du protocole de publication Atom. Voici un exemple de brouillon d'entrée:

<entry xmlns:app='http://purl.org/atom/app#'>
...
<app:control>
<app:draft>yes</app:draft>
</app:control>
</entry>

Si aucun élément <draft> n'est spécifié, l'entrée n'est pas un brouillon.

Dates de publication et de mise à jour

Le code temporel indiqué dans l'élément <published> Atom standard correspond à la "date de publication" qu'un utilisateur peut définir dans l'interface graphique de Blogger.

Lorsque votre client crée une entrée, si celui-ci ne spécifie pas de valeur pour <published>, Blogger définit la date de publication de l'entrée sur l'heure actuelle du serveur. Lorsque votre client modifie une entrée, mais ne spécifie pas de valeur <published>, Blogger ne modifie pas la date de publication de l'entrée.

Toutefois, si votre client spécifie une valeur pour l'élément <published> lors de la création ou de la modification d'une entrée, Blogger définit la date de publication de l'entrée sur la valeur spécifiée. Cela peut être utile pour des tâches telles que l'importation d'anciennes entrées à partir d'un autre système de blog (tout en conservant les dates de création d'origine).

Blogger utilise l'élément Atom <updated> standard pour indiquer la date et l'heure de la dernière modification d'une entrée. Votre client ne peut pas contrôler la valeur <updated>. Blogger définit toujours la date de la dernière mise à jour de l'entrée sur l'heure actuelle du serveur chaque fois que votre client publie ou modifie une entrée.

Vous pouvez utiliser les paramètres de requête standards de l'API Google Data published-min, published-max, updated-min et updated-max pour demander des entrées en fonction de leurs valeurs <published> ou <updated>. Toutefois, pour en savoir plus sur les requêtes sur les dates mises à jour, consultez la documentation de référence sur les paramètres de requête Blogger.

Associer des commentaires à des posts

Le format d'exportation Blogger contient à la fois des articles et des commentaires dans un document de flux Atom. Pour différencier les deux types d'entrées, Blogger utilise l'élément <atom:category>. Cet élément comporte un paramètre term qui indique si l'entrée concerne un post ou un commentaire.

De plus, l'association de l'entrée de commentaire à l'entrée de post à laquelle elle appartient est effectuée à l'aide de l'extension de threading Atom. Dans l'exemple ci-dessous, l'élément <thr:in-reply-to> de l'entrée de commentaire pointe vers le post à l'aide de l'identifiant de l'entrée de post dans le paramètre ref. Il renvoie également à l'URL HTML du post via le paramètre href.

<feed xmlns="http://www.w3.org/2005/Atom" xmlns:openSearch="http://a9.com/-/spec/opensearchrss/1.0/"
      xmlns:thr="http://purl.org/syndication/thread/1.0">
  ...

  <-- A blog post entry -->
  <entry>
    <id>tag:blogger.com,1999:blog-blogID.post-postID</id>
    <content type="html">This is my first post</content>
    <link rel="alternate" type="text/html"
      href="http://blogName.blogspot.com/2007/04/first-post.html">
    </link>
    <category scheme="http://schemas.google.com/g/2005#kind" 
              term="http://schemas.google.com/blogger/2008/kind#post"/>
    ...
  </entry>

  <-- A comment to the blog post entry -->
  <entry>
    <id>tag:blogger.com,1999:blog-blogID.post-postID.comment-commentID</id>
    <content type="html">This is my first commment</content>
    <category scheme="http://schemas.google.com/g/2005#kind" 
              term="http://schemas.google.com/blogger/2008/kind#comment"/>
    <thr:in-reply-to href="http://blogName.blogspot.com/2007/04/first-post.html" 
                     ref="tag:blogger.com,1999:blog-blogID.post-postID" 
                     type="text/html"/>
    ...
  </entry>
</feed>

Haut de page