GET/api/v4/locations/{locationId}/reviews/settings

列出地點的評論來源

傳回為單一地點設定的評論來源及其連線 URL。

需要 API 金鑰。標頭格式與金鑰輪替請參閱驗證。

參數

路徑

名稱類型必填說明
locationIdstring必填Location to read. Accepts a base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or a raw numeric location ID.

回應

200Review-source sites and their configured URLs for the location.
Response
{  "data": {    "interactionsSetting": {      "siteSettings": [        { "name": "maps.google.com", "url": null },        { "name": "facebook.com", "url": null },        { "name": "yelp.com", "url": null }      ]    }  }}
401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.

傳回單一地點的評論來源設定。siteSettings 中的每個項目都是該帳戶方案支援的平台。url 不為 null 表示該平台已連線,且 Listings API 正在從該 URL 擷取評論;url 為 null(如上方實際地點 Jenny Home 所示,該地點尚未附加任何第三方來源)則表示該平台可用,但尚未設定。

使用案例:找出哪些來源仍需要 URL

擷取此清單並篩選出 url: null,以建立地點擁有者仍需連線的平台待辦清單。地點的 Google 和 Facebook 商家檔案連結後,評論來源就會自動附加,請連結這些帳戶以填入缺少的 URL:

JSON
{ "name": "yelp.com", "url": "https://www.yelp.com/biz/your-listing" }

編輯後,再次傳回的同一平台項目中,url 會填入值,不再是 null。

使用案例:稽核多個地點已連線的來源

逐一處理您的地點(取自列出所有地點),並針對每個地點呼叫此端點,以產生評論來源涵蓋範圍的報告。由於每個地點都需要一次請求,請遵守帳戶的速率限制、分散呼叫時間,並在收到 429 時,等待 Retry-After 標頭指定的時間後再重試,避免密集重複呼叫。

透過 OAuth 連線的 Google 和 Facebook 會自動顯示為已連線,且無法透過編輯端點覆寫。請使用帳戶範圍的列出帳戶的評論來源,查看該方案可支援的完整平台集合。

Request
curl -X GET 'https://listingsapi.com/api/v4/locations/<locationId>/reviews/settings' \  -H "Authorization: API $LISTINGSAPI_KEY"