Search - Post Search Inside Geometry

Service:

Maps

API Version:

1.0

を使用して、もう 1 つのジオメトリ内で自由形式の検索を実行します。

API は Post Search Inside Geometry と HTTP POST request that allows you to perform a free form search inside a single geometry or multiple geometries. The search results that fall inside the geometry/geometries will be returned.<br><br>To send the geometry you will use a POSTrequest where the request body will contain thegeometryobject represented as aGeoJSONtype and theContent-Typeheader will be set toapplication/json. The geographical features to be searched can be modeled as Polygon and/or Circle geometries represented using any one of the following GeoJSON geometrycan be represented as aGeoJSONtypes:<ul><li>**GeoJSON FeatureCollection** <br>TheFeatureCollection FeatureCollectionobject should represent either a Polygon or a Circle with the following conditions:<ul style="list-style-type:none"><li>Aobject. This is the recommended option if the geometry contains both Polygons and Circles. Theobjects. Eachcan contain a max of 50object for the Polygon geometry can have a max of 50 coordinates and it's properties must be empty.</li><li>AFeature Featureobject for the Circle geometry is composed of a _center_ represented using aGeoJSON Pointtype and a _radius_ value (in meters) which must be specified in the object's properties along with the _subType_ property whose value should be 'Circle'.</li></ul><br> Please see the Examples section below for a sampleFeatureCollectionrepresentation.<br><br></li><li>**GeoJSON GeometryCollection**<br>Thegeometrycan be represented as aGeoJSON GeometryCollection GeometryCollectionobject. This is the recommended option if the geometry contains a list of Polygons only. TheGeometryCollectioncan contain a max of 50GeoJSON Polygonobjects. Eachobject can have a max of 50 coordinates. Please see the Examples section below for a sampleGeometryCollectionrepresentation.<br><br></li><li>**GeoJSON Polygon**<br>Thegeometrycan be represented as aGeoJSON Polygon Polygonobject. This is the recommended option if the geometry contains a single Polygon. Theobject can have a max of 50 coordinates. Please see the Examples section below for a samplePolygon の表現。

.

POST https://atlas.microsoft.com/search/geometry/{format}?api-version=1.0&query={query}

With optional parameters:

POST https://atlas.microsoft.com/search/geometry/{format}?api-version=1.0&query={query}&limit={limit}&language={language}&categorySet={categorySet}&extendedPostalCodesFor={extendedPostalCodesFor}&idxSet={idxSet}&view={view}&openingHours=nextSevenDays

URI パラメーター

名前	/	必須	型	説明
format	path	True	ResponseFormat	応答の目的の形式。 値には json または xml のいずれかを指定できます。
api-version	query	True	string	Azure Maps API のバージョン番号。
query	query	True	string	検索する POI 名 (例: "自由の女神"、"starbucks"、"pizza")。 URL が正しくエンコードされている必要があります。
categorySet	query		integer[]	特定のポイントオブインタレストカテゴリに結果を制限するために使用できるカテゴリセットIDのコンマ区切りのリスト。 ID の順序は関係ありません。 要求ごとにサポートされる値の categorySet 最大数は 10 です。 複数のカテゴリ識別子が指定されている場合、指定されたリストのカテゴリの 1 つ (少なくとも) に属する POI のみが返されます。 サポートされているカテゴリの一覧は、 POI Categories API を使用して検出できます。 使用例: categorySet=7315 (カテゴリレストランからSearchの目的地) categorySet=7315025,7315017 (イタリア料理店またはフランス料理店のカテゴリーのSearchポイント)
extendedPostalCodesFor	query		SearchIndexes[]	結果に拡張郵便番号を含める必要があるインデックス。 使用可能なインデックスは次のとおりです。 Addr = アドレス範囲 Geo = Geographies PAD = ポイント アドレス POI = 目的地 Str = Streets XStr = クロス ストリート (交差点) 値は、インデックスの種類 (任意の順序) のコンマ区切りのリスト、またはインデックスがない場合は None にする必要があります。 既定では、Geo を除くすべてのインデックスに拡張郵便番号が含まれます。 地域の拡張郵便番号リストは非常に長い場合があるため、必要に応じて明示的に要求する必要があります。 使用例: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None 拡張郵便番号は、住所の extendedPostalCode プロパティとして返されます。 可用性はリージョンに依存します。
idxSet	query		SearchIndexes[]	検索に使用する必要があるインデックスのコンマ区切りのリスト。 項目の順序は関係ありません。 使用可能なインデックスは次のとおりです。Addr = アドレス範囲補間、Geo = 地理、PAD = ポイント アドレス、POI = 目的地、Str = 通り、Xstr = クロス ストリート (交差点)
language	query		string	検索結果を返す言語。 サポートされている IETF 言語タグの 1 つである必要があります。大文字と小文字は区別されません。 指定した言語のデータが特定のフィールドで使用できない場合は、既定の言語が使用されます。 詳細については、「 サポートされている言語 」を参照してください。
limit	query		integer	返される応答の最大数。 既定値: 10、最小: 1、最大: 100
openingHours	query		OperatingHoursRange	POI (目的地) の操作時間。 操作時間の可用性は、使用可能なデータによって異なります。 渡されない場合、営業時間情報は返されません。 サポートされる値: nextSevenDays
view	query		LocalizedMapView	View パラメーター ("user region" パラメーターとも呼ばれます) を使用すると、地政学的に紛争が発生している地域の特定の国/地域の正しいマップを表示できます。 このようなリージョンのビューは国や地域によって異なります。また、View パラメーターを使用すると、アプリケーションがサービスを提供する国/地域に必要なビューにアプリケーションを準拠できます。 既定では、View パラメーターは、要求で定義していない場合でも "Unified" に設定されます。 ユーザーの場所を特定し、その場所を正しく View パラメーターを設定するのはユーザーの責任です。 または、要求の IP アドレスに基づいてマップ データを返す 'View = Auto' を設定することもできます。 Azure Mapsの View パラメーターは、マップ、画像、その他のデータ、Azure Maps経由でアクセスする権限を持つ第三者のコンテンツが利用可能になる国/地域のマッピングに関するものを含む、適用される法律に準拠して使用する必要があります。 例: view=IN。 詳細については、「 サポートされているビュー」 を参照し、使用可能なビューを参照してください。

