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

拠点のレビューソースを一覧表示

1 つの拠点に設定されているレビューソースを、接続先 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" }

編集後に再取得すると、同じプラットフォームの url が null ではなく値が入った状態で返されます。

ユースケース:複数の拠点にわたって接続済みソースを監査

すべての拠点を一覧表示 から取得した拠点を順に処理し、拠点ごとにこのエンドポイントを呼び出して、レビューソースの対応状況をレポートします。拠点ごとに 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"