Google Rich Snippet
Objectif
Les Google Rich Snippet vous permettent d’afficher une notation en étoiles lorsque les pages de votre site apparaissent dans les résultats naturels de Google :
Cette méthode vous renvoie le Rich Snippet à intégrer au sein de votre site pour obtenir cette notation en étoiles.
Format de réponse
Par défaut, l’API offre une réponse au format JSON. Pour bénéficier d’une réponse en XML, vous devez placer dans votre requête un header de type « Accept » avec la valeur « application/xml ».
Signature
GET https://api.monaviscompte.fr/rich_snippet/:id?private_key=:private_key
Exemple : https://api.monaviscompte.fr/rich_snippet/794173?private_key=efr9-kk7p-ah68-j9nw
Paramètres
nom | requis | type | description |
---|---|---|---|
id | oui | int | identifiant de la fiche |
private_key | oui | string | clé d’authentification privée |
Données retournées
nom | type | description |
---|---|---|
item_id | int | l’identifiant de la fiche |
code | string | le code du rich snippet, au format ld+json |
Code de retour
code de retour | raison |
---|---|
HTTP 200 | succès |
HTTP 401 | authentification échouée |
HTTP 404 | la fiche n’existe pas |
Réponse JSON
{
"code"
: "<script type=\"application/ld+json\">{\"@context\":\"http://schema.org\", \"@type\": \"WebPage\",\"name\":\"monpetitdressing.com\", \"description\": \"Marque de mode commercialisant des vêtements\", \"aggregateRating\": {\"@type\": \"AggregateRating\", \"ratingValue\": \"3.192\", \"bestRating\": \"5\", \"worstRating\": \"0\", \"reviewCount\": \"25\"}}</script>",
"item_id"
: 794173
}
Réponse XML
<
rich_snippet
>
<
item_id
>791473</
all_reviews_count
>
<
code
>
<script type="application/ld+json">{"@context": "http://schema.org","@type": "WebPage","name": "monpetitdressing.com","description": "Marque de mode commercialisant des vêtements","aggregateRating": {"@type": "AggregateRating","ratingValue": "3.192","bestRating": "5","worstRating": "0","reviewCount": "25"}}</script>
</code
>
</
rating
>
Tests
Google met à disposition un outil très pratique pour tester la mise en place des Rich Snippets sur votre site. Cette étape de validation est recommandée pour valider vos développements. Veuillez bien prendre en compte que l’apparition des étoiles prend plusieurs jours, et que d’autre part la validation « technique » ne garantit pas l’apparition des étoiles.