要求ヘッダー

名前	必須	型	説明
x-ms-client-id		string	Microsoft Entra ID セキュリティ モデルと組み合わせて使用するアカウントを指定します。 Azure Maps アカウントの一意の ID を表し、Azure Maps管理プレーン アカウント API から取得できます。 Azure MapsでMicrosoft Entra IDセキュリティを使用するには、次の記事を参照してください。

要求本文

名前	型	説明
geometry	GeoJsonObject: GeoJsonFeature GeoJsonFeatureCollection	有効な GeoJSON オブジェクト。 詳細については、 RFC 7946 を参照してください。

応答

名前	型	説明
200 OK	SearchAddressResult	OK
Other Status Codes	ErrorResponse	予期しないエラーが発生しました。

セキュリティ

AADToken

これらは OAuth 2.0 フロー Microsoft Entraです。 Azure ロールベースのアクセス制御と組み合わせて使用すると、Azure Maps REST API へのアクセスを制御できます。 Azure ロールベースのアクセス制御は、1 つ以上のAzure Mapsリソース アカウントまたはサブリソースへのアクセスを指定するために使用されます。 REST API に対する 1 つ以上のアクセス許可で構成される組み込みロールまたはカスタム ロールを使用して、任意のユーザー、グループ、またはサービス プリンシパルにアクセス権 Azure Mapsを付与できます。

シナリオを実装するには、 認証の概念を表示することをお勧めします。 要約すると、このセキュリティ定義は、特定の API とスコープに対するアクセス制御が可能なオブジェクトを使用してアプリケーションをモデル化するためのソリューションを提供します。

注意

• このセキュリティ定義では、 ヘッダーを使用して、x-ms-client-idアプリケーションがアクセスを要求しているリソースAzure Maps示す必要があります。 これは、 Maps 管理 API から取得できます。
• Authorization URLは、Azure パブリック クラウド インスタンスに固有です。 ソブリン クラウドには、固有の承認 URL とMicrosoft Entra ID構成があります。
• Azure ロールベースのアクセス制御は、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンから構成されます。
• Azure Maps Web SDK を使用すると、複数のユース ケースに対するアプリケーションの構成ベースのセットアップが可能になります。
• Microsoft ID プラットフォームの詳細については、「Microsoft ID プラットフォームの概要」を参照してください。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

これは、Azure portalでAzure Maps アカウントを作成するとき、または PowerShell、CLI、Azure SDK、または REST API を使用するときにプロビジョニングされる共有キーです。

このキーを使用すると、すべてのアプリケーションがすべての REST API にアクセスできます。 つまり、このキーは、発行されたアカウントのマスター キーとして使用できます。

公開されているアプリケーションの場合は、機密クライアント アプリケーションのアプローチを使用して、キーを安全に格納できるように、Azure Maps REST API にアクセスすることをお勧めします。

Type: apiKey
In: query

SAS Token

これは、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して、Azure 管理プレーンを介して、Azure Maps リソースの List SAS 操作から作成される共有アクセス署名トークンです。

このトークンを使用すると、すべてのアプリケーションが Azure ロールベースのアクセス制御を使用してアクセスし、特定のトークンに使用される有効期限、レート、およびリージョンをきめ細かく制御できます。 つまり、SAS トークンを使用して、アプリケーションが共有キーよりもセキュリティで保護された方法でアクセスを制御できるようにします。

公開されているアプリケーションの場合、 Map アカウント リソース で許可される配信元の特定の一覧を構成して、レンダリングの不正使用を制限し、SAS トークンを定期的に更新することをお勧めします。

Type: apiKey
In: header

例

Search for burger joints inside a geometry represented as a GeoJSON GeometryCollection type

Search for pizza places inside a geometry represented as a GeoJSON FeatureCollection type

Search for subs joints inside a geometry represented as a GeoJSON Polygon type

Search for burger joints inside a geometry represented as a GeoJSON GeometryCollection type

Sample Request

HTTP

POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=burger&limit=2&openingHours=nextSevenDays

{
  "geometry": {
    "type": "GeometryCollection",
    "geometries": [
      {
        "type": "Polygon",
        "coordinates": [
          [
            [
              -122.43576049804686,
              37.7524152343544
            ],
            [
              -122.43301391601562,
              37.70660472542312
            ],
            [
              -122.36434936523438,
              37.712059855877314
            ],
            [
              -122.43576049804686,
              37.7524152343544
            ]
          ]
        ]
      },
      {
        "type": "Polygon",
        "coordinates": [
          [
            [
              -123.43576049804686,
              37.7524152343544
            ],
            [
              -123.43301391601562,
              37.70660472542312
            ],
            [
              -123.36434936523438,
              37.712059855877314
            ],
            [
              -123.43576049804686,
              37.7524152343544
            ]
          ]
        ]
      }
    ]
  }
}

Sample Response

Status code:

200

