Method: accounts.locations.batchGetReviews

Affiche la liste paginée des avis pour tous les établissements spécifiés. Cette opération n'est valide que si les emplacements spécifiés sont validés.

Requête HTTP

POST https://mybusiness.googleapis.com/v4/{name=accounts/*}/locations:batchGetReviews

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
name

string

Nom du compte à partir duquel récupérer une liste d'avis concernant plusieurs établissements.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON
{
  "locationNames": [
    string
  ],
  "pageSize": integer,
  "pageToken": string,
  "orderBy": string,
  "ignoreRatingOnlyReviews": boolean
}
Champs
locationNames[]

string

Ensemble d'établissements pour lesquels extraire des avis, spécifiés par leur nom.

pageSize

integer

Nombre d'avis à récupérer par page. La valeur par défaut est 50.

pageToken

string

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

orderBy

string

Facultatif. Spécifie le champ en fonction duquel les avis doivent être triés. Si aucune valeur n'est spécifiée, l'ordre des avis affichés est défini par défaut sur updateTime desc. Les ordres de tri valides sont rating, rating desc et updateTime desc. rating renvoie les avis dans l'ordre croissant. updateTime(ordre croissant) n'est pas accepté.

ignoreRatingOnlyReviews

boolean

Indique s'il faut ignorer les avis ne portant que sur les notes.

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.BatchGetReviews.

Représentation JSON
{
  "locationReviews": [
    {
      object (LocationReview)
    }
  ],
  "nextPageToken": string
}
Champs
locationReviews[]

object (LocationReview)

Avis incluant des informations de localisation.

nextPageToken

string

Si le nombre d'avis dépasse la taille de page demandée, ce champ est renseigné avec un jeton permettant de récupérer la page d'avis suivante lors des prochains appels. S'il n'y a plus d'avis, ce champ ne sera 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.

LocationReview

Représente un avis avec des informations sur l'établissement.

Représentation JSON
{
  "name": string,
  "review": {
    object (Review)
  }
}
Champs
name

string

Nom de la ressource d'emplacement.

review

object (Review)

Avis concernant l'établissement.