- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- LocationReview
Retorna a lista paginada de avaliações de todos os locais especificados. Esta operação só será 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 |
O nome da conta de que será extraída 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[] |
Uma coleção de locais para os quais as avaliações serão buscadas, especificados pelos nomes. |
pageSize |
O número de avaliações a serem buscadas por página. O valor padrão é 50. |
pageToken |
Se especificado, busca a próxima página de avaliações. |
orderBy |
Opcional. 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 |
ignoreRatingOnlyReviews |
Define se as avaliações que mostram somente notas com estrelas serão ignoradas. |
Corpo da resposta
Mensagem da resposta para "Reviews.BatchGetReviews".
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
| Representação JSON |
|---|
{
"locationReviews": [
{
object ( |
| Campos | |
|---|---|
locationReviews[] |
Avaliações com informações de local. |
nextPageToken |
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. Se não houver mais avaliações, este campo não estará presente na resposta. |
Escopos de autorização
Requer um dos seguintes escopos do OAuth:
https://www.googleapis.com/auth/plus.business.managehttps://www.googleapis.com/auth/business.manage
Para mais informações, consulte OAuth 2.0 Overview.
LocationReview
Representa uma avaliação com informações de local.
| Representação JSON |
|---|
{
"name": string,
"review": {
object ( |
| Campos | |
|---|---|
name |
Nome do recurso de local. |
review |
Uma avaliação do local. |