{
  "summary": {
    "query": "burger",
    "queryType": "NON_NEAR",
    "queryTime": 21,
    "numResults": 2,
    "offset": 0,
    "totalResults": 4,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "POI",
      "id": "9P2i9inRyndAA-_V40J8oA",
      "score": 2.0041828156,
      "info": "search:ta:840061003419653-US",
      "poi": {
        "name": "Burger Joint",
        "phone": "+1 415-349-4331",
        "categorySet": [
          {
            "id": 7315015
          }
        ],
        "categories": [
          "fast food",
          "restaurant"
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              },
              {
                "nameLocale": "en-US",
                "name": "fast food"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "167",
        "streetName": "Leland Avenue",
        "municipality": "San Francisco",
        "neighbourhood": "Visitacion Valley",
        "countrySecondarySubdivision": "San Francisco",
        "countrySubdivisionName": "California",
        "countrySubdivisionCode": "CA",
        "postalCode": "94134",
        "extendedPostalCode": "94134-2844",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "167 Leland Avenue, San Francisco, CA 94134",
        "localName": "San Francisco"
      },
      "position": {
        "lat": 37.712228,
        "lon": -122.407022
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 37.71313,
          "lon": -122.40816
        },
        "btmRightPoint": {
          "lat": 37.71133,
          "lon": -122.40589
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 37.71241,
            "lon": -122.40693
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "hkr-N07YS6Gv2dOciQ9lwA",
      "score": 2.0041515827,
      "info": "search:ta:840067000526682-US",
      "poi": {
        "name": "Sound of Burgers",
        "categorySet": [
          {
            "id": 7315
          }
        ],
        "categories": [
          "restaurant"
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "167",
        "streetName": "Leland Avenue",
        "municipality": "San Francisco",
        "neighbourhood": "Visitacion Valley",
        "countrySecondarySubdivision": "San Francisco",
        "countrySubdivision": "CA",
        "countrySubdivisionName": "California",
        "countrySubdivisionCode": "CA",
        "postalCode": "94134",
        "extendedPostalCode": "94134-2844",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "167 Leland Avenue, San Francisco, CA 94134",
        "localName": "San Francisco"
      },
      "position": {
        "lat": 37.712228,
        "lon": -122.407022
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 37.71313,
          "lon": -122.40816
        },
        "btmRightPoint": {
          "lat": 37.71133,
          "lon": -122.40589
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 37.71241,
            "lon": -122.40693
          }
        }
      ]
    }
  ]
}

Search for pizza places inside a geometry represented as a GeoJSON FeatureCollection type

Sample Request

HTTP

POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=pizza&limit=2&openingHours=nextSevenDays

{
  "geometry": {
    "type": "FeatureCollection",
    "features": [
      {
        "type": "Feature",
        "geometry": {
          "type": "Polygon",
          "coordinates": [
            [
              [
                -122.143035,
                47.653536
              ],
              [
                -122.187164,
                47.617556
              ],
              [
                -122.114981,
                47.570599
              ],
              [
                -122.132756,
                47.654009
              ],
              [
                -122.143035,
                47.653536
              ]
            ]
          ]
        },
        "properties": {}
      },
      {
        "type": "Feature",
        "geometry": {
          "type": "Point",
          "coordinates": [
            -122.126986,
            47.639754
          ]
        },
        "properties": {
          "subType": "Circle",
          "radius": 100
        }
      }
    ]
  }
}

Sample Response

Status code:

200

{
  "summary": {
    "query": "pizza",
    "queryType": "NON_NEAR",
    "queryTime": 34,
    "numResults": 2,
    "offset": 0,
    "totalResults": 21,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "POI",
      "id": "-UuwTye4GGsea4KmCLvoqQ",
      "score": 2.1455535889,
      "info": "search:ta:840537000108972-US",
      "poi": {
        "name": "Biryani & Pizza House",
        "categorySet": [
          {
            "id": 7315036
          }
        ],
        "categories": [
          "pizza",
          "restaurant"
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              },
              {
                "nameLocale": "en-US",
                "name": "pizza"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "15025",
        "streetName": "Northeast 24th Street",
        "municipality": "Redmond",
        "countrySecondarySubdivision": "King",
        "countrySubdivision": "WA",
        "countrySubdivisionName": "Washington",
        "countrySubdivisionCode": "WA",
        "postalCode": "98052",
        "extendedPostalCode": "98052-5531",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "15025 Northeast 24th Street, Redmond, WA 98052",
        "localName": "Redmond"
      },
      "position": {
        "lat": 47.630786,
        "lon": -122.139302
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.63169,
          "lon": -122.14064
        },
        "btmRightPoint": {
          "lat": 47.62989,
          "lon": -122.13797
        }
      },
      "entryPoints": [
        {
          "type": "minor",
          "position": {
            "lat": 47.63079,
            "lon": -122.13931
          }
        },
        {
          "type": "main",
          "position": {
            "lat": 47.63147,
            "lon": -122.13935
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "7r095LCcCSkdoGoeLcnvsQ",
      "score": 2.1454992294,
      "info": "search:ta:840537000103468-US",
      "poi": {
        "name": "Pagliacci Pizza",
        "categorySet": [
          {
            "id": 7315036
          }
        ],
        "url": "www.pagliacci.com/",
        "categories": [
          "pizza",
          "restaurant"
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              },
              {
                "nameLocale": "en-US",
                "name": "pizza"
              }
            ]
          }
        ],
        "openingHours": {
          "mode": "nextSevenDays",
          "timeRanges": [
            {
              "startTime": {
                "date": "2024-03-14",
                "hour": 10,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-14",
                "hour": 11,
                "minute": 0
              }
            },
            {
              "startTime": {
                "date": "2024-03-17",
                "hour": 10,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-17",
                "hour": 11,
                "minute": 0
              }
            },
            {
              "startTime": {
                "date": "2024-03-18",
                "hour": 10,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-18",
                "hour": 11,
                "minute": 0
              }
            },
            {
              "startTime": {
                "date": "2024-03-19",
                "hour": 10,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-19",
                "hour": 11,
                "minute": 0
              }
            },
            {
              "startTime": {
                "date": "2024-03-20",
                "hour": 10,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-20",
                "hour": 11,
                "minute": 0
              }
            }
          ]
        }
      },
      "address": {
        "streetNumber": "15238",
        "streetName": "Bel Red Road",
        "municipality": "Bellevue",
        "countrySecondarySubdivision": "King",
        "countrySubdivision": "WA",
        "countrySubdivisionName": "Washington",
        "countrySubdivisionCode": "WA",
        "postalCode": "98007",
        "extendedPostalCode": "98007-3815",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "15238 Bel Red Road, Bellevue, WA 98007",
        "localName": "Bellevue"
      },
      "position": {
        "lat": 47.628008,
        "lon": -122.13646
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.62891,
          "lon": -122.13779
        },
        "btmRightPoint": {
          "lat": 47.62711,
          "lon": -122.13513
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.6283,
            "lon": -122.13611
          }
        }
      ]
    }
  ]
}

