レビュー内のフレーズを一覧表示

パラメーター

クエリ

名前	型	必須	説明	デフォルト
locationIds	string	任意	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	任意	JSON array of review sources to include, e.g. `["maps.google.com"]`.	—
startDate	string	任意	Only count reviews on or after this date (`YYYY-MM-DD`).	—
endDate	string	任意	Only count reviews on or before this date (`YYYY-MM-DD`).	—
searchString	string	任意	Only return phrases containing this substring.	—
phraseCount	integer	任意	Maximum number of phrases to return.	—
categories	string	任意	JSON array of interaction categories to include (see the interaction attributes reference).	—
ratingFilters	string	任意	JSON array of star ratings to include, e.g. `[1,2]` to mine only unhappy reviews.	—
responseStatus	string	任意	JSON array of `RESPONDED` / `PENDING` to restrict by whether the review has an owner reply.	—
sortOrder	string	任意	One of `NEWEST_FIRST`, `OLDEST_FIRST`, `LAST_RESPONDED`, `LOWEST_RATING`, `HIGHEST_RATING`.	—
category	string	任意	Deprecated single-value form of `categories`. Kept for v4 compatibility; prefer `categories`.	—
ratingFilter	integer	任意	Deprecated single-value form of `ratingFilters`. Kept for v4 compatibility; prefer `ratingFilters`.	—

レスポンス

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`).

ある拠点のレビュー本文に繰り返し登場するフレーズを、それぞれのフレーズを含むレビューのみを対象としたレビュー統計とともに返します。顧客が何に繰り返し言及しているか、その言及が好意的か否定的かを把握できます。

data.newReviewPhrasesはトップレベルの配列であり、ページネーション形式のレスポンスではありません。配列の長さに上限を設定するには、phraseCountを使用します。

各エントリには次の項目が含まれます。

reviewPhrase: フレーズそのものです。
phraseStats.stats: インタラクション分析を取得と同じ{ name, value, delta }構造で、そのフレーズを含むレビューのみを対象に計算されます。さらに、割合ではなく実数での変化量を格納するabsフィールドが含まれます。

すべてのフィルターは省略可能で、組み合わせて使用できるため、このルートはレビューのテキスト検索にも使えます。ratingFilters=[1,2]とstartDateを組み合わせると、直近1か月の苦情を、繰り返し登場する頻度の高い順に取得できます。

ユースケース：「よくある苦情」パネル

ある拠点の苦情パネルを作成するには、ratingFilters=[1,2]、90日前に設定したstartDate、phraseCount=10を指定してこのルートを呼び出します。結果として、低評価のレビューに最もよく登場する10個のフレーズが返されます。各フレーズのoverall-ratingに対応するphraseStatsを確認すると、そのフレーズが本当に突出しているのか、単によく使われる語句なのかがわかり、deltaからは状況が悪化しているかどうかがわかります。

クエリの値はJSONとして解析されるため、配列はJSON形式でクエリ文字列に指定します（例：?ratingFilters=[1,2]&siteUrls=["maps.google.com"]）。

上記のレスポンスは一例です。