Compartilhar via


PlaceResult Object

Note

Bing Maps Web Control SDK retirement

Bing Maps Web Control SDK is deprecated and will be retired. Free (Basic) account customers can continue to use Bing Maps Web Control SDK until June 30th, 2025. Enterprise account customers can continue to use Bing Maps Web Control SDK until June 30th, 2028. To avoid service disruptions, all implementations using Bing Maps Web Control SDK will need to be updated to use Azure Maps Web SDK by the retirement date that applies to your Bing Maps for Enterprise account type. For detailed migration guidance, see Migrate from Bing Maps Web Control SDK and Migrate Bing Maps Enterprise applications to Azure Maps with GitHub Copilot.

Azure Maps is Microsoft's next-generation maps and geospatial services for developers. Azure Maps has many of the same features as Bing Maps for Enterprise, and more. To get started with Azure Maps, create a free Azure subscription and an Azure Maps account. For more information about azure Maps, see Azure Maps Documentation. For migration guidance, see Bing Maps Migration Overview.

Represents a place result in the Search module.

Properties

Name Type Description
address Address A structured address object.
bestView LocationRect The location rectangle that defines the boundaries of the best map view of the place result.
entityType string The classification of the geographic entity returned, such as PopulatedPlace.
location Location The geocoded location of the best result.
locations GeocodeLocation[] The geocoded locations.
matchCode MatchCode The match code of the best result. The possible values are:

  • Good: The location has only one match or all returned matches are considered strong matches. For example, a query for New York returns several Good matches.
  • Ambiguous: The location is one of a set of possible matches. For example, when you query for the street address 128 Main St., the response may return two locations for 128 North Main St. and 128 South Main St. because there is not enough information to determine which option to choose.
  • UpHierarchy: The location represents a move up the geographic hierarchy. This occurs when a match for the location request was not found, so a less precise result is returned. For example, if a match for the requested address cannot be found, then a match code of UpHierarchy with a RoadBlock entity type may be returned.
matchConfidence MatchConfidence The match confidence of the best result. The possible values are:

  • High
  • Medium
  • Low

For more information on this property, see the documentation on the Bing Maps REST Location Data object.
name string The name of the place result, if one exists.