Search for subs joints inside a geometry represented as a GeoJSON Polygon type

Sample Request

HTTP

POST https://atlas.microsoft.com/search/geometry/json?api-version=1.0&query=subs&limit=2&openingHours=nextSevenDays

{
  "geometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          -122.43576049804686,
          37.7524152343544
        ],
        [
          -122.43301391601562,
          37.70660472542312
        ],
        [
          -122.36434936523438,
          37.712059855877314
        ],
        [
          -122.43576049804686,
          37.7524152343544
        ]
      ]
    ]
  }
}

Sample Response

Status code:

200

{
  "summary": {
    "query": "subs",
    "queryType": "NON_NEAR",
    "queryTime": 42,
    "numResults": 2,
    "offset": 0,
    "totalResults": 5,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "POI",
      "id": "HOIWGiNwVv0z6bF8MO3EbA",
      "score": 2.1455111504,
      "info": "search:ta:840069009512242-US",
      "poi": {
        "name": "Adams Grub Truck",
        "phone": "+1 415-307-8844",
        "categorySet": [
          {
            "id": 7315042
          }
        ],
        "categories": [
          "restaurant",
          "sandwich"
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "sandwich"
              },
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ]
      },
      "address": {
        "streetNumber": "1465",
        "streetName": "Carroll Avenue",
        "municipality": "San Francisco",
        "neighbourhood": "Bayview",
        "countrySecondarySubdivision": "San Francisco",
        "countrySubdivisionName": "California",
        "countrySubdivisionCode": "CA",
        "postalCode": "94124",
        "extendedPostalCode": "94124-3604",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "1465 Carroll Avenue, San Francisco, CA 94124",
        "localName": "San Francisco"
      },
      "position": {
        "lat": 37.72328,
        "lon": -122.39091
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 37.72418,
          "lon": -122.39205
        },
        "btmRightPoint": {
          "lat": 37.72238,
          "lon": -122.38977
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 37.72348,
            "lon": -122.39073
          }
        }
      ]
    },
    {
      "type": "POI",
      "id": "bXbc0QxTRlkSo8GnU7EU-Q",
      "score": 2.1454677582,
      "info": "search:ta:840061001992959-US",
      "poi": {
        "name": "SUBWAY San Francisco San Francisco",
        "phone": "+1 415-657-9898",
        "brands": [
          {
            "name": "SUBWAY"
          }
        ],
        "categorySet": [
          {
            "id": 7315042
          }
        ],
        "categories": [
          "restaurant",
          "sandwich"
        ],
        "classifications": [
          {
            "code": "RESTAURANT",
            "names": [
              {
                "nameLocale": "en-US",
                "name": "sandwich"
              },
              {
                "nameLocale": "en-US",
                "name": "restaurant"
              }
            ]
          }
        ],
        "openingHours": {
          "mode": "nextSevenDays",
          "timeRanges": [
            {
              "startTime": {
                "date": "2024-03-13",
                "hour": 7,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-13",
                "hour": 21,
                "minute": 30
              }
            },
            {
              "startTime": {
                "date": "2024-03-14",
                "hour": 7,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-14",
                "hour": 21,
                "minute": 30
              }
            },
            {
              "startTime": {
                "date": "2024-03-15",
                "hour": 7,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-15",
                "hour": 21,
                "minute": 30
              }
            },
            {
              "startTime": {
                "date": "2024-03-16",
                "hour": 9,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-16",
                "hour": 21,
                "minute": 0
              }
            },
            {
              "startTime": {
                "date": "2024-03-17",
                "hour": 9,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-17",
                "hour": 21,
                "minute": 0
              }
            },
            {
              "startTime": {
                "date": "2024-03-18",
                "hour": 8,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-18",
                "hour": 20,
                "minute": 30
              }
            },
            {
              "startTime": {
                "date": "2024-03-19",
                "hour": 7,
                "minute": 0
              },
              "endTime": {
                "date": "2024-03-19",
                "hour": 21,
                "minute": 30
              }
            }
          ]
        }
      },
      "address": {
        "streetNumber": "2599",
        "streetName": "San Bruno Avenue",
        "municipality": "San Francisco",
        "neighbourhood": "Portola",
        "countrySecondarySubdivision": "San Francisco",
        "countrySubdivision": "CA",
        "countrySubdivisionName": "California",
        "countrySubdivisionCode": "CA",
        "postalCode": "94134",
        "extendedPostalCode": "94134-1504",
        "countryCode": "US",
        "country": "United States",
        "countryCodeISO3": "USA",
        "freeformAddress": "2599 San Bruno Avenue, San Francisco, CA 94134",
        "localName": "San Francisco"
      },
      "position": {
        "lat": 37.729004,
        "lon": -122.403956
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 37.7299,
          "lon": -122.40509
        },
        "btmRightPoint": {
          "lat": 37.7281,
          "lon": -122.40282
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 37.72892,
            "lon": -122.40414
          }
        }
      ]
    }
  ]
}

定義

