GET/api/v4/reviews/site-config

列出帳戶的評論來源

傳回帳戶可用的評論平台。所有方案皆可使用 Google Maps 和 Facebook,Growth 和 Enterprise 方案可使用 Yelp。

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

參數

此端點不接受任何參數。

回應

200Account-level review source catalog.
Response
{  "data": {    "interactionSiteConfig": [      { "site": "Google", "siteUrl": "maps.google.com" },      { "site": "Facebook", "siteUrl": "facebook.com" },      { "site": "Yelp", "siteUrl": "yelp.com" }    ]  }}
401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.

傳回帳戶依其訂閱方案有權使用的完整評論來源平台目錄。上方回應是 Launch 方案帳戶實際傳回的目錄,實際包含哪些網站取決於方案和產業類別。

使用案例:設定地點前驗證 name 值

siteUrl 欄位是評論 API 其他各處使用的標準網站識別碼。當您連結地點的 Google 和 Facebook 商家檔案時,系統會自動填入評論來源,無須手動新增或編輯。使用此目錄可查詢互動清單端點上有效的 siteUrls 篩選值。

使用案例:建立「連結您的評論」使用者介面

為每個傳回的網站顯示一列,讓地點擁有者可以貼上各平台的商家檔案 URL。將此適用於整個帳戶的目錄(可連結的來源)與 列出地點的評論來源(單一地點已連結的來源)搭配使用,以顯示已連結與可用的來源。

此端點不接受任何參數,且範圍限於單一帳戶,因此多次呼叫的結果一致,請快取結果,避免針對每個地點重新擷取。此端點受帳戶速率限制約束;收到 429 時,請依據 Retry-After 標頭延後重試。

Request
curl -X GET 'https://listingsapi.com/api/v4/reviews/site-config' \  -H "Authorization: API $LISTINGSAPI_KEY"