Editar configurações de avaliações de um local

Parâmetros

Corpo

Um campo aninhado marcado como obrigatório só se aplica quando você envia o campo pai. Se o campo pai for opcional e você o omitir, os campos filhos obrigatórios não se aplicam.

Nome	Tipo	Obrigatório	Descrição
locationId	string	obrigatório	Location to update, as its Base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`). This is a body field, so unlike path parameters a raw numeric ID is not converted and fails with `SY90002: Invalid Id`.
siteUrls	array	opcional	The complete set of review sources for the location. This REPLACES the current selection, so send every source you want kept, not just the additions.
siteUrls[].name	string	opcional	Site key, as returned in `siteSettings[].name` (e.g. `maps.google.com`, `yelp.com`).
siteUrls[].url	string	opcional	The location's page URL on that site. Send `null` or omit to stop monitoring a source that needs an explicit URL.
positiveInteractionThreshold	integer	opcional	Star rating at or above which a review counts as positive. Sent on its own, it leaves the source selection untouched.

Exemplo de requisição

Corpo pronto para colar. Substitua os IDs e valores de exemplo pelos seus.

Request body

{  "locationId": "TG9jYXRpb246MTgwMDI4OQ==",  "positiveInteractionThreshold": 4,  "siteUrls": [    { "name": "maps.google.com", "url": null },    { "name": "yelp.com", "url": "https://www.yelp.com/biz/blue-bottle-coffee-oakland" }  ]}

Respostas

200Settings applied. `data.editInteractionsSetting.interactionSetting` returns the stored settings; `errors` is `null` on success.

Response

{  "data": {    "editInteractionsSetting": {      "errors": null,      "interactionSetting": {        "id": "1800289",        "locationId": "1800289",        "positiveInteractionThreshold": 4,        "siteSettings": [          { "name": "maps.google.com", "url": null, "monitored": true, "canRespond": true },          { "name": "yelp.com", "url": "https://www.yelp.com/biz/blue-bottle-coffee-oakland", "monitored": true, "canRespond": false }        ]      }    }  }}

401Unauthenticated, missing or invalid API key.

403The key is valid but not permitted to change review settings for this location (`SY90003`).

Atualiza as fontes de avaliações nas quais um local é monitorado e a nota que faz uma avaliação ser considerada positiva. Para consultar essas mesmas configurações, use Listar fontes de avaliações de um local.

siteUrls é uma substituição, não um patch. O array que você envia passa a ser a seleção de fontes do local. Para adicionar uma fonte, primeiro leia o siteSettings atual e envie de volta as entradas existentes junto com a nova; enviar um array com um único elemento remove silenciosamente todas as outras fontes.

Os dois campos são independentes. Envie apenas positiveInteractionThreshold para alterar a nota de corte sem modificar as fontes, ou apenas siteUrls para alterar as fontes sem modificar a nota de corte.

Adicionar uma fonte agenda uma coleta de dados para ela, portanto as avaliações de um site recém-adicionado chegam de forma assíncrona, e não nesta resposta. Uma fonte rejeitada pela validação (uma URL inacessível ou uma fonte não incluída no plano da conta) é retornada em errors, sem alteração na configuração, portanto verifique errors mesmo ao receber 200.

Caso de uso: configuração inicial da página de um local no Yelp

Logo após a criação de um local, suas fontes do Google e do Facebook são monitoradas automaticamente, mas uma página do Yelp precisa ser especificada explicitamente. Leia a seleção atual na rota de configurações, acrescente { "name": "yelp.com", "url": "<the location's Yelp URL>" } e envie de volta o array completo com o ID do local. A coleta de dados é colocada na fila imediatamente, e as primeiras avaliações do Yelp aparecem em Listar interações assim que ela é concluída.

Este endpoint altera as configurações de monitoramento em uso. A requisição e a resposta de exemplo acima são ilustrativas.

curl -X POST 'https://listingsapi.com/api/v4/locations/reviews/settings/edit' \ -H "Authorization: API $LISTINGSAPI_KEY" \ -H 'Content-Type: application/json' \ -d '{ "locationId": "TG9jYXRpb246MTgwMDI4OQ==", "positiveInteractionThreshold": 4, "siteUrls": [ { "name": "maps.google.com", "url": null }, { "name": "yelp.com", "url": "https://www.yelp.com/biz/blue-bottle-coffee-oakland" } ] }'