Method: accounts.locations.reviews.list

Retorna a lista paginada de avaliações do local especificado. Esta operação só será válida se o local especificado for verificado.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

O nome do local para o qual as avaliações serão buscadas.

Parâmetros de consulta

Parâmetros
pageSize

integer

O número de avaliações a serem buscadas por página. O máximo de pageSize é 50.

pageToken

string

Se especificado, busca a próxima página de avaliações.

orderBy

string

Especifica o campo pelo qual as avaliações serão classificadas. Se não for especificado, a ordem das avaliações retornadas será padronizada como updateTime desc. Os pedidos válidos pelos quais será feita a classificação são rating, rating desc e updateTime desc.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para Reviews.ListReviews.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON
{
  "reviews": [
    {
      object (Review)
    }
  ],
  "averageRating": number,
  "totalReviewCount": integer,
  "nextPageToken": string
}
Campos
reviews[]

object (Review)

As avaliações.

averageRating

number

A nota média de todas as avaliações para este local em uma escala de 1 a 5, sendo 5 a classificação mais alta.

totalReviewCount

integer

O número total de avaliações para este local.

nextPageToken

string

Se o número de avaliações exceder o tamanho solicitado da página, esse campo será preenchido com um token para buscar a próxima página de avaliações em uma chamada subsequente para "reviews.list". Se não houver mais avaliações, esse campo não vai aparecer na resposta.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte OAuth 2.0 Overview.