GET/api/v4/reviews/site-config

アカウントのレビューソースを一覧表示

アカウントで利用できるレビュープラットフォームを返します。Google MapsとFacebookはすべてのプランで、YelpはGrowthとEnterpriseで利用できます。

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フィルターの値を確認します。

ユースケース:「レビューを接続する」UIを構築

拠点のオーナーが各プラットフォームのプロフィールURLを貼り付けられるように、返されたサイトごとに1行を表示します。このアカウント全体のカタログ(接続が可能なソース)と拠点のレビューソースを一覧表示(1つの拠点ですでに接続されているソース)を組み合わせて、接続済みのソースと利用可能なソースを表示します。

このエンドポイントはパラメーターを取らず、アカウント単位で動作するため、結果は呼び出しごとに変わりません。拠点ごとに再取得せず、キャッシュしてください。アカウントのレート制限が適用されるため、429の場合はRetry-Afterヘッダーを使用してバックオフします。

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