名前	説明
Address	結果のアドレス
AddressRanges	検索結果の通りの両側のアドレス範囲について説明します。 アドレス範囲の開始位置と終了位置の座標が含まれます。
BoundingBox	ビューポートの左上と右下の座標で表される結果をカバーするビューポート。
BoundingBoxCompassNotation	場所の境界ボックス。
Brand	POI に関連付けられているブランド
Classification	返される POI の分類
ClassificationName	分類の名前
DataSources	省略可能なセクション。 Get Search Polygon API で使用する参照 ID。
Entity	境界ボックスのエンティティ型ソース。 逆ジオコーディングの場合、これは常に位置と等しくなります。
EntryPoint	返される POI のエントリ ポイント。
EntryPointType	エントリ ポイントの種類。 値には、メインまたはマイナーのいずれかを指定できます。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
GeographicEntityType	Geography エンティティ型。 entityType が要求され、使用可能な場合にのみ表示されます。
GeoJsonFeature	有効な GeoJSON Feature オブジェクト型。 詳細については、 RFC 7946 を参照してください。
GeoJsonFeatureCollection	有効な GeoJSON FeatureCollection オブジェクト型。 詳細については、 RFC 7946 を参照してください。
GeoJsonGeometry	有効な GeoJSON geometry オブジェクト。 この型は、Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection の 7 つの有効な GeoJSON ジオメトリ型のいずれかである必要があります。 詳細については、 RFC 7946 を参照してください。
GeoJsonGeometryCollection	有効な GeoJSON GeometryCollection オブジェクト型。 詳細については、 RFC 7946 を参照してください。
GeoJsonLineString	有効な GeoJSON LineString geometry 型。 詳細については、 RFC 7946 を参照してください。
GeoJsonMultiLineString	有効な GeoJSON MultiLineString geometry 型。 詳細については、 RFC 7946 を参照してください。
GeoJsonMultiPoint	有効な GeoJSON MultiPoint geometry 型。 詳細については、 RFC 7946 を参照してください。
GeoJsonMultiPolygon	有効な GeoJSON MultiPolygon オブジェクト型。 詳細については、 RFC 7946 を参照してください。
GeoJsonPoint	有効な GeoJSON Point geometry 型。 詳細については、 RFC 7946 を参照してください。
GeoJsonPolygon	有効な GeoJSON Polygon geometry 型。 詳細については、 RFC 7946 を参照してください。
Geometry	結果の幾何学的形状に関する情報。 型 == Geography の場合にのみ存在します。
LatLongPairAbbreviated	短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。
LocalizedMapView	View パラメーター ("user region" パラメーターとも呼ばれます) を使用すると、地政学的に紛争が発生している地域の特定の国/地域の正しいマップを表示できます。 このようなリージョンのビューは国や地域によって異なり、View パラメーターを使用すると、アプリケーションが提供する国/地域に必要なビューにアプリケーションを準拠できます。 既定では、要求で定義していない場合でも、View パラメーターは "Unified" に設定されます。 ユーザーの場所を特定し、その場所を正しく View パラメーターを設定するのはユーザーの責任です。 または、要求の IP アドレスに基づいてマップ データを返す 'View = Auto' を設定することもできます。 Azure Mapsの View パラメーターは、マップ、画像、その他のデータ、Azure Maps経由でアクセスする権限を持つ第三者のコンテンツが利用可能になる国/地域のマッピングに関する法律を含む、適用される法律に準拠して使用する必要があります。 例: view=IN。 詳細については、「 サポートされているビュー 」を参照し、使用可能なビューを参照してください。
MatchType	逆引きアドレス検索操作の一致の種類。
OperatingHours	POI (ポイント オブ インタレスト) の営業時間。
OperatingHoursRange	POI (ポイント オブ インタレスト) の操作時間。 操作時間の可用性は、使用可能なデータによって異なります。 渡されない場合、営業時間情報は返されません。 サポートされている値: nextSevenDays
OperatingHoursTime	日付と時刻を表します
OperatingHoursTimeRange	1 日の時間範囲を開く
PointOfInterest	名前、電話番号、URL アドレス、分類などの情報を含む、返される POI の詳細。
PointOfInterestCategorySet	POI カテゴリ
QueryType	返されるクエリの種類: NEARBY または NON_NEAR。
ResponseFormat	応答の目的の形式。 値には json または xml を指定できます。
SearchAddressResult	このオブジェクトは、正常なSearch呼び出しから返されます。
SearchAddressResultItem	Search API 応答の Result オブジェクト。
SearchAddressResultType	つぎのいずれかです。 POI Street [地理的な場所] ポイント住所 アドレス範囲 交差道路
SearchIndexes	結果に拡張郵便番号を含める必要があるインデックス。 使用可能なインデックスは次のとおりです。 Addr = アドレス範囲 Geo = Geographies PAD = ポイント アドレス POI = 関心のあるポイント Str = Streets XStr = クロス ストリート (交差) 値は、インデックスの種類のコンマ区切りのリスト (任意の順序) またはインデックスがない場合 は None にする必要があります。 既定では、Geo を除くすべてのインデックスに拡張郵便番号が含まれます。 地域の拡張郵便番号リストは非常に長い場合があるため、必要に応じて明示的に要求する必要があります。 使用例: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None 拡張郵便番号は、住所の extendedPostalCode プロパティとして返されます。 可用性はリージョンによって異なります。
SearchInsideGeometryRequest	この型は、Search Inside Geometry サービスの要求本文を表します。
SearchSummary	Search API 応答の Summary オブジェクト。

Address

結果のアドレス

名前	型	説明
boundingBox	BoundingBoxCompassNotation	場所の境界ボックス。
buildingNumber	string	通りの建物番号。 非推奨です。代わりに streetNumber を使用してください。
country	string	国/地域名
countryCode	string	国 (注: これは国/地域名ではなく、2 文字のコードです)。
countryCodeISO3	string	ISO alpha-3 国コード
countrySecondarySubdivision	string	County
countrySubdivision	string	都道府県
countrySubdivisionCode	string	countrySubdivisionCode プレフィックスは countryCode ( countryCode-countrySubdivisionCode ) で、ハイフンは ISO 3166-2 コードを形成します。 例: テキサス州の場合は TX、スコットランドの場合は SCT、オンタリオ州の場合は ON です。
countrySubdivisionName	string	国/地域管理階層の第 1 レベルの完全名。 このフィールドは、countrySubdivision が省略形で表示される場合にのみ表示されます。 米国、カナダ、英国でのみサポートされます。
countryTertiarySubdivision	string	名前付き領域
crossStreet	string	交差している通りの名前。
extendedPostalCode	string	拡張郵便番号 (利用可能時間は地域によって異なります)。
freeformAddress	string	結果の配信元の国/地域の書式設定規則に従って書式設定された住所行、または国/地域の場合は、その完全な国/地域名。
localName	string	管理単位を使用せずに、アドレス指定の目的で複数のアドレス指定可能オブジェクトをグループ化する地理的領域または地域の名前を表すアドレス コンポーネント。 このフィールドは、 プロパティのビルドに使用されます freeformAddress 。 localName は、郵便番号の市区町村を表します。 場所に応じて、 localName は都市または町の一般的に知られている名前です。 都市または町の一般的に知られている名前の場合は、 ではなく municipalityを使用localNameします。
municipality	string	市区町村 注: municipality は、居住区を表します。 場所によっては、 municipality 市区町村の一般的に知られている名前と値が異なる場合があります。 市区町村の一般的に知られている名前の場合は、値の代わりにmunicipality値をlocalName使用することをお勧めします。
municipalitySubdivision	string	サブ / スーパーシティ
neighbourhood	string	地域は、都市または町内の地理的にローカライズされた地域であり、住民間の独特の特徴と社会的相互作用を持っています。
postalCode	string	郵便番号/郵便番号
routeNumbers	string[]	道路を明確に識別するために使用されるコード
street	string	通りの名前。 非推奨です。代わりに streetName を使用してください。
streetName	string	通りの名前。
streetNameAndNumber	string	通りの名前と番号。
streetNumber	string	通りの建物番号。

AddressRanges

検索結果の通りの両側のアドレス範囲について説明します。 アドレス範囲の開始位置と終了位置の座標が含まれます。

名前	型	説明
from	LatLongPairAbbreviated	短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。
rangeLeft	string	通りの左側の住所範囲。
rangeRight	string	通りの右側の住所範囲。
to	LatLongPairAbbreviated	短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。

BoundingBox

ビューポートの左上と右下の座標で表される結果をカバーするビューポート。

名前	型	説明
btmRightPoint	LatLongPairAbbreviated	短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。
topLeftPoint	LatLongPairAbbreviated	短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。

BoundingBoxCompassNotation

場所の境界ボックス。

名前	型	説明
entity	Entity	境界ボックスのエンティティ型ソース。 逆ジオコーディングの場合、これは常に位置と等しくなります。
northEast	string	コンマ区切りの浮動小数点数として境界ボックスの北東緯度、経度座標
southWest	string	境界ボックスの南西緯度、経度座標 (コンマ区切り浮動小数点数)

Brand

POI に関連付けられているブランド

名前	型	説明
name	string	ブランドの名前

Classification

返される POI の分類

名前	型	説明
code	string	code プロパティ
names	ClassificationName[]	名前配列

ClassificationName

分類の名前

名前	型	説明
name	string	Name プロパティ
nameLocale	string	Name Locale プロパティ

DataSources

省略可能なセクション。 Get Search Polygon API で使用する参照 ID。

名前	型	説明
geometry	Geometry	結果の幾何学的形状に関する情報。 型 == Geography の場合にのみ存在します。

Entity

境界ボックスのエンティティ型ソース。 逆ジオコーディングの場合、これは常に位置と等しくなります。

名前	型	説明
position	string	Position エンティティ

EntryPoint

返される POI のエントリ ポイント。

名前	型	説明
position	LatLongPairAbbreviated	短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。
type	EntryPointType	エントリ ポイントの種類。 値には、メインまたはマイナーのいずれかを指定できます。

EntryPointType

エントリ ポイントの種類。 値には、メインまたはマイナーのいずれかを指定できます。

名前	型	説明
main	string
minor	string

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラー メッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	error オブジェクト。

GeographicEntityType

Geography エンティティ型。 entityType が要求され、使用可能な場合にのみ表示されます。

名前	型	説明
Country	string	国/地域名
CountrySecondarySubdivision	string	County
CountrySubdivision	string	都道府県
CountryTertiarySubdivision	string	名前付き領域
Municipality	string	市区町村
MunicipalitySubdivision	string	サブ / スーパーシティ
Neighbourhood	string	近所
PostalCodeArea	string	郵便番号/郵便番号

GeoJsonFeature

有効な GeoJSON Feature オブジェクト型。 詳細については、 RFC 7946 を参照してください。

名前	型	説明
featureType	string	機能の種類です。 この値は、現在の特徴が含まれるデータ モデルによって異なります。 一部のデータ モデルには空の値が含まれる場合があります。
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	有効な GeoJSON geometry オブジェクト。 この型は、Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection の 7 つの有効な GeoJSON ジオメトリ型のいずれかである必要があります。 詳細については、 RFC 7946 を参照してください。
id	string	機能の識別子。
type	string: Feature	型を指定します GeoJSON 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonFeatureCollection

有効な GeoJSON FeatureCollection オブジェクト型。 詳細については、 RFC 7946 を参照してください。

名前	型	説明
features	GeoJsonFeature[]	有効な GeoJSON Feature オブジェクトの一覧を格納します。
type	string: FeatureCollection	型を指定します GeoJSON 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonGeometry

有効な GeoJSON geometry オブジェクト。 この型は、Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection の 7 つの有効な GeoJSON ジオメトリ型のいずれかである必要があります。 詳細については、 RFC 7946 を参照してください。

名前	型	説明
type	GeoJsonObjectType	型を指定します GeoJSON 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonGeometryCollection

有効な GeoJSON GeometryCollection オブジェクト型。 詳細については、 RFC 7946 を参照してください。

名前	型	説明
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	有効な GeoJSON geometry オブジェクトの一覧を格納します。 GeoJSON の座標は x、y の順序 (経度、緯度) であることに注意してください。
type	string: GeometryCollection	型を指定します GeoJSON 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonLineString

有効な GeoJSON LineString geometry 型。 詳細については、 RFC 7946 を参照してください。

名前	型	説明
coordinates	number[]	ジオメトリの GeoJson LineString 座標。
type	string: LineString	型を指定します GeoJSON 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonMultiLineString

有効な GeoJSON MultiLineString geometry 型。 詳細については、 RFC 7946 を参照してください。

名前	型	説明
coordinates	number[]	ジオメトリの GeoJson MultiLineString 座標。
type	string: MultiLineString	型を指定します GeoJSON 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonMultiPoint

有効な GeoJSON MultiPoint geometry 型。 詳細については、 RFC 7946 を参照してください。

名前	型	説明
coordinates	number[]	ジオメトリの GeoJson MultiPoint 座標。
type	string: MultiPoint	型を指定します GeoJSON 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonMultiPolygon

有効な GeoJSON MultiPolygon オブジェクト型。 詳細については、 RFC 7946 を参照してください。

名前	型	説明
coordinates	number[]	有効な GeoJSON Polygon オブジェクトの一覧を格納します。 GeoJSON の座標は x、y の順序 (経度、緯度) であることに注意してください。
type	string: MultiPolygon	型を指定します GeoJSON 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonPoint

有効な GeoJSON Point geometry 型。 詳細については、 RFC 7946 を参照してください。

名前	型	説明
coordinates	number[]	は Position 、2 つ以上の要素を持つ数値の配列です。 最初の 2 つの要素は 経度 と 緯度で、正確にはその順序です。 高度/標高 は、省略可能な 3 番目の要素です。 詳細については、 RFC 7946 を参照してください。
type	string: Point	型を指定します GeoJSON 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonPolygon

有効な GeoJSON Polygon geometry 型。 詳細については、 RFC 7946 を参照してください。

名前	型	説明
coordinates	number[]	ジオメトリタイプの GeoJson Polygon 座標。
type	string: Polygon	型を指定します GeoJSON 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

Geometry

結果の幾何学的形状に関する情報。 型 == Geography の場合にのみ存在します。

名前	型	説明
id	string	これを geometryId として Get Search Polygon API に渡して、この結果のジオメトリ情報をフェッチします。

LatLongPairAbbreviated

短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。

名前	型	説明
lat	number	Latitude プロパティ
lon	number	Longitude プロパティ

LocalizedMapView

View パラメーター ("user region" パラメーターとも呼ばれます) を使用すると、地政学的に紛争が発生している地域の特定の国/地域の正しいマップを表示できます。 このようなリージョンのビューは国や地域によって異なり、View パラメーターを使用すると、アプリケーションが提供する国/地域に必要なビューにアプリケーションを準拠できます。 既定では、要求で定義していない場合でも、View パラメーターは "Unified" に設定されます。 ユーザーの場所を特定し、その場所を正しく View パラメーターを設定するのはユーザーの責任です。 または、要求の IP アドレスに基づいてマップ データを返す 'View = Auto' を設定することもできます。 Azure Mapsの View パラメーターは、マップ、画像、その他のデータ、Azure Maps経由でアクセスする権限を持つ第三者のコンテンツが利用可能になる国/地域のマッピングに関する法律を含む、適用される法律に準拠して使用する必要があります。 例: view=IN。

詳細については、「 サポートされているビュー 」を参照し、使用可能なビューを参照してください。

名前	型	説明
AE	string	アラブ首長国連邦、AE
AR	string	アルゼンチン (アルゼンチン ビュー)
Auto	string	要求の IP アドレスに基づいてマップ データを返します。
BH	string	バーレーン (アラビアのビュー)
IN	string	インド (インド ビュー)
IQ	string	イラク (アラビアのビュー)
JO	string	ヨルダン (アラビアのビュー)
KW	string	クウェート (アラビアのビュー)
LB	string	レバノン (アラビアのビュー)
MA	string	モロッコ (モロッコのビュー)
OM	string	オマーン (アラビアのビュー)
PK	string	パキスタン (パキスタンのビュー)
PS	string	パレスチナ自治政府 (アラビアのビュー)
QA	string	カタール (アラビアのビュー)
SA	string	サウジアラビア (アラビアのビュー)
SY	string	シリア (アラビアのビュー)
Unified	string	統一されたビュー (その他)
YE	string	イエメン (アラビアのビュー)

MatchType

逆引きアドレス検索操作の一致の種類。

名前	型	説明
AddressPoint	string
HouseNumberRange	string
Street	string

OperatingHours

POI (ポイント オブ インタレスト) の営業時間。

名前	型	説明
mode	string	要求で使用される値: none または "nextSevenDays"
timeRanges	OperatingHoursTimeRange[]	次の 7 日間の時間範囲の一覧

OperatingHoursRange

POI (ポイント オブ インタレスト) の操作時間。 操作時間の可用性は、使用可能なデータによって異なります。 渡されない場合、営業時間情報は返されません。 サポートされている値: nextSevenDays

名前	型	説明
nextSevenDays	string	POI の現地時刻の現在の日から始まる、次の週の操作時間を示します。

OperatingHoursTime

日付と時刻を表します

名前	型	説明
date	string	POI タイム ゾーンの現在のカレンダー日付を表します (例: "2019-02-07")。
hour	integer	時間は、POI の現地時刻の 24 時間形式です。指定できる値は 0 から 23 です。
minute	integer	分は POI の現地時刻です。指定できる値は 0 から 59 です。

OperatingHoursTimeRange

1 日の時間範囲を開く

名前	型	説明
endTime	OperatingHoursTime	特定の POI が閉じられている次の 7 日間の範囲のポイント、または範囲の前に閉じられた場合は範囲の先頭。
startTime	OperatingHoursTime	特定の POI が開かれている次の 7 日間の範囲のポイント、または範囲の前に開かれた場合は範囲の先頭。

PointOfInterest

名前、電話番号、URL アドレス、分類などの情報を含む、返される POI の詳細。

名前	型	説明
brands	Brand[]	ブランド配列。 返される POI のブランド名。
categories	string[]	Categories 配列
categorySet	PointOfInterestCategorySet[]	最も具体的な POI カテゴリの一覧
classifications	Classification[]	分類配列
name	string	POI プロパティの名前
openingHours	OperatingHours	POI (ポイント オブ インタレスト) の営業時間。
phone	string	電話番号プロパティ
url	string	Web サイトの URL プロパティ

PointOfInterestCategorySet

POI カテゴリ

名前	型	説明
id	integer	カテゴリ ID。

QueryType

返されるクエリの種類: NEARBY または NON_NEAR。

名前	型	説明
NEARBY	string	Searchは、定義された半径を持つ特定の緯度と経度を中心に実行されました
NON_NEAR	string	Searchは、特定の緯度と経度に偏らず、半径が定義されていない、グローバルに実行されました

ResponseFormat

応答の目的の形式。 値には json または xml を指定できます。

名前	型	説明
json	string	JavaScript オブジェクト表記データ交換形式
xml	string	拡張可能なマークアップ言語

SearchAddressResult

このオブジェクトは、正常なSearch呼び出しから返されます。

名前	型	説明
results	SearchAddressResultItem[]	Search API の結果の一覧。
summary	SearchSummary	Search API 応答の Summary オブジェクト

SearchAddressResultItem

Search API 応答の Result オブジェクト。

名前	型	説明
address	Address	結果のアドレス
addressRanges	AddressRanges	検索結果の通りの両側のアドレス範囲について説明します。 アドレス範囲の開始位置と終了位置の座標が含まれます。
dataSources	DataSources	省略可能なセクション。 Get Search Polygon API で使用する参照ジオメトリ ID。
detourTime	integer	迂回時間 (秒単位)。 Search Along Route API の呼び出しに対してのみ返されます。
dist	number	結果とジオビアスの位置間の直線距離 (メートル単位)。
entityType	GeographicEntityType	Geography エンティティ型。 entityType が要求され、使用可能な場合にのみ表示されます。
entryPoints	EntryPoint[]	EntryPoints の配列。 これらは、場所で利用可能な入り口の種類を説明します。 種類は、フロント ドアやロビーなどのメインの入り口には "メイン"、サイド ドアとバック ドアの場合は "マイナー" です。
id	string	Id プロパティ
info	string	Result の元のデータ ソースに関する情報。 サポート要求に使用されます。
matchType	MatchType	一致の種類に関する情報。 つぎのいずれかです。 AddressPoint HouseNumberRange Street
poi	PointOfInterest	名前、電話番号、URL アドレス、分類などの情報を含む、返される POI の詳細。
position	LatLongPairAbbreviated	短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。
score	number	結果セット内の値。結果間の相対的な一致スコアを示します。 これを使用すると、x の値が y の値の 2 倍の場合、結果 x が結果 y と同じ 2 倍の関連性を持つ可能性が高いと判断できます。 値はクエリによって異なり、1 つの結果セットの相対値としてのみ使用されます。
type	SearchAddressResultType	つぎのいずれかです。 POI Street [地理的な場所] ポイント住所 アドレス範囲 交差道路
viewport	BoundingBox	ビューポートの左上と右下の座標で表される結果をカバーするビューポート。

SearchAddressResultType

つぎのいずれかです。

• POI
• Street
• [地理的な場所]
• ポイント住所
• アドレス範囲
• 交差道路

名前	型	説明
Address Range	string
Cross Street	string
Geography	string
POI	string
Point Address	string
Street	string

SearchIndexes

結果に拡張郵便番号を含める必要があるインデックス。

使用可能なインデックスは次のとおりです。

Addr = アドレス範囲

Geo = Geographies

PAD = ポイント アドレス

POI = 関心のあるポイント

Str = Streets

XStr = クロス ストリート (交差)

値は、インデックスの種類のコンマ区切りのリスト (任意の順序) またはインデックスがない場合 は None にする必要があります。

既定では、Geo を除くすべてのインデックスに拡張郵便番号が含まれます。 地域の拡張郵便番号リストは非常に長い場合があるため、必要に応じて明示的に要求する必要があります。

使用例:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

拡張郵便番号は、住所の extendedPostalCode プロパティとして返されます。 可用性はリージョンによって異なります。

名前	型	説明
Addr	string
Geo	string
PAD	string
POI	string
Str	string
Xstr	string

SearchInsideGeometryRequest

この型は、Search Inside Geometry サービスの要求本文を表します。

名前	型	説明
geometry	GeoJsonObject: GeoJsonFeature GeoJsonFeatureCollection	有効な GeoJSON オブジェクト。 詳細については、 RFC 7946 を参照してください。

SearchSummary

Search API 応答の Summary オブジェクト。

名前	型	説明
fuzzyLevel	integer	結果を提供するために必要な最大あいまいレベル。
geoBias	LatLongPairAbbreviated	内部検索エンジンが地理空間バイアスを適用して結果のランク付けが向上したことを示します。 一部のメソッドでは、利用可能な場合に lat パラメーターと lon パラメーターを設定すると、これが影響を受ける可能性があります。 それ以外の場合は、純粋に内部的です。
limit	integer	返される応答の最大数
numResults	integer	応答の結果の数。
offset	integer	完全な結果セット内で返される結果の開始オフセット。
query	string	これらの検索結果の生成に使用されたクエリ パラメーター。
queryTime	integer	クエリの解決に費やされた時間 (ミリ秒単位)。
queryType	QueryType	返されるクエリの種類: NEARBY または NON_NEAR。
totalResults	integer	検出された結果の合計数。