Atenção: a v4.7 da API foi lançada. Consulte o registro de alterações. As postagens relacionadas à COVID-19 ainda estão permitidas temporariamente para redes.

Trabalhar com dados de avaliação

Neste tutorial, mostramos como exibir, retornar, responder e excluir uma avaliação. Com a API Google My Business, você pode usar os dados de avaliação para as seguintes operações:

Antes de começar

Antes de usar a API Google My Business, você precisa registrar seu aplicativo e receber as credenciais do OAuth 2.0. Para saber como começar a usar a API GMB, consulte Configuração básica.

Exibir todas as avaliações

Exiba todas as avaliações de um local para gerenciar avaliações em massa. Use a API accounts.locations.reviews.list para retornar todas as avaliações associadas a um local.

Para isso, utilize o código abaixo:

HTTP
GET
https://mybusiness.googleapis.com/v4/accounts/{accountId}/locations/{locationId}/reviews
Java

A função a seguir chama Mybusiness.Accounts.Locations.Reviews.List.

/**
 * Returns a list of reviews.
 * @param locationName Name of the location to retrieve reviews for.
 * @return List<Reviews> A list of reviews.
 * @throws Exception
 */
public static List<Review> listReviews(String locationName) throws Exception {
  Mybusiness.Accounts.Locations.Reviews.List reviewsList =
    mybusiness.accounts().locations().reviews().list(locationName);
  ListReviewsResponse response = accountsList.execute();
  List<Reviews> reviews = response.getReviews();

  for (Reviews review : reviews) {
    System.out.println(review.toPrettyString());
  }
  return reviews;
}

Ver uma avaliação específica

Retorne uma avaliação específica por nome. Use a API accounts.locations.reviews.get para ver uma avaliação específica associada a um local.

Para isso, utilize o código abaixo:

HTTP
GET
https://mybusiness.googleapis.com/v4/accounts/{accountId}/locations/{locationId}/reviews/{reviewId}
Java

A função a seguir chama Mybusiness.Accounts.Locations.Reviews.Get.

/**
 * Demonstrates getting a review by name.
 * @param reviewName The name (resource path) of the review to retrieve.
 * @return Account The requested review.
 */
private static Review getReview(String reviewName) throws Exception {
  Mybusiness.Accounts.Locations.Reviews.Get review =
      mybusiness.accounts().locations().reviews().get(reviewName);
  Review response = review.execute();

  return response;
}

Dados adicionais

A biblioteca de cliente Java oferece acesso a dados de campo adicionais para instâncias de avaliações. Use os seguintes métodos para retornar dados adicionais sobre avaliações:

  • getReviewId()
  • getComment()
  • getReviewer()
  • getStarRating()
  • getCreateTime()
  • getReviewReply()

Ver avaliações de vários locais

Veja as avaliações de vários locais com uma única solicitação usando a API accounts.locations.batchGetReview.

Para isso, utilize o código abaixo:

HTTP

POST
https://mybusiness.googleapis.com/v4/accounts/{accountId}/locations:batchGetReviews

{
  "locationNames": [
    string
  ],
  "pageSize": number,
  "pageToken": string,
  "orderBy": string,
  "ignoreRatingOnlyReviews": boolean
}

Responder a uma avaliação

Responda a uma avaliação específica associada a um local ou crie uma nova resposta usando a API accounts.locations.reviews.updateReply.

Para isso, utilize o código abaixo:

HTTP
PUT
https://mybusiness.googleapis.com/v4/accounts/{accountId}/locations/{locationId}/reviews/{reviewId}/reply

{
  comment: "Thank you for visiting our business!"
}
Java

A função a seguir chama Mybusiness.accounts.locations.reviews.reply.


/*
 * Updates the reply for a location review.
 * If a review does not exist, creates a new one.
 * @param reviewName Name of the review being responded to.
 * @param comment A string containing the review response body.
 * @throws IOException
 */
private static Reply reply(String reviewName, String comment) throws IOException {

  MyBusiness.Accounts.Locations.Reviews.Reply reply =
    mybusiness().accounts().locations().reviews().reply(reviewName, comment);

  Reply response  = reviewReply.execute();

  return response;
}

Excluir uma resposta de avaliação

Exclua uma resposta a uma avaliação específica associada a um local usando a API accounts.locations.reviews.deleteReply.

Para isso, utilize o código abaixo:

HTTP
DELETE
https://mybusiness.googleapis.com/v4/accounts/{accountId}/locations/{locationId}/reviews/{reviewId}/reply
Java

A função a seguir chama Mybusiness.Accounts.Locations.Reviews.DeleteReply.

/**
 * Demonstrates deleting a review reply by name.
 * @param reviewName The name (resource path) of the review reply to delete.
 * @return Account The requested review.
 */
private static DeleteReply deleteReply(String reviewName) throws Exception {
  Mybusiness.Accounts.Locations.Reviews.DeleteReply toDelete =
      mybusiness.accounts().locations().reviews().deleteReply(reviewName);
  DeleteReply response = toDelete.execute();

  return response;
}