メタデータ

地域一覧取得

対応地域一覧取得。POST /v1/search-rank / POST /v1/search-volume の location パラメータに指定可能な地域名の一覧を取得する。未対応の地域名でエラーになった場合、この一覧から正しい地域名を確認する。一覧が多い場合は locationName（地域名・部分一致）/ countryCode（ISO 3166-1 alpha-2 国コード・完全一致）で絞り込める（複数指定時はAND条件）。フィルタ未指定時は国レベルのみ、フィルタ指定時は国レベルに加え市区町村レベルの地域も返る。

クレジットは消費しない。認証は不要。

get/v1/metadata/locations

Query parameters

locationNamestring

Example:Japan

地域名での絞り込み（部分一致・大文字小文字無視）。指定すると国レベルに加え市区町村など下位レベルの地域も返却する。省略可。

countryCodestring

Example:JP

ISO 3166-1 alpha-2 国コードでの絞り込み（完全一致・大文字小文字無視例: JP）。指定すると国レベルに加え市区町村など下位レベルの地域も返却する。locationName と併用した場合はAND条件。省略可。

limitnumber

Example:300

取得件数。正の整数を指定。省略時は全件取得。

Response

取得成功

resultboolean required

API 呼び出しの成否。正常時は true、エラー時は false。

errorsstring[] required

エラーメッセージの配列。正常時は空配列。

Example response

{
  "result": true,
  "data": {
    "locations": [
      {
        "name": "Japan",
        "countryIsoCode": "JP"
      }
    ]
  },
  "errors": []
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.