Listings APIListings API
Masuk

Alur kerja

Fungsi bantu komposit yang menjalankan beberapa panggilan SDK dan mengembalikan satu hasil gabungan melalui client.workflows.

Semua metode alur kerja berada di client.workflows. Setiap metode menggantikan serangkaian panggilan SDK biasa yang perlu Anda tulis sendiri, dan mengembalikan satu hasil gabungan yang disusun di sisi klien. Tidak ada satu endpoint REST khusus untuk sebuah alur kerja, sehingga nama kunci dalam hasilnya berasal dari SDK, bukan nama field dalam respons REST.

Karena sebuah alur kerja melakukan beberapa panggilan, kunci API yang digunakannya harus memiliki akses ke setiap sumber daya yang diakses alur kerja tersebut, dan setiap permintaan yang mendasari satu panggilan alur kerja dihitung satu kali terhadap batas laju Anda. Metode menerima location_id, yang mendukung ID numerik atau ID yang dikodekan dengan base64, lihat ID Lokasi.

workflows.auto_reply_to_reviews

Balas ulasan suatu lokasi menggunakan templat dalam satu panggilan. Gunakan metode ini untuk menjaga tingkat respons terhadap ulasan positif sementara Anda menangani ulasan lainnya secara manual.

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]]
ParameterTipeDeskripsi
location_idstr | intLokasi yang akan diproses.
templatestrTeks balasan untuk ulasan yang sesuai. {rating} diganti dengan rating ulasan.
min_ratingintHanya membalas ulasan dengan rating ini atau lebih tinggi. Nilai defaultnya adalah 4.
only_unansweredboolLewati ulasan yang sudah memiliki balasan. Nilai defaultnya adalah True.
dry_runboolMengembalikan ulasan yang akan dibalas tanpa memublikasikan balasan. Nilai defaultnya adalah False.

Metode ini menggantikan panggilan reviews.list yang diambil per halaman menggunakan auto_paging_iter(), lalu satu panggilan reviews.respond untuk setiap ulasan yang lolos kedua filter.

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")

Mengembalikan daftar biasa berisi dict, satu untuk setiap ulasan yang ditangani, masing-masing dengan id, rating, reply, dan status. Jalankan terlebih dahulu dengan dry_run=True: entri dikembalikan dengan status bernilai dry_run agar Anda dapat memeriksa ulasan yang dipilih sebelum balasan apa pun dipublikasikan.

workflows.listings_health_audit

Ambil gambaran profil bisnis suatu lokasi dalam satu panggilan: profil bisnis premium, profil bisnis suara, duplikat, dan skor. Gunakan metode ini untuk panel kondisi per lokasi sebagai pengganti tiga panggilan terpisah.

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

Metode ini menggantikan listings.premium, listings.voice, dan listings.duplicates untuk lokasi yang sama, dengan hasil premium dihitung berdasarkan syncStatus.

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"))

Mengembalikan APIObject dengan location_id, premium, voice, duplicates, synced_count, issue_count, issues, dan health_score. health_score adalah proporsi profil bisnis premium dengan syncStatus bernilai SYNCED, dalam bentuk persentase bilangan bulat, dan bernilai 0 jika tidak ada profil bisnis premium. issues berisi profil bisnis premium yang memiliki syncStatus dengan nilai selain SYNCED.

workflows.weekly_reputation_report

Ambil ulasan, analitik ulasan, analitik profil, dan status sinkronisasi profil bisnis untuk satu lokasi dalam rentang tanggal tertentu. Gunakan metode ini untuk laporan berkala alih-alih dasbor langsung, karena metode ini melakukan lima panggilan.

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

start_date dan end_date adalah string YYYY-MM-DD, dan keduanya opsional. Metode ini menggantikan reviews.analytics.overview, reviews.list dengan first=50, analytics.google, analytics.bing, dan listings.premium, dengan rentang tanggal diteruskan ke setiap panggilan yang menerimanya.

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"))

Mengembalikan APIObject dengan location_id, review_summary (ringkasan analitik ulasan), recent_reviews (hingga 50 ulasan dalam rentang tanggal tersebut), analytics (dict dengan google dan bing), dan listings_health (dict dengan total, synced, dan sync_rate). sync_rate adalah string yang diformat sebagai persentase, dan bernilai N/A jika lokasi tersebut tidak memiliki profil bisnis premium.

Lihat juga