GET/api/v4/plan-sites

プランに含まれるサイトの一覧取得

アカウントのプランに含まれるすべての掲載先ディレクトリサイトを、各サイトのID、URL、対応する国とともに返します。

API キーが必要です。ヘッダーの形式とキーのローテーションについては認証を参照してください。

パラメーター

このエンドポイントにパラメーターはありません。

レスポンス

200Array of plan site objects. Country arrays are truncated below for brevity; the live response lists every supported country.
Response
{  "data": {    "planSites": [      {        "hideAddressSupportedCountries": ["US", "CA", "AU", "IN", "GB"],        "id": 1,        "name": "Google Maps",        "supportedCountries": ["US", "CA", "IN", "GB", "DE"],        "url": "maps.google.com"      },      {        "hideAddressSupportedCountries": ["US", "CA", "AU", "IN", "GB"],        "id": 184,        "name": "Facebook",        "supportedCountries": ["US", "CA", "IN", "GB", "DE"],        "url": "facebook.com"      },      {        "hideAddressSupportedCountries": ["US", "CA", "AU", "GB"],        "id": 2,        "name": "Yelp",        "supportedCountries": ["US", "CA", "GB", "DE", "FR"],        "url": "yelp.com"      }    ]  }}
401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.

現在のアカウントに紐づくプランに含まれるすべての掲載先ディレクトリサイトを返します。各エントリには、整数のid、表示用のname、サイトのurl、サイトが受け付けるISO国コードのリスト(supportedCountries)、住所非表示/サービス提供地域のフラグが適用される国(hideAddressSupportedCountries)が含まれます。

ユースケース:有効なサイトIDを選択できるUIの作成。 拠点の掲載先を有効または無効にする前に、このエンドポイントを呼び出して、プランに存在する数値のサイトIDを確認します。APIのほかの箇所で渡せる有効なIDは、ここで返されるIDのみです。idをname/urlに対応付けて、ユーザーが理解しやすい送信設定画面を表示します。

ユースケース:拠点の国の事前確認。 レスポンスを、supportedCountriesに拠点のcountryIsoが含まれるサイトに絞り込むことで、掲載情報を実際に受け付ける掲載先だけを提示できます。サービス提供地域型のビジネスの場合は、hideAddressSupportedCountriesと照合して、住所を非表示にできる国を確認します。

注意点。

  • これはプラン単位のリストで、ページネーションはありません。プランのサイトカタログ全体が1回のレスポンスで返されるため、カーソルもありません。数十件のエントリが返されることを想定し、リクエストのたびに呼び出すのではなく、結果をキャッシュしてください。
  • supportedCountriesとhideAddressSupportedCountriesには、それぞれ50以上のISOコードが含まれる場合があり、上のサンプルでは一部を省略しています。
  • アカウントのレート制限を共有しているため、429が返された場合はRetry-Afterヘッダーに従ってください。
Request
curl -X GET 'https://listingsapi.com/api/v4/plan-sites' \  -H "Authorization: API $LISTINGSAPI_KEY"