Listings APIListings API
Anmelden

Arbeitsabläufe

Zusammengesetzte Hilfsfunktionen, die über client.workflows mehrere SDK-Aufrufe ausführen und ein zusammengefasstes Ergebnis zurückgeben.

Alle Workflow-Methoden befinden sich unter client.workflows. Jede ersetzt eine Folge gewöhnlicher SDK-Aufrufe, die Sie sonst selbst schreiben müssten, und gibt ein kombiniertes Ergebnis zurück, das auf dem Client zusammengestellt wird. Hinter einem Workflow steht kein einzelner REST-Endpunkt; die Schlüssel im Ergebnis sind daher SDK-eigene Namen und keine Feldnamen aus einer REST-Antwort.

Da ein Workflow mehrere Aufrufe ausführt, benötigt der verwendete API-Schlüssel Zugriff auf jede Ressource, auf die der Workflow zugreift, und ein Workflow-Aufruf wird für jede zugrunde liegende Anfrage einmal auf Ihr Ratenlimit angerechnet. Die Methoden nehmen einen Parameter location_id entgegen, der numerische oder base64-kodierte IDs akzeptiert; siehe Standort-IDs.

workflows.auto_reply_to_reviews

Beantworten Sie die Bewertungen eines Standorts anhand einer Vorlage mit einem einzigen Aufruf. Verwenden Sie diese Methode, um die Antwortquote bei positiven Bewertungen hoch zu halten, während Sie die übrigen Bewertungen manuell bearbeiten.

Python
client.workflows.auto_reply_to_reviews(    location_id: str | int,    *,    template: str = "Thank you for your feedback!",    min_rating: int = 4,    only_unanswered: bool = True,    dry_run: bool = False,) -> list[dict[str, Any]]
ParameterTypBeschreibung
location_idstr | intZu verarbeitender Standort.
templatestrAntworttext für Bewertungen, die den Kriterien entsprechen. {rating} wird durch die Punktzahl der Bewertung ersetzt.
min_ratingintNur Bewertungen mit dieser oder einer höheren Punktzahl beantworten. Der Standardwert ist 4.
only_unansweredboolBewertungen überspringen, die bereits eine Antwort haben. Der Standardwert ist True.
dry_runboolZurückgeben, welche Bewertungen beantwortet würden, ohne Antworten zu veröffentlichen. Der Standardwert ist False.

Diese Methode ersetzt das seitenweise Abrufen von reviews.list mit auto_paging_iter() und anschließend einen Aufruf von reviews.respond pro Bewertung, die beide Filterkriterien erfüllt.

Python
# See what would be sent, without postingplan = client.workflows.auto_reply_to_reviews(  16808,  template="Thanks for the {rating}-star review!",  min_rating=4,  dry_run=True,)for entry in plan:  print(entry["id"], entry["rating"], entry["status"]) # Then post for realresults = client.workflows.auto_reply_to_reviews(16808, min_rating=4)print(f"Replied to {len(results)} reviews")

Gibt eine einfache Liste von dicts zurück, eines pro bearbeiteter Bewertung, jeweils mit id, rating, reply und status. Führen Sie die Methode zunächst mit dry_run=True aus: Die Einträge werden mit status auf dry_run gesetzt zurückgegeben, damit Sie die Auswahl prüfen können, bevor eine Antwort veröffentlicht wird.

workflows.listings_health_audit

Rufen Sie mit einem einzigen Aufruf eine Übersicht über die Einträge eines Standorts ab: Premium-Einträge, Einträge für Sprachassistenten, Duplikate und einen Score. Verwenden Sie diese Methode für eine Statusübersicht pro Standort anstelle von drei separaten Aufrufen.

Python
client.workflows.listings_health_audit(location_id: str | int) -> APIObject

Diese Methode ersetzt listings.premium, listings.voice und listings.duplicates für denselben Standort, wobei die Premium-Ergebnisse nach syncStatus gezählt werden.

Python
audit = client.workflows.listings_health_audit(16808)print(f"Health score: {audit.health_score}%")print(f"Synced: {audit.synced_count} of {len(audit.premium)}")print(f"Duplicates found: {len(audit.duplicates)}")for issue in audit.issues:  print(issue.get("site"), issue.get("syncStatus"))

Gibt ein APIObject mit location_id, premium, voice, duplicates, synced_count, issue_count, issues und health_score zurück. health_score ist der Anteil der Premium-Einträge, deren syncStatus den Wert SYNCED hat, als ganzzahliger Prozentwert, und hat den Wert 0, wenn keine Premium-Einträge vorhanden sind. issues enthält die Premium-Einträge, deren syncStatus weder den Wert SYNCED hat noch fehlt.

workflows.weekly_reputation_report

Rufen Sie Bewertungen, Bewertungsanalysen, Profilanalysen und den Synchronisierungsstatus der Einträge für einen Standort über einen bestimmten Zeitraum ab. Verwenden Sie diese Methode für einen regelmäßigen Bericht statt für ein Live-Dashboard, da sie fünf Aufrufe ausführt.

Python
client.workflows.weekly_reputation_report(    location_id: str | int,    *,    start_date: str | None = None,    end_date: str | None = None,) -> APIObject

start_date und end_date sind Zeichenfolgen im Format YYYY-MM-DD und beide optional. Diese Methode ersetzt reviews.analytics.overview, reviews.list mit first=50, analytics.google, analytics.bing und listings.premium, wobei der Zeitraum an jeden Aufruf weitergegeben wird, der einen solchen akzeptiert.

Python
report = client.workflows.weekly_reputation_report(  16808,  start_date="2026-09-01",  end_date="2026-09-07",)print(report.review_summary.get("averageRating"))print(report.analytics.get("google", {}).get("views"))print(report.listings_health.get("sync_rate"))

Gibt ein APIObject mit location_id, review_summary (der Übersicht der Bewertungsanalysen), recent_reviews (bis zu 50 Bewertungen im Zeitraum), analytics (einem dict mit google und bing) und listings_health (einem dict mit total, synced und sync_rate) zurück. sync_rate ist eine als Prozentwert formatierte Zeichenfolge und hat den Wert N/A, wenn der Standort keine Premium-Einträge hat.

Siehe auch