Casos de uso
Dez exemplos completos em Python: exportações em massa, automação de avaliações, relatórios analíticos, auditorias de listagens e publicação em massa.
Defina sua chave de API uma única vez antes de executar qualquer exemplo:
export LISTINGSAPI_KEY="your-api-key"1. Liste seus locais
Conecte-se e imprima a primeira página de locais.
import listingsapi client = listingsapi.ListingsAPI() page = client.locations.list(first=5)for loc in page: print(loc.name, "--", getattr(loc, "city", "N/A"), getattr(loc, "stateIso", "N/A")) print(f"Locations on page: {len(page)}, has_more: {page.has_more}")2. Exportação em massa para CSV
Baixe todos os locais em um arquivo CSV usando auto_paging_iter().
import csvimport listingsapi client = listingsapi.ListingsAPI() locations = list(client.locations.list(first=100).auto_paging_iter())print(f"Fetched {len(locations)} locations") fields = ["id", "name", "storeId", "street", "city", "stateIso", "postalCode", "countryIso", "phone"] with open("locations_export.csv", "w", newline="") as f: writer = csv.DictWriter(f, fieldnames=fields, extrasaction="ignore") writer.writeheader() for loc in locations: writer.writerow(loc.to_dict()) print("Exported to locations_export.csv")auto_paging_iter() processa automaticamente todas as páginas da paginação por cursor. Consulte Locais para ver a referência completa dos métodos.
3. Crie um local
locations.add() recebe cada campo obrigatório como argumento nomeado e valida o corpo da requisição no cliente, de modo que uma requisição inválida falhe imediatamente com uma mensagem clara antes de qualquer chamada de rede. Consulte um sub_category_id válido com client.subcategories() (use databaseId).
import listingsapifrom listingsapi import ValidationError client = listingsapi.ListingsAPI() subcategories = client.subcategories()dental = [s for s in subcategories if "dentist" in (s.get("name") or "").lower()]sub_category_id = dental[0].databaseId if dental else 1432 try: result = client.locations.add( name="Acme Dental", description=( "Acme Dental is a family-owned dental practice serving downtown " "New York for over fifteen years. Our team offers preventive care, " "cosmetic dentistry, orthodontics, and emergency appointments, with " "weekend hours and a patient-first approach that keeps every visit " "comfortable and affordable for the whole family." ), sub_category_id=sub_category_id, country_iso="US", city="New York", street="123 Jump Street", state_iso="NY", postal_code="10013", phone="6443859313", store_id="NYC-001", )except ValidationError as e: print(f"Fix the payload: {e}")else: print(f"Created location: {result.location.id}")A descrição deve ter pelo menos 200 caracteres; as plataformas de publicação a usam como texto principal da listagem. client.countries() lista os códigos ISO de países e estados aceitos, e client.plan_sites() mostra em quais diretórios seu plano permite publicar.
4. Monitoramento de avaliações
Examine as avaliações recentes e sinalize as negativas que precisam de resposta.
import listingsapi client = listingsapi.ListingsAPI() page = client.locations.list(first=5) for loc in page: print(f"\n--- {loc.name} ---") reviews = client.reviews.list(loc.id, first=10) if not reviews: print(" No recent reviews") continue for review in reviews: rating = getattr(review, "rating", "N/A") author = getattr(review, "authorName", "Anonymous") site = getattr(review, "siteName", "Unknown") responded = bool(getattr(review, "responses", None)) flag = " ** NEEDS ATTENTION **" if isinstance(rating, (int, float)) and rating <= 2 else "" status = "Responded" if responded else "No reply" print(f" [{rating}] {author} on {site} ({status}){flag}")Consulte Avaliações para ver as opções de filtro, incluindo rating_filters, site_urls e intervalos de datas.
5. Responda automaticamente às avaliações
workflows.auto_reply_to_reviews() busca avaliações recentes, filtra por nota e status da resposta e publica respostas a partir do seu modelo em uma única chamada. Visualize o resultado primeiro com dry_run=True. O marcador {rating} é substituído pela nota em estrelas de cada avaliação.
import listingsapi client = listingsapi.ListingsAPI() LOCATION_ID = 16808 # Replace with your location IDTEMPLATE = "Thanks for the {rating}-star review! We appreciate you taking the time." # Preview what would be sentpreview = client.workflows.auto_reply_to_reviews( LOCATION_ID, template=TEMPLATE, min_rating=4, dry_run=True,)for entry in preview: print(f" Would reply to {entry['id']} ({entry['rating']} stars)") # Post the replies for realresults = client.workflows.auto_reply_to_reviews( LOCATION_ID, template=TEMPLATE, min_rating=4,)sent = [r for r in results if r["status"] == "sent"]print(f"Replied to {len(sent)} of {len(results)} matching reviews")O padrão min_rating=4 ignora avaliações negativas intencionalmente: elas merecem uma resposta personalizada. Trate-as individualmente com reviews.respond():
import listingsapifrom listingsapi import APIError client = listingsapi.ListingsAPI() negative = client.reviews.list(16808, rating_filters=[1, 2], first=20)for review in negative: if getattr(review, "responses", None): continue try: client.reviews.respond( review.interactionId, "We are sorry to hear about your experience. Please reach out " "directly so we can make it right.", ) print(f"Replied to {getattr(review, 'authorName', 'Anonymous')}") except APIError as e: print(f"Failed: {e}")6. Relatório de análise
Obtenha os dados de análise do perfil no Google e as estatísticas de avaliações de cada local.
import listingsapi client = listingsapi.ListingsAPI() FROM_DATE = "2026-01-01"TO_DATE = "2026-06-30" all_locations = list(client.locations.list(first=100).auto_paging_iter())print(f"Generating report for {len(all_locations)} locations ({FROM_DATE} to {TO_DATE})\n") for loc in all_locations[:10]: print(f"--- {loc.name} ---") google = client.analytics.google(loc.id, from_date=FROM_DATE, to_date=TO_DATE) if google: print(f" Google: {google.to_dict()}") review_stats = client.reviews.analytics.overview(loc.id, start_date=FROM_DATE, end_date=TO_DATE) if review_stats: print(f" Reviews: {review_stats.to_dict()}") sites = client.reviews.analytics.sites_stats(loc.id, start_date=FROM_DATE, end_date=TO_DATE) if sites: print(f" Sites: {sites.to_dict()}") print()Consulte Análise para ver as métricas de perfil de bing() e facebook().
7. Relatório semanal de reputação
workflows.weekly_reputation_report() reúne avaliações, dados de análise de avaliações, dados de análise de perfis no Google e no Bing e o status de sincronização das listagens em um único objeto de relatório.
import listingsapi client = listingsapi.ListingsAPI() report = client.workflows.weekly_reputation_report( 16808, start_date="2026-06-29", end_date="2026-07-05",) summary = report.review_summaryprint(f"Average rating: {summary.get('averageRating')}")print(f"Recent reviews: {len(report.recent_reviews)}") analytics = report.analyticsprint(f"Google: {analytics.get('google')}")print(f"Bing: {analytics.get('bing')}") health = report.listings_healthprint(f"Listings synced: {health.get('synced')}/{health.get('total')} ({health.get('sync_rate')})")8. Auditoria da integridade das listagens
workflows.listings_health_audit() verifica as listagens premium, as listagens de voz e as duplicatas de um local e calcula uma pontuação de integridade de 0 a 100.
import listingsapi client = listingsapi.ListingsAPI() page = client.locations.list(first=10)print(f"Auditing listings for {len(page)} locations\n") for loc in page: audit = client.workflows.listings_health_audit(loc.id) print(f"--- {loc.name} ---") print(f" Health score: {audit.health_score}%") print(f" Synced: {audit.synced_count}, issues: {audit.issue_count}") print(f" Voice listings: {len(audit.voice)}, duplicates: {len(audit.duplicates)}") for issue in audit.issues: print(f" [{issue.get('syncStatus')}] {issue.get('site')}") print()Consulte Listagens para ver os métodos premium, voice, duplicates e de marcação como duplicata usados nessa operação.
9. Publique uma postagem em massa
posts.bulk_publish() publica uma postagem em vários locais, por padrão tanto no Google quanto no Facebook. Os IDs dos locais são codificados automaticamente, e o corpo da requisição é validado no cliente antes de qualquer chamada de rede.
import listingsapi client = listingsapi.ListingsAPI() result = client.posts.bulk_publish( name="Summer hours 2026", location_ids=[16808, 16809, 16810], message="We are open late all summer! Come see us until 9pm, Monday through Saturday.", media_url="https://cdn.example.com/summer-hours.jpg", cta_type="LEARN_MORE", cta_url="https://www.acmedental.com/hours",) post = result.get("socialPost") or {}print(f"Created bulk post: {post.get('id')}")Passe um dict como message para personalizar o texto por site:
result = client.posts.bulk_publish( name="July whitening offer", location_ids=[16808], message={ "GOOGLE": "20% off teeth whitening this July. Book online today!", "FACEBOOK": "July special: 20% off teeth whitening. Tap to book your visit!", }, sites=["GOOGLE", "FACEBOOK"],)Para postagens tipadas em um único site, use posts.create_announcement(), posts.create_event() ou posts.create_offer().
10. Fluxo de conexão com o Google
Gere uma URL de OAuth, liste as contas conectadas e examine as sugestões de correspondência.
import time import listingsapi client = listingsapi.ListingsAPI() # Step 1: Generate an OAuth URL (valid 24 hours)result = client.connected_accounts.connect_google( success_url="https://yourapp.com/connect/success", error_url="https://yourapp.com/connect/error",)print(f"Redirect user to: {result.get('url', 'N/A')}") # Step 2: List connected Google accounts. The payload is an offset page:# records[] plus pageInfo, not a bare list.accounts = client.connected_accounts.list(publisher="GoogleAccount", page=1, per_page=20)for acc in accounts.get("records") or []: account_id = acc["connectedAccountId"] print(f"{acc['email']} -- status: {acc['status']}") # Step 3: Kick off the fetch-and-match job for this account. client.connected_accounts.trigger_matches([account_id]) # Step 4: Matching is asynchronous. Poll the account's details until it # reports MATCH_COMPLETED, with a bounded number of attempts so a stuck # job cannot hang the script. status = None for _ in range(20): details = client.connected_accounts.details(account_id) status = (details.get("details") or {}).get("requestMatchesStatus") if status == "MATCH_COMPLETED": break time.sleep(15) if status != "MATCH_COMPLETED": print(f" matching still {status!r}, skipping for now") continue # Step 5: Only now are suggestions populated. Same offset-page shape. suggestions = client.connected_accounts.suggestions(account_id, page=1, per_page=10) records = suggestions.get("records") or [] print(f" Suggestions: {len(records)} matches found")Consultar as sugestões antes que requestMatchesStatus atinja MATCH_COMPLETED retorna um array records vazio, indistinguível do resultado de "não existem correspondências", por isso a consulta periódica garante que o procedimento funcione corretamente, sem depender do acaso. Consulte Iniciar a busca de correspondências de locais para ver os valores de status.
Confirme as correspondências com connected_accounts.confirm_matches(), passando os IDs dos registros de correspondência construídos a partir de matchedDataDatabaseId e accountType de cada registro (consulte Confirmar correspondências de conexão), e vincule uma listagem específica a um local com listings.connect().
Próximos passos
- Locais: criar, atualizar, pesquisar, arquivar
- Avaliações: listar, responder, analisar
- Listagens: premium, voz, duplicatas
- Análise: Google, Bing, Facebook
- Tratamento de erros: tipos de exceção e orientações para novas tentativas