Method: accounts.locations.reviews.list

Affiche la liste paginée des avis pour l'établissement spécifié. Cette opération n'est valide que si l'établissement spécifié est validé.

Requête HTTP

GET https://mybusiness.googleapis.com/v4/{parent=accounts/*/locations/*}/reviews

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Nom de l'établissement pour lequel extraire les avis.

Paramètres de requête

Paramètres
pageSize

integer

Nombre d'avis à extraire par page. La valeur maximale de pageSize est de 50.

pageToken

string

Si elle est spécifiée, la page d'avis suivante est récupérée.

orderBy

string

Spécifie le champ selon lequel trier les avis. Si aucune valeur n'est spécifiée, l'ordre des avis renvoyés sera défini par défaut sur updateTime desc. Les ordres de tri valides sont rating, rating desc et updateTime desc.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Message de réponse pour Reviews.ListReviews.

Représentation JSON
{
  "reviews": [
    {
      object (Review)
    }
  ],
  "averageRating": number,
  "totalReviewCount": integer,
  "nextPageToken": string
}
Champs
reviews[]

object (Review)

Les avis

averageRating

number

Note moyenne de tous les avis pour cet établissement, sur une échelle de 1 à 5 (5 étant la note la plus élevée).

totalReviewCount

integer

Nombre total d'avis pour cet établissement.

nextPageToken

string

Si le nombre d'avis dépasse la taille de page demandée, ce champ est renseigné avec un jeton permettant d'extraire la page d'avis suivante lors d'un appel ultérieur à reviews.list. S'il n'y a plus d'avis, ce champ n'est pas présent dans la réponse.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/plus.business.manage
  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la Présentation d'OAuth 2.0.