ガイドAPIリファレンス変更履歴
ガイド

関連項目を使用したレスポンス項目の強化

リクエストパラメーター「showRelated」を使用すると、開発者は関連コンテンツで特定のレスポンス項目を強化できます。

現在 showRelated でサポートされている値は次の表のとおりです。

showRelatedエンドポイント成熟度および特権説明
MPA/geocode/lookupGA、RESTRICTEDresultType=houseNumberhouseNumberType=PA を含む結果項目の場合、この住所に関連付けられたマイクロ ポイント住所 (建物、フロア (階数)、スイート (ユニット) など) のリストを含むブロックが含まれます。
parentPA/geocode/revgeocode/multi-revgeocode/lookupGA、RESTRICTEDresultType=houseNumberhouseNumberType=MPA を含む結果項目の場合、このマイクロ ポイント住所に関連付けられた「親」ポイント住所を含むブロックが含まれます。
intersections/geocode/revgeocode/multi-revgeocodeGAresultType=houseNumberまたはresultType=streetを含む結果項目の場合、住所に最も近い交差点のリストを含むブロックが含まれます。
nearbyAddress/revgeocode/multi-revgeocodeGA道路レベルの結果に対する追加の参照として、近くの住所を追加します。この機能は、パラメーターbearingまたはtypes=streetと組み合わせた道路結果に対してのみ使用できます。

showRelated=MPAを使用した/lookupエンドポイントレスポンスの例:

{
"title": "84 Northbourne Ave, Braddon ACT 2612, Australia",
"id": "here:af:streetsection:.W90ivJgffuB3CYZPYn6fD:CggIBCCymKydARABGgI4NA",
"language": "en",
"resultType": "houseNumber",
"houseNumberType": "PA",
"address": {
  "label": "84 Northbourne Ave, Braddon ACT 2612, Australia",
  "countryCode": "AUS",
  "countryName": "Australia",
  "stateCode": "ACT",
  "state": "Australian Capital Territory",
  "city": "Canberra",
  "district": "Braddon",
  "street": "Northbourne Ave",
  "postalCode": "2612",
  "houseNumber": "84"
},
"position": { "lat": -35.27422, "lng": 149.13065 },
"access": [{ "lat": -35.27416, "lng": 149.13013 }],
"mapView": {...},
"related": [
  {
    "relationship": "MPA",
    "title": "802/84 Northbourne Ave, Braddon ACT 2612, Australia",
    "id": "here:cm:micropointaddress:609132900",
    "resultType": "houseNumber",
    "houseNumberType": "MPA",
    "position": { "lat": -35.27418, "lng": 149.13032 },
    "address": {
      "label": "802/84 Northbourne Ave, Braddon ACT 2612, Australia",
      "unit": "802"
    }
  },
  ...
  {
    "relationship": "MPA",
    "title": "105/84 Northbourne Ave, Braddon ACT 2612, Australia",
    "id": "here:cm:micropointaddress:872377237",
    "resultType": "houseNumber",
    "houseNumberType": "MPA",
    "address": {
      "label": "105/84 Northbourne Ave, Braddon ACT 2612, Australia",
      "unit": "105"
    }
  }
]
}
  • 「related」ブロックには、各マイクロポイント住所の親ポイント住所と異なるフィールドのみが含まれます。
  • 現在、HERE Geocoding and Searchは次の国でマイクロポイント住所をサポートしています:AUS、AUT、CAN、NZL、USA (PRI準州を含む)。

showRelated=intersectionsを使用した/revgeocodeエンドポイントレスポンスの例:

GET https://revgeocode.search.hereapi.com/v1/
    revgeocode
    ?at=34.0569948,-118.2475378
    &lang=en-US
    &showRelated=intersections
    &apiKey={YOUR_API_KEY}
{
  "items": [
      {
          "title": "144 N Grand Ave, Los Angeles, CA 90012-3001, United States",
          "id": "here:af:streetsection:MrYXjP8ZMKxUjw0YHcJbgB:CggIBCCZusifAxABGgMxNDQ",
          "resultType": "houseNumber",
          "houseNumberType": "PA",
          "address": {
              "label": "144 N Grand Ave, Los Angeles, CA 90012-3001, United States",
              "countryCode": "USA",
              "countryName": "United States",
              "stateCode": "CA",
              "state": "California",
              "county": "Los Angeles",
              "city": "Los Angeles",
              "district": "Downtown Los Angeles",
              "street": "N Grand Ave",
              "postalCode": "90012-3001",
              "houseNumber": "144"
          },
          "position": {
              "lat": 34.0569,
              "lng": -118.24764
          },
          "access": [
              {
                  "lat": 34.057,
                  "lng": -118.24774
              }
          ],
          "distance": 14,
          "mapView": {
              "west": -118.24877,
              "south": 34.0557,
              "east": -118.24533,
              "north": 34.05926
          },
          "estimatedPointAddress": true,
          "related": [
              {
                  "relationship": "intersection",
                  "title": "N Grand Ave & W Temple St, Los Angeles, CA 90012, United States",
                  "id": "here:cm:node:49260238",
                  "resultType": "intersection",
                  "address": {
                      "label": "N Grand Ave & W Temple St, Los Angeles, CA 90012, United States",
                      "streets": [
                          "N Grand Ave",
                          "W Temple St"
                      ],
                      "postalCode": "90012"
                  },
                  "position": {
                      "lat": 34.05814,
                      "lng": -118.24644
                  },
                  "distance": 163
              },
              {
                  "relationship": "intersection",
                  "title": "W 1st St & N Grand Ave & S Grand Ave, Los Angeles, CA 90012, United States",
                  "id": "here:cm:node:49255048",
                  "resultType": "intersection",
                  "address": {
                      "label": "W 1st St & N Grand Ave & S Grand Ave, Los Angeles, CA 90012, United States",
                      "streets": [
                          "W 1st St",
                          "N Grand Ave",
                          "S Grand Ave"
                      ],
                      "postalCode": "90012"
                  },
                  "position": {
                      "lat": 34.0557,
                      "lng": -118.24877
                  },
                  "distance": 183
              }
          ]
      }
  ]
}
  • relatedブロックには、各関連オブジェクトの親結果と異なるフィールドのみが含まれます。親からの他のアドレス フィールドはすべて、関連要素に適用されると想定できます。
  • 近くに交差点が複数ある場合は、related ブロック内の distance で並べ替えられます。
  • 近くの交差点で 2 つ以上の道路が交差している可能性があります。結果および交差する道路の通り名を含む、交差するすべての道路名は related ブロックに一覧で示されています。
  • 現在、近くの交差点は、通り名を持つresultType=houseNumberまたはresultType=streetの結果項目に対してのみ返されます。

showRelated=nearbyAddressを使用した/revgeocodeエンドポイントレスポンスの例:

GET https://revgeocode.search.hereapi.com/v1/
    revgeocode
    ?at=2.5186672,13.4079117
    &bearing=60
    &lang=en-US
    &showRelated=nearbyAddress
    &apiKey={YOUR_API_KEY}
{
  "items": [
      {
          "title": "Rathausstraße, 10178 Berlin, Germany",
          "id": "here:af:streetsection:2pGteqRk7Ros60IJL5KyEA",
          "resultType": "street",
          "address": {
              "label": "Rathausstraße, 10178 Berlin, Germany",
              "countryCode": "DEU",
              "countryName": "Germany",
              "stateCode": "BE",
              "state": "Berlin",
              "countyCode": "B",
              "county": "Berlin",
              "city": "Berlin",
              "district": "Mitte",
              "street": "Rathausstraße",
              "postalCode": "10178"
          },
          "position": {"lat": 52.5187, "lng": 13.40787},
          "distance": 4,
          "mapView": {...},
          "related": [
              {
                  "relationship": "nearbyAddress",
                  "title": "Rathausstraße 15, 10178 Berlin, Germany",
                  "id": "here:af:streetsection:2pGteqRk7Ros60IJL5KyEA:CgcIBCCk6s5QEAEaAjE1",
                  "resultType": "houseNumber",
                  "houseNumberType": "PA",
                  "address": {
                      "label": "Rathausstraße 15, 10178 Berlin, Germany",
                      "houseNumber": "15"
                  },
                  "position": {
                      "lat": 52.51856,
                      "lng": 13.40821
                  },
                  "access": [
                      {
                          "lat": 52.51874,
                          "lng": 13.40796
                      }
                  ],
                  "distance": 24,
                  "routeDistance": 7,
                  "bearing": 53
              }
          ]
      }
  ]
}
  • relatedブロックには、各関連オブジェクトの親の結果と異なるフィールドのみが含まれます。親からの他のすべてのアドレスフィールドはrelatedブロックに適用されます。
  • この機能は、パラメーター bearing または types=street と組み合わせた道路結果に対してのみ使用できます。
  • routeDistance から 150 メートル以内の住所は nearbyAddress として返されます。
  • 双方向道路の場合:
    • bearing が指定されている場合、優先される nearbyAddress は走行する側と同じ側にあります。
    • bearing が存在せず types=street が指定されている場合、優先される nearbyAddress は入力と同じ側になります。
    • その側に利用可能なアドレスがない場合、反対側の最も近いアドレスがフォールバックとして返されます。
  • 一方向の道路の場合、どちらかの側から最も近い nearbyAddress が返されます。
  • showMapReferences パラメーターが要求された場合、nearbyAddress の地図参照が提供されます。