Listings APIListings API
로그인
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.

사업장 1개의 리뷰 소스 설정을 반환합니다. 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" }

수정 후에는 동일한 플랫폼이 null 대신 url이 채워진 상태로 반환됩니다.

사용 사례: 여러 사업장에 걸쳐 연결된 소스 점검

모든 사업장 조회에서 가져온 사업장을 순회하며 각 사업장에 대해 이 엔드포인트를 호출하여 리뷰 소스 연결 현황을 보고합니다. 사업장당 요청 1개가 필요하므로 계정의 요청 빈도 제한을 준수하고 호출 간격을 두며, 429가 반환되면 연달아 재시도하지 말고 Retry-After 헤더에 지정된 시간이 지난 후 다시 시도합니다.

OAuth를 통해 연결된 Google 및 Facebook은 자동으로 연결된 상태로 표시되며 수정 엔드포인트를 통해 덮어쓸 수 없습니다. 요금제에서 지원할 수 있는 전체 플랫폼 목록을 확인하려면 계정 전체 범위의 계정의 리뷰 소스 목록 조회을 사용합니다.

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