- Requête HTTP
- Paramètres de chemin d'accès
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
- LocationReview
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 |
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[] |
Ensemble d'établissements pour lesquels extraire des avis, spécifiés par leur nom. |
pageSize |
Nombre d'avis à récupérer par page. La valeur par défaut est 50. |
pageToken |
Si elle est spécifiée, elle extrait la page d'avis suivante. |
orderBy |
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 |
ignoreRatingOnlyReviews |
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 ( |
Champs | |
---|---|
locationReviews[] |
Avis incluant des informations de localisation. |
nextPageToken |
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 ( |
Champs | |
---|---|
name |
Nom de la ressource d'emplacement. |
review |
Avis concernant l'établissement. |