Avaliações

Liste avaliações, publique e edite respostas e obtenha dados analíticos via client.reviews.

Todos os métodos de avaliação estão em client.reviews. As análises de avaliações estão no sub-recurso aninhado client.reviews.analytics.

Os métodos de leitura retornam um APIObject (acesso por ponto, acesso como dict, .get(), .to_dict()), uma lista de APIObject ou um SyncPage para resultados paginados. Os métodos de escrita (respond, edit_response, archive_response, edit_settings) lançam ValidationError se a plataforma rejeitar a alteração, mesmo quando o status HTTP for 200, então você nunca precisa verificar indicadores de sucesso no resultado.


reviews.list

Liste avaliações de um local com filtros opcionais. Retorna um SyncPage.

Python
client.reviews.list(    location_id: str | int,    *,    first: int | None = None,    after: str | None = None,    before: str | None = None,    last: int | None = None,    site_urls: list[str] | None = None,    start_date: str | None = None,    end_date: str | None = None,    category: str | None = None,    rating_filters: list[int] | None = None,) -> SyncPage
ParâmetroTipoDescrição
location_idstr | intLocal cujas avaliações serão listadas, identificado por um valor numérico (16808) ou em base64 ("TG9jYXRpb246MTY4MDg=").
first / lastintTamanho da página, contado a partir do início ou do fim do conjunto de resultados.
after / beforestrCursores opacos de paginação.
site_urlslist[str]Somente avaliações provenientes destas URLs de páginas de avaliações.
start_date / end_datestrLimites de data no formato YYYY-MM-DD.
categorystrFiltre por categoria de avaliação.
rating_filterslist[int]Somente estas notas em estrelas, e.g. [1, 2].
Python
# Recent reviewspage = client.reviews.list(16808, first=10)for review in page:  print(review.rating, review.authorName) # 1- and 2-star only, this yearpage = client.reviews.list(  16808,  rating_filters=[1, 2],  start_date="2026-01-01",  first=50,) # Auto-paginate all reviewsfor review in client.reviews.list(16808, first=100).auto_paging_iter():  print(review.content)

reviews.details

Obtenha informações detalhadas sobre avaliações específicas pelo ID de interação. Os IDs de interação vêm do campo interactionId dos itens retornados por reviews.list.

Python
client.reviews.details(interaction_ids: list[str]) -> APIObject
Python
details = client.reviews.details(["uuid-1", "uuid-2"])print(details.to_dict())

reviews.respond

Publique uma resposta a uma avaliação.

Python
client.reviews.respond(interaction_id: str, content: str) -> APIObject
Python
result = client.reviews.respond(  interaction_id="review-uuid",  content="Thank you for your feedback, we really appreciate it!",)print(result.to_dict())

reviews.edit_response

Edite uma resposta existente.

Python
client.reviews.edit_response(    review_id: str,    response_id: str,    content: str,) -> APIObject
Python
client.reviews.edit_response(  review_id="review-uuid",  response_id="response-uuid",  content="Updated reply text.",)

reviews.archive_response

Arquive (oculte) uma resposta.

Python
client.reviews.archive_response(response_id: str) -> APIObject
Python
client.reviews.archive_response("response-uuid")

reviews.settings

Obtenha as configurações das fontes de avaliações de um local.

Python
client.reviews.settings(location_id: str | int) -> APIObject
Python
settings = client.reviews.settings(16808)print(settings.to_dict())

reviews.edit_settings

Atualize as URLs das fontes de avaliações de um local. Cada entrada é um dict que descreve uma página de avaliações.

Python
client.reviews.edit_settings(    location_id: str | int,    site_urls: list[dict],) -> APIObject
Python
client.reviews.edit_settings(16808, site_urls=[  {"url": "https://www.google.com/maps/...", "active": True},])

reviews.site_config

Obtenha os sites de avaliações elegíveis para a conta.

Python
client.reviews.site_config() -> list[APIObject]
Python
sites = client.reviews.site_config()for site in sites:  print(site.to_dict())

reviews.phrases

Obtenha expressões mencionadas com frequência, extraídas das avaliações. Passe os IDs dos locais em base64.

Python
client.reviews.phrases(    location_ids: list[str],    *,    site_urls: list[str] | None = None,    start_date: str | None = None,    end_date: str | None = None,) -> list[APIObject]
Python
phrases = client.reviews.phrases(  ["TG9jYXRpb246MTY4MDg=", "TG9jYXRpb246MTQwMjQ="],  start_date="2026-01-01",  end_date="2026-06-30",)for p in phrases:  print(p.to_dict())

Sub-recurso de análise

reviews.analytics.overview

Obtenha estatísticas gerais de avaliações (totais, nota média, taxa de resposta).

Python
client.reviews.analytics.overview(    location_id: str | int,    *,    start_date: str | None = None,    end_date: str | None = None,) -> APIObject
Python
stats = client.reviews.analytics.overview(  16808,  start_date="2026-01-01",  end_date="2026-06-30",)print(stats.to_dict())

reviews.analytics.timeline

Obtenha análises de avaliações ao longo do tempo.

Python
client.reviews.analytics.timeline(    location_id: str | int,    *,    start_date: str | None = None,    end_date: str | None = None,) -> APIObject
Python
timeline = client.reviews.analytics.timeline(  16808,  start_date="2026-01-01",  end_date="2026-06-30",)print(timeline.to_dict())

reviews.analytics.sites_stats

Obtenha análises de avaliações discriminadas por site (Google, Facebook, Yelp).

Python
client.reviews.analytics.sites_stats(    location_id: str | int,    *,    start_date: str | None = None,    end_date: str | None = None,) -> APIObject
Python
sites = client.reviews.analytics.sites_stats(  16808,  start_date="2026-01-01",  end_date="2026-06-30",)print(sites.to_dict())

Veja também

  • Locais: obtenha IDs de locais
  • Análises: métricas de perfis do Google, Bing e Facebook
  • Casos de uso: exemplos de implementação de monitoramento de avaliações e respostas automáticas