Method: accounts.locations.batchGetReviews

Retorna a lista paginada de avaliações de todos os locais especificados. Esta operação só é válida se os locais especificados forem verificados.

Solicitação HTTP

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

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

Parâmetros de caminho

Parâmetros
name

string

O nome da conta da qual recuperar uma lista de avaliações em vários locais.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON
{
  "locationNames": [
    string
  ],
  "pageSize": integer,
  "pageToken": string,
  "orderBy": string,
  "ignoreRatingOnlyReviews": boolean
}
Campos
locationNames[]

string

Uma coleção de locais para as quais buscar avaliações, especificados pelos nomes.

pageSize

integer

Quantas avaliações precisam ser buscadas por página. O valor padrão é 50.

pageToken

string

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

orderBy

string

Opcional. Especifica o campo pelo qual as avaliações serão classificadas. Se não for especificada, a ordem das avaliações retornadas será updateTime desc por padrão. Os pedidos válidos para classificação são rating, rating desc e updateTime desc. rating retornará avaliações em ordem crescente. updateTime(ou seja, ordem crescente) não é aceito.

ignoreRatingOnlyReviews

boolean

Define se as avaliações somente com classificação serão ignoradas.

Corpo da resposta

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

Mensagem de resposta para Reviews.BatchGetReviews.

Representação JSON
{
  "locationReviews": [
    {
      object (LocationReview)
    }
  ],
  "nextPageToken": string
}
Campos
locationReviews[]

object (LocationReview)

Avaliações com informações de local.

nextPageToken

string

Se o número de avaliações exceder o tamanho da página solicitado, esse campo será preenchido com um token para buscar a próxima página de avaliações em chamadas subsequentes. Se não houver mais avaliações, este campo não estará presente na resposta.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

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

Para mais informações, consulte a Visão geral do OAuth 2.0.

LocationReview

Representa uma avaliação com informações de local.

Representação JSON
{
  "name": string,
  "review": {
    object (Review)
  }
}
Campos
name

string

Nome do recurso de local.

review

object (Review)

Uma avaliação do local.