Yorum ifadelerini listeleme

Parametreler

Sorgu

Ad	Tür	Zorunlu	Açıklama	Varsayılan
locationIds	string	isteğe bağlı	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	isteğe bağlı	JSON array of review sources to include, e.g. `["maps.google.com"]`.	—
startDate	string	isteğe bağlı	Only count reviews on or after this date (`YYYY-MM-DD`).	—
endDate	string	isteğe bağlı	Only count reviews on or before this date (`YYYY-MM-DD`).	—
searchString	string	isteğe bağlı	Only return phrases containing this substring.	—
phraseCount	integer	isteğe bağlı	Maximum number of phrases to return.	—
categories	string	isteğe bağlı	JSON array of interaction categories to include (see the interaction attributes reference).	—
ratingFilters	string	isteğe bağlı	JSON array of star ratings to include, e.g. `[1,2]` to mine only unhappy reviews.	—
responseStatus	string	isteğe bağlı	JSON array of `RESPONDED` / `PENDING` to restrict by whether the review has an owner reply.	—
sortOrder	string	isteğe bağlı	One of `NEWEST_FIRST`, `OLDEST_FIRST`, `LAST_RESPONDED`, `LOWEST_RATING`, `HIGHEST_RATING`.	—
category	string	isteğe bağlı	Deprecated single-value form of `categories`. Kept for v4 compatibility; prefer `categories`.	—
ratingFilter	integer	isteğe bağlı	Deprecated single-value form of `ratingFilters`. Kept for v4 compatibility; prefer `ratingFilters`.	—

Yanıtlar

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

Bir konumun yorum metinlerinde tekrarlanan ifadeleri, her biri için o ifadeyi içeren yorumların alt kümesine ait yorum istatistikleriyle birlikte döndürür. "Müşteriler sürekli nelerden bahsediyor ve bu bahsettikleri olumlu mu yoksa olumsuz mu?" sorusunu yanıtlar.

data.newReviewPhrases, sayfalandırılmış bir yanıt değil, üst düzey bir dizidir. Uzunluğunu sınırlamak için phraseCount kullanın.

Her öğe şunları içerir:

reviewPhrase: ifadenin kendisi.
phraseStats.stats: Etkileşim analitiğini alma ile aynı { name, value, delta } yapısı; yalnızca o ifadeyi içeren yorumlar üzerinden hesaplanır ve yüzde değişim yerine mutlak değişimi içeren ek bir abs alanına sahiptir.

Tüm filtreler isteğe bağlıdır ve birlikte kullanılabilir; dolayısıyla bu yol, yorumlar üzerinde metin araması yapmak için de kullanılabilir: ratingFilters=[1,2] ile startDate birlikte kullanıldığında, son aydaki şikayetler tekrarlanma sıklıklarına göre sıralanmış olarak döndürülür.

Kullanım örneği: "en sık dile getirilen şikayetler" paneli

Bir konum için şikayet paneli oluşturmak üzere bu yolu ratingFilters=[1,2], 90 gün öncesini belirten bir startDate ve phraseCount=10 ile çağırın. Sonuç, düşük puanlı yorumlarda en çok geçen 10 ifadedir. Her biri için overall-rating ile ilgili phraseStats değerini okumak, bir ifadenin gerçekten sıra dışı mı yoksa yalnızca yaygın kullanılan bir ifade mi olduğunu gösterir ve delta durumun kötüleşip kötüleşmediğini belirtir.

Sorgu değerleri JSON olarak ayrıştırıldığından, diziler sorgu dizesinde JSON biçiminde yer alır: ?ratingFilters=[1,2]&siteUrls=["maps.google.com"].

Yukarıdaki yanıt bir örnektir.