Daftar frasa ulasan | Listings API

Parameter

Query

Nama	Tipe	Wajib	Deskripsi	Default
locationIds	string	opsional	JSON array of location IDs to aggregate over, e.g. `[1800289,1800290]`. Query values are JSON-parsed, so a bare single ID also works. Omit to cover every location the key can read.	—
siteUrls	string	opsional	JSON array of review sources to include, e.g. `["maps.google.com"]`.	—
startDate	string	opsional	Only count reviews on or after this date (`YYYY-MM-DD`).	—
endDate	string	opsional	Only count reviews on or before this date (`YYYY-MM-DD`).	—
searchString	string	opsional	Only return phrases containing this substring.	—
phraseCount	integer	opsional	Maximum number of phrases to return.	—
categories	string	opsional	JSON array of interaction categories to include (see the interaction attributes reference).	—
ratingFilters	string	opsional	JSON array of star ratings to include, e.g. `[1,2]` to mine only unhappy reviews.	—
responseStatus	string	opsional	JSON array of `RESPONDED` / `PENDING` to restrict by whether the review has an owner reply.	—
sortOrder	string	opsional	One of `NEWEST_FIRST`, `OLDEST_FIRST`, `LAST_RESPONDED`, `LOWEST_RATING`, `HIGHEST_RATING`.	—
category	string	opsional	Deprecated single-value form of `categories`. Kept for v4 compatibility; prefer `categories`.	—
ratingFilter	integer	opsional	Deprecated single-value form of `ratingFilters`. Kept for v4 compatibility; prefer `ratingFilters`.	—

Respons

200Phrases with their per-phrase review stats. Response key `newReviewPhrases`, a top-level array.

Response

{  "data": {    "newReviewPhrases": [      {        "reviewPhrase": "friendly staff",        "phraseStats": {          "stats": [            { "name": "total-reviews", "value": 46, "delta": 12.5, "abs": 5 },            { "name": "overall-rating", "value": 4.7, "delta": 1.1, "abs": 0.05 }          ]        }      },      {        "reviewPhrase": "long wait",        "phraseStats": {          "stats": [            { "name": "total-reviews", "value": 11, "delta": 37.5, "abs": 3 },            { "name": "overall-rating", "value": 2.9, "delta": -8.4, "abs": -0.27 }          ]        }      }    ]  }}

401Unauthenticated, missing or invalid API key.

403The key is valid but not permitted to read one of the requested locations (`SY90003`).

Mengembalikan frasa yang berulang dalam teks ulasan suatu lokasi, masing-masing dengan statistik ulasan untuk bagian dari kumpulan ulasan yang memuat frasa tersebut. Ini menjawab pertanyaan "apa yang terus disebutkan pelanggan, dan apakah penyebutan tersebut positif atau negatif?".

data.newReviewPhrases adalah array tingkat teratas, bukan respons berpaginasi. Gunakan phraseCount untuk membatasi panjangnya.

Setiap entri memiliki:

reviewPhrase: frasa itu sendiri.
phraseStats.stats: struktur { name, value, delta } yang sama seperti pada Dapatkan analitik interaksi, yang dihitung hanya dari ulasan yang memuat frasa tersebut, ditambah field abs yang memuat perubahan absolut (bukan persentase).

Setiap filter bersifat opsional dan dapat digabungkan, sehingga rute ini juga berfungsi sebagai pencarian teks dalam ulasan: ratingFilters=[1,2] dengan startDate menghasilkan keluhan dari satu bulan terakhir, yang diurutkan berdasarkan seberapa sering keluhan tersebut berulang.

Kasus penggunaan: panel "keluhan teratas"

Untuk membuat panel keluhan bagi suatu lokasi, panggil rute ini dengan ratingFilters=[1,2], startDate yang ditetapkan ke 90 hari yang lalu, dan phraseCount=10. Hasilnya adalah 10 frasa yang paling sering muncul dalam ulasan dengan penilaian rendah. Membaca phraseStats untuk overall-rating pada setiap frasa memberi tahu Anda apakah frasa tersebut benar-benar merupakan pencilan atau sekadar kosakata umum, dan delta menunjukkan apakah kondisinya memburuk.

Karena nilai kueri diurai sebagai JSON, array disertakan dalam string kueri dalam format JSON: ?ratingFilters=[1,2]&siteUrls=["maps.google.com"].

Respons di atas adalah contoh.