通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Search - Post Search Inside Geometry

  • 参考
服务:
Maps
API 版本:
1.0

用于在一个更多几何图形中执行自由窗体搜索。

Post Search Inside Geometry API 和 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 GeoJSONtypes:<ul><li>**GeoJSON FeatureCollection** <br>Thegeometrycan be represented as aGeoJSON FeatureCollectionobject. This is the recommended option if the geometry contains both Polygons and Circles. TheFeatureCollectioncan contain a max of 50GeoJobjects. EachSON 功能object should represent either a Polygon or a Circle with the following conditions:<ul style="list-style-type:none"><li>A功能object for the Polygon geometry can have a max of 50 coordinates and it's properties must be empty.</li><li>A特征object for the Circle geometry is composed of a _center_ represented using aGeoJSON 点type 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>TheGeometryCollectioncan be represented as aGeoJSON GeometryCollectionobject. This is the recommended option if the geometry contains a list of Polygons only. Thecan contain a max of 50GeoJSON 多边objects. Each形can contain a max of 50GeoJSON 多边形object can have a max of 50 coordinates. Please see the Examples section below for a sampleGeometryCollectionrepresentation.<br><br></li><li>**GeoJSON Polygon**<br>The几何图形can be represented as aGeoJSON 多边形object. This is the recommended option if the geometry contains a single Polygon. The多边形object can have a max of 50 coordinates. Please see the Examples section below for a sample多边形的表示形式。

.

POST https://atlas.microsoft.com/search/geometry/{format}?api-version=1.0&query={query}
具有可选参数: 
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 名称（例如“自由雕像”、“星巴克”、“披萨”）。 必须正确编码 URL。
categorySet
 query

integer[]

类别集 ID 的逗号分隔列表，可用于将结果限制为特定的兴趣点类别。 ID 顺序无关紧要。 每个请求支持的最大 categorySet 值为 10。 提供多个类别标识符时，将仅返回属于提供的列表中的一个类别（至少）的 PO。 可以使用 POI 类别 API 发现受支持的类别列表。 用法示例：

  • categorySet=7315 （类别餐厅的搜索兴趣点）

  • categorySet=7315025,7315017（意大利或法国餐厅类别的搜索兴趣点）
extendedPostalCodesFor
 query

SearchIndexes[]

结果中应包含扩展邮政编码的索引。

可用索引包括：

Addr = 地址范围

地理 = 地理区域

PAD = 点地址

POI = 兴趣点

Str = 街道

XStr = 十字街 （十字路口）

值应是索引类型的逗号分隔列表（按任意顺序）或 无 索引。

默认情况下，除 Geo 之外的所有索引都包含扩展邮政编码。 地理区域扩展邮政编码列表可能很长，因此必须在需要时显式请求它们。

用法示例：

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD，Addr，POI

extendedPostalCodesFor=None

扩展邮政编码作为地址的 extendedPostalCode 属性返回。 可用性依赖于区域。
idxSet
 query

SearchIndexes[]

应用于搜索的索引的逗号分隔列表。 项顺序无关紧要。 可用索引包括：Addr = 地址范围内插，地理 = 地理区域，PAD = 点地址，POI = 兴趣点，Str = 街道，Xstr = 十字街 （十字路口）
language
 query

string

应返回搜索结果的语言。 应该是受支持的 IETF 语言标记之一，不区分大小写。 当指定语言中的数据不适用于特定字段时，将使用默认语言。

有关详细信息，请参阅 支持的语言。
limit
 query

integer

minimum: 1
maximum: 100

将返回的最大响应数。 默认值：10，最小值：1，最大值：100
openingHours
 query

OperatingHoursRange

POI（兴趣点）的小时作时间。 作时间的可用性因可用数据而异。 如果未通过，则不会返回任何营业时间信息。 支持的值：nextSevenDays
view
 query

LocalizedMapView

View 参数（也称为“用户区域”参数）允许为地缘政治争议区域显示特定国家/地区的正确地图。 不同的国家/地区具有此类区域的不同视图，并且 View 参数允许应用程序符合应用程序将提供服务的国家/地区所需的视图。 默认情况下，即使尚未在请求中定义该参数，View 参数也会设置为“Unified”。 由你负责确定用户的位置，然后为该位置正确设置 View 参数。 或者，可以选择设置“View=Auto”，这将基于请求的 IP 地址返回地图数据。 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:

有效的 GeoJSON 对象。 有关详细信息，请参阅 RFC 7946。

响应

名称 类型 说明
200 OK

SearchAddressResult

还行
Other Status Codes

ErrorResponse

发生意外错误。

安全性

AADToken

这些 Microsoft Entra OAuth 2.0 流。 与 Azure 基于角色的访问配对时， 控制它可用于控制对 Azure Maps REST API 的访问。 Azure 基于角色的访问控制用于指定对一个或多个 Azure Maps 资源帐户或子资源的访问。 任何用户、组或服务主体都可以通过内置角色或由一个或多个对 Azure Maps REST API 的权限组成的自定义角色授予访问权限。

若要实现方案，建议查看 身份验证概念。 总之，此安全定义提供了一种解决方案，用于通过能够针对特定 API 和范围进行访问控制的对象对应用程序建模。

注释

  • 此安全定义 要求 使用 x-ms-client-id 标头来指示应用程序请求访问的 Azure Maps 资源。 这可以从 地图管理 API 获取。
  • Authorization URL 特定于 Azure 公有云实例。 主权云具有唯一的授权 URL，Microsoft Entra ID 配置。
  • Azure 基于角色的访问控制是通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 从 Azure 管理平面 配置的。
  • 使用 Azure Maps Web SDK 允许为多个用例设置基于应用程序的配置。
  • 有关Microsoft标识平台的详细信息，请参阅 Microsoft标识平台概述。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

这是在 Azure 门户中或使用 PowerShell、CLI、Azure SDK 或 REST API 创建 Azure Maps 帐户 时预配的共享密钥。

使用此密钥，任何应用程序都可以访问所有 REST API。 换句话说，此密钥可用作颁发密钥的帐户中的主密钥。

对于公开的应用程序，我们建议使用 机密客户端应用程序 方法来访问 Azure Maps REST API，以便安全地存储密钥。

类型: apiKey
在: query

SAS Token

这是一个共享访问签名令牌，它通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 通过 Azure 管理平面在 azure Maps 资源 上的列表 SAS 操作创建。

使用此令牌，任何应用程序都有权使用 Azure 基于角色的访问控制进行访问，并精细控制特定令牌的过期、速率和区域。 换句话说，SAS 令牌可用于允许应用程序以比共享密钥更安全的方式控制访问。

对于公开的应用程序，建议在 映射帐户资源 上配置允许的源的特定列表，以限制呈现滥用并定期续订 SAS 令牌。

类型: apiKey
在: 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

示例请求

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
            ]
          ]
        ]
      }
    ]
  }
}

示例响应

状态代码:
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

示例请求

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
        }
      }
    ]
  }
}

示例响应

状态代码:
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

示例请求

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
        ]
      ]
    ]
  }
}

示例响应

状态代码:
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

可选节。 用于 获取搜索多边形 API 的引用 ID。
Entity

边界框的实体类型源。 对于反向地理编码，这始终等于位置。
EntryPoint

要返回的 POI 的入口点。
EntryPointType

入口点的类型。 值可以是主 ，也可以是次要 。
ErrorAdditionalInfo

资源管理错误附加信息。
ErrorDetail

错误详细信息。
ErrorResponse

错误响应
GeographicEntityType

地理实体类型。 仅当请求了 entityType 且可用时才存在。
GeoJsonFeature

有效的 GeoJSON Feature 对象类型。 有关详细信息，请参阅 RFC 7946。
GeoJsonFeatureCollection

有效的 GeoJSON FeatureCollection 对象类型。 有关详细信息，请参阅 RFC 7946。
GeoJsonGeometry

有效的 GeoJSON 几何图形对象。 该类型必须是七种有效的 GeoJSON 几何类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon 和 GeometryCollection。 有关详细信息，请参阅 RFC 7946。
GeoJsonGeometryCollection

有效的 GeoJSON GeometryCollection 对象类型。 有关详细信息，请参阅 RFC 7946。
GeoJsonLineString

有效的 GeoJSON LineString 几何图形类型。 有关详细信息，请参阅 RFC 7946。
GeoJsonMultiLineString

有效的 GeoJSON MultiLineString 几何图形类型。 有关详细信息，请参阅 RFC 7946。
GeoJsonMultiPoint

有效的 GeoJSON MultiPoint 几何图形类型。 有关详细信息，请参阅 RFC 7946。
GeoJsonMultiPolygon

有效的 GeoJSON MultiPolygon 对象类型。 有关详细信息，请参阅 RFC 7946。
GeoJsonPoint

有效的 GeoJSON Point 几何图形类型。 有关详细信息，请参阅 RFC 7946。
GeoJsonPolygon

有效的 GeoJSON Polygon 几何图形类型。 有关详细信息，请参阅 RFC 7946。
Geometry

有关结果几何形状的信息。 仅当类型 == Geography 时才存在。
LatLongPairAbbreviated

用短名称“lat”&“lon”表示为纬度和经度的位置。
LocalizedMapView

View 参数（也称为“用户区域”参数）允许为地缘政治争议区域显示特定国家/地区的正确地图。 不同的国家/地区具有此类区域的不同视图，并且 View 参数允许应用程序符合应用程序将提供服务的国家/地区所需的视图。 默认情况下，即使尚未在请求中定义该参数，View 参数也会设置为“Unified”。 由你负责确定用户的位置，然后为该位置正确设置 View 参数。 或者，可以选择设置“View=Auto”，这将基于请求的 IP 地址返回地图数据。 Azure Maps 中的 View 参数必须符合适用法律，包括地图、图像和其他数据以及你有权通过 Azure Maps 访问的国家/地区的地图、图像和其他数据和第三方内容。 示例：view=IN。

有关详细信息，请参阅 支持的视图，并查看可用的视图。
MatchType

反向地址搜索作的匹配类型。
OperatingHours

POI（兴趣点）的营业时间。
OperatingHoursRange

POI（兴趣点）的小时作时间。 作时间的可用性因可用数据而异。 如果未通过，则不会返回任何营业时间信息。 支持的值：nextSevenDays
OperatingHoursTime

表示日期和时间
OperatingHoursTimeRange

一天的开放时间范围
PointOfInterest

返回的 POI 的详细信息，包括名称、电话、URL 地址和分类等信息。
PointOfInterestCategorySet

POI 类别
QueryType

要返回的查询类型：NEARBY 或 NON_NEAR。
ResponseFormat

响应的所需格式。 值可以是 json ，也可以是 xml 。
SearchAddressResult

此对象是从成功的搜索调用返回的。
SearchAddressResultItem

搜索 API 响应的结果对象。
SearchAddressResultType

下列其中一项：

  • POI
  • 街道
  • 地理
  • 点地址
  • 地址范围
  • 十字路口
SearchIndexes

结果中应包含扩展邮政编码的索引。

可用索引包括：

Addr = 地址范围

地理 = 地理区域

PAD = 点地址

POI = 兴趣点

Str = 街道

XStr = 十字街 （十字路口）

值应是索引类型的逗号分隔列表（按任意顺序）或 无 索引。

默认情况下，除 Geo 之外的所有索引都包含扩展邮政编码。 地理区域扩展邮政编码列表可能很长，因此必须在需要时显式请求它们。

用法示例：

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD，Addr，POI

extendedPostalCodesFor=None

扩展邮政编码作为地址的 extendedPostalCode 属性返回。 可用性依赖于区域。
SearchInsideGeometryRequest

此类型表示搜索内部几何服务的请求正文。
SearchSummary

搜索 API 响应的摘要对象。

Address

Object

结果的地址

名称 类型 说明
boundingBox

BoundingBoxCompassNotation

位置的边界框。
buildingNumber

string

街上的建筑号。 已弃用，请改用 streetNumber。
country

string

国家/地区名称
countryCode

string

国家/地区（注意：这是一个双字母代码，而不是国家/地区名称）。
countryCodeISO3

string

ISO alpha-3 国家/地区代码
countrySecondarySubdivision

string

县
countrySubdivision

string

州或省
countrySubdivisionCode

string

countrySubdivisionCode 以 countryCode（countryCode-countrySubdivisionCode）和连字符作为前缀，构成 ISO 3166-2 代码。 示例：TX for Texas、SCT for 苏格兰和 ON for On on for On。
countrySubdivisionName

string

第一级国家/地区管理层次结构的全名。 仅当 countrySubdivision 以缩写形式显示时，才会显示此字段。 仅支持美国、加拿大和英国。
countryTertiarySubdivision

string

命名区域
crossStreet

string

要交叉的街道的名称。
extendedPostalCode

string

扩展邮政编码（可用性取决于区域）。
freeformAddress

string

根据结果所在国家/地区的格式规则设置格式的地址行，或者在国家/地区的情况下，其完整国家/地区名称。
localName

string

一个地址组件，表示地理区域或区域的名称，用于对多个可寻址对象进行分组以实现寻址目的，而不用作管理单元。 此字段用于生成 freeformAddress 属性。 localName 表示邮政城市。 根据位置，localName 是城市或城镇的已知名称。 对于城市或城镇的已知名称，请使用 localName 而不是 municipality。
municipality

string

城市/城镇
注意：municipality 表示住宅城市。 根据位置，municipality 值可能与城市或城镇的已知名称不同。 对于城市或城镇的已知名称，建议使用 localName 值而不是 municipality 值。
municipalitySubdivision

string

Sub /Super City
neighbourhood

string

邻里是城市或城镇的地理本地化区域，具有鲜明的特点和居民之间的社会互动。
postalCode

string

邮政编码/邮政编码
routeNumbers

string[]

用于明确标识街道的代码
street

string

街道名称。 已弃用，请改用 streetName。
streetName

string

街道名称。
streetNameAndNumber

string

街道名称和编号。
streetNumber

string

街上的建筑号。

AddressRanges

Object

描述街道两侧的地址范围，以获取搜索结果。 包括地址范围的开始位置和结束位置的坐标。

名称 类型 说明
from

LatLongPairAbbreviated

用短名称“lat”&“lon”表示为纬度和经度的位置。
rangeLeft

string

街道左侧的地址范围。
rangeRight

string

街道右侧的地址范围。
to

LatLongPairAbbreviated

用短名称“lat”&“lon”表示为纬度和经度的位置。

BoundingBox

Object

覆盖视区左上角和右下坐标表示的结果的视区。

名称 类型 说明
btmRightPoint

LatLongPairAbbreviated

用短名称“lat”&“lon”表示为纬度和经度的位置。
topLeftPoint

LatLongPairAbbreviated

用短名称“lat”&“lon”表示为纬度和经度的位置。

BoundingBoxCompassNotation

Object

位置的边界框。

名称 类型 说明
entity

Entity

边界框的实体类型源。 对于反向地理编码，这始终等于位置。
northEast

string

以逗号分隔的浮点形式的边界框的东北纬度、经度坐标
southWest

string

以逗号分隔的浮点数形式表示边界框的西南纬度、经度坐标

Brand

Object

与 POI 关联的品牌

名称 类型 说明
name

string

品牌名称

Classification

Object

要返回的 POI 的分类

名称 类型 说明
code

string

Code 属性
names

ClassificationName[]

名称数组

ClassificationName

Object

分类的名称

名称 类型 说明
name

string

Name 属性
nameLocale

string

Name Locale 属性

DataSources

Object

可选节。 用于 获取搜索多边形 API 的引用 ID。

名称 类型 说明
geometry

Geometry

有关结果几何形状的信息。 仅当类型 == Geography 时才存在。

Entity

枚举

边界框的实体类型源。 对于反向地理编码，这始终等于位置。

值 说明
position

位置实体

EntryPoint

Object

要返回的 POI 的入口点。

名称 类型 说明
position

LatLongPairAbbreviated

用短名称“lat”&“lon”表示为纬度和经度的位置。
type

EntryPointType

入口点的类型。 值可以是主 ，也可以是次要 。

EntryPointType

枚举

入口点的类型。 值可以是主 ，也可以是次要 。

值 说明
main
minor

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。
type

string

其他信息类型。

ErrorDetail

Object

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。
code

string

错误代码。
details

ErrorDetail[]

错误详细信息。
message

string

错误消息。
target

string

错误目标。

ErrorResponse

Object

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

GeographicEntityType

枚举

地理实体类型。 仅当请求了 entityType 且可用时才存在。

值 说明
Country

国家/地区名称
CountrySecondarySubdivision

县
CountrySubdivision

州或省
CountryTertiarySubdivision

命名区域
Municipality

城市/城镇
MunicipalitySubdivision

Sub /Super City
Neighbourhood

附近
PostalCodeArea

邮政编码/邮政编码

GeoJsonFeature

Object

有效的 GeoJSON Feature 对象类型。 有关详细信息，请参阅 RFC 7946。

名称 类型 说明
featureType

string

功能的类型。 该值取决于当前功能所属的数据模型。 某些数据模型可能具有空值。
geometry GeoJsonGeometry:

有效的 GeoJSON 几何图形对象。 该类型必须是七种有效的 GeoJSON 几何类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon 和 GeometryCollection。 有关详细信息，请参阅 RFC 7946。
id

string

功能的标识符。
type string:

Feature

指定 GeoJSON 类型。 必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonFeatureCollection

Object

有效的 GeoJSON FeatureCollection 对象类型。 有关详细信息，请参阅 RFC 7946。

名称 类型 说明
features

GeoJsonFeature[]

包含有效 GeoJSON Feature 对象的列表。
type string:

FeatureCollection

指定 GeoJSON 类型。 必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonGeometry

Object

有效的 GeoJSON 几何图形对象。 该类型必须是七种有效的 GeoJSON 几何类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon 和 GeometryCollection。 有关详细信息，请参阅 RFC 7946。

名称 类型 说明
type

GeoJsonObjectType

指定 GeoJSON 类型。 必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonGeometryCollection

Object

有效的 GeoJSON GeometryCollection 对象类型。 有关详细信息，请参阅 RFC 7946。

名称 类型 说明
geometries GeoJsonGeometry[]:

包含有效 GeoJSON 几何对象的列表。 注意，GeoJSON 中的坐标以 x、y 顺序（经度、纬度）表示。
type string:

GeometryCollection

指定 GeoJSON 类型。 必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonLineString

Object

有效的 GeoJSON LineString 几何图形类型。 有关详细信息，请参阅 RFC 7946。

名称 类型 说明
coordinates

number[] (double)

GeoJson LineString 几何图形的坐标。
type string:

LineString

指定 GeoJSON 类型。 必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonMultiLineString

Object

有效的 GeoJSON MultiLineString 几何图形类型。 有关详细信息，请参阅 RFC 7946。

名称 类型 说明
coordinates

number[] (double)

GeoJson MultiLineString 几何图形的坐标。
type string:

MultiLineString

指定 GeoJSON 类型。 必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonMultiPoint

Object

有效的 GeoJSON MultiPoint 几何图形类型。 有关详细信息，请参阅 RFC 7946。

名称 类型 说明
coordinates

number[] (double)

GeoJson MultiPoint 几何图形的坐标。
type string:

MultiPoint

指定 GeoJSON 类型。 必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonMultiPolygon

Object

有效的 GeoJSON MultiPolygon 对象类型。 有关详细信息，请参阅 RFC 7946。

名称 类型 说明
coordinates

number[] (double)

包含有效 GeoJSON Polygon 对象的列表。 注意，GeoJSON 中的坐标以 x、y 顺序（经度、纬度）表示。
type string:

MultiPolygon

指定 GeoJSON 类型。 必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonPoint

Object

有效的 GeoJSON Point 几何图形类型。 有关详细信息，请参阅 RFC 7946。

名称 类型 说明
coordinates

number[] (double)

Position 是包含两个或多个元素的数字数组。 前两个元素 经度 和 纬度，精确按顺序排列。 海拔/海拔 是可选的第三个元素。 有关详细信息，请参阅 RFC 7946。
type string:

Point

指定 GeoJSON 类型。 必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonPolygon

Object

有效的 GeoJSON Polygon 几何图形类型。 有关详细信息，请参阅 RFC 7946。

名称 类型 说明
coordinates

number[] (double)

GeoJson Polygon 几何图形类型的坐标。
type string:

Polygon

指定 GeoJSON 类型。 必须是九种有效的 GeoJSON 对象类型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

Geometry

Object

有关结果几何形状的信息。 仅当类型 == Geography 时才存在。

名称 类型 说明
id

string

将此作为 geometryId 传递给 获取搜索多边形 API 以获取此结果的几何信息。

LatLongPairAbbreviated

Object

用短名称“lat”&“lon”表示为纬度和经度的位置。

名称 类型 说明
lat

number (double)

Latitude 属性
lon

number (double)

经度属性

LocalizedMapView

枚举

View 参数（也称为“用户区域”参数）允许为地缘政治争议区域显示特定国家/地区的正确地图。 不同的国家/地区具有此类区域的不同视图，并且 View 参数允许应用程序符合应用程序将提供服务的国家/地区所需的视图。 默认情况下，即使尚未在请求中定义该参数，View 参数也会设置为“Unified”。 由你负责确定用户的位置，然后为该位置正确设置 View 参数。 或者，可以选择设置“View=Auto”，这将基于请求的 IP 地址返回地图数据。 Azure Maps 中的 View 参数必须符合适用法律，包括地图、图像和其他数据以及你有权通过 Azure Maps 访问的国家/地区的地图、图像和其他数据和第三方内容。 示例：view=IN。

有关详细信息，请参阅 支持的视图，并查看可用的视图。

值 说明
AE

阿拉伯联合酋长国（阿拉伯语视图）
AR

阿根廷 （阿根廷视图）
Auto

根据请求的 IP 地址返回映射数据。
BH

巴林 （阿拉伯语视图）
IN

印度 （印度视图）
IQ

伊拉克 （阿拉伯语视图）
JO

约旦 （阿拉伯语视图）
KW

科威特 （阿拉伯语视图）
LB

黎巴嫩 （阿拉伯语视图）
MA

摩洛哥 （摩洛哥视图）
OM

阿曼 （阿拉伯语视图）
PK

巴基斯坦（巴基斯坦观点）
PS

巴勒斯坦民族权力机构（阿拉伯语视图）
QA

卡塔尔 （阿拉伯语视图）
SA

沙特阿拉伯 （阿拉伯语视图）
SY

叙利亚 （阿拉伯语视图）
Unified

统一视图 （其他）
YE

也门 （阿拉伯语视图）

MatchType

枚举

反向地址搜索作的匹配类型。

值 说明
AddressPoint
HouseNumberRange
Street

OperatingHours

Object

POI（兴趣点）的营业时间。

名称 类型 说明
mode

string

请求中使用的值：none 或“nextSevenDays”
timeRanges

OperatingHoursTimeRange[]

未来 7 天的时间范围列表

OperatingHoursRange

枚举

POI（兴趣点）的小时作时间。 作时间的可用性因可用数据而异。 如果未通过，则不会返回任何营业时间信息。 支持的值：nextSevenDays

值 说明
nextSevenDays

显示下周的作小时数，从 POI 本地时间的当前日期开始。

OperatingHoursTime

Object

表示日期和时间

名称 类型 说明
date

string

表示 POI 时区中的当前日历日期，例如“2019-02-07”。
hour

integer

小时采用 POI 本地时间的 24 小时格式;可能的值为 0 - 23。
minute

integer

分钟数位于 POI 的本地时间;可能的值为 0 - 59。

OperatingHoursTimeRange

Object

一天的开放时间范围

名称 类型 说明
endTime

OperatingHoursTime

当给定 POI 处于关闭状态时，在接下来的 7 天内的点，或者在范围之前关闭该范围时的起始点。
startTime

OperatingHoursTime

当给定的 POI 处于打开状态时，在接下来的 7 天内的点，或者在范围之前打开范围时的起始点。

PointOfInterest

Object

返回的 POI 的详细信息，包括名称、电话、URL 地址和分类等信息。

名称 类型 说明
brands

Brand[]

品牌数组。 要返回的 POI 的品牌名称。
categories

string[]

类别数组
categorySet

PointOfInterestCategorySet[]

最具体的 POI 类别列表
classifications

Classification[]

分类数组
name

string

POI 属性的名称
openingHours

OperatingHours

POI（兴趣点）的营业时间。
phone

string

电话号码属性
url

string

网站 URL 属性

PointOfInterestCategorySet

Object

POI 类别

名称 类型 说明
id

integer

类别 ID

QueryType

枚举

要返回的查询类型：NEARBY 或 NON_NEAR。

值 说明
NEARBY

搜索是在具有定义半径的特定纬度和经度周围执行的
NON_NEAR

搜索全局执行，不偏向特定纬度和经度，且未定义半径

ResponseFormat

枚举

响应的所需格式。 值可以是 json ，也可以是 xml 。

值 说明
json

JavaScript 对象表示法数据交换格式
xml

可扩展标记语言

SearchAddressResult

Object

此对象是从成功的搜索调用返回的。

名称 类型 说明
results

SearchAddressResultItem[]

搜索 API 结果的列表。
summary

SearchSummary

搜索 API 响应的摘要对象

SearchAddressResultItem

Object

搜索 API 响应的结果对象。

名称 类型 说明
address

Address

结果的地址
addressRanges

AddressRanges

描述街道两侧的地址范围，以获取搜索结果。 包括地址范围的开始位置和结束位置的坐标。
dataSources

DataSources

可选节。 引用用于 “获取搜索多边形” API 的几何图形 ID。
detourTime

integer

绕行时间（以秒为单位）。 仅返回对沿路由 API 搜索的调用。
dist

number (double)

结果与地理位置之间的直线距离（以米为单位）。
entityType

GeographicEntityType

地理实体类型。 仅当请求了 entityType 且可用时才存在。
entryPoints

EntryPoint[]

EntryPoints 数组。 这些描述地点可用的入口类型。 类型可以是主入口的“主”，如前门或大厅，以及侧门和后门的“次要”。
id

string

Id 属性
info

string

有关结果的原始数据源的信息。 用于支持请求。
matchType

MatchType

有关匹配类型的信息。

下列其中一项：

  • AddressPoint
  • HouseNumberRange
  • 街道
poi

PointOfInterest

返回的 POI 的详细信息，包括名称、电话、URL 地址和分类等信息。
position

LatLongPairAbbreviated

用短名称“lat”&“lon”表示为纬度和经度的位置。
score

number (double)

结果集中的值，用于指示结果之间的相对匹配分数。 如果 x 的值是 y 值 2 倍，则可以使用它来确定结果 x 与结果 y 相关两倍。 这些值因查询而异，仅用作一个结果集的相对值。
type

SearchAddressResultType

下列其中一项：

  • POI
  • 街道
  • 地理
  • 点地址
  • 地址范围
  • 十字路口
viewport

BoundingBox

覆盖视区左上角和右下坐标表示的结果的视区。

SearchAddressResultType

枚举

下列其中一项：

  • POI
  • 街道
  • 地理
  • 点地址
  • 地址范围
  • 十字路口
值 说明
Address Range
Cross Street
Geography
POI
Point Address
Street

SearchIndexes

枚举

结果中应包含扩展邮政编码的索引。

可用索引包括：

Addr = 地址范围

地理 = 地理区域

PAD = 点地址

POI = 兴趣点

Str = 街道

XStr = 十字街 （十字路口）

值应是索引类型的逗号分隔列表（按任意顺序）或 无 索引。

默认情况下，除 Geo 之外的所有索引都包含扩展邮政编码。 地理区域扩展邮政编码列表可能很长，因此必须在需要时显式请求它们。

用法示例：

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD，Addr，POI

extendedPostalCodesFor=None

扩展邮政编码作为地址的 extendedPostalCode 属性返回。 可用性依赖于区域。

值 说明
Addr
Geo
PAD
POI
Str
Xstr

SearchInsideGeometryRequest

Object

此类型表示搜索内部几何服务的请求正文。

名称 类型 说明
geometry GeoJsonObject:

有效的 GeoJSON 对象。 有关详细信息，请参阅 RFC 7946。

SearchSummary

Object

搜索 API 响应的摘要对象。

名称 类型 说明
fuzzyLevel

integer

提供结果所需的最大模糊级别。
geoBias

LatLongPairAbbreviated

指示内部搜索引擎何时应用地理空间偏差来提高结果排名。 在某些方法中，这可以通过设置 lat 和 lon 参数（如果可用）而受到影响。 在其他情况下，它纯粹是内部的。
limit

integer

将返回的最大响应数
numResults

integer

响应中的结果数。
offset

integer

完整结果集中返回的结果的起始偏移量。
query

string

用于生成这些搜索结果的查询参数。
queryTime

integer

解析查询所用的时间（以毫秒为单位）。
queryType

QueryType

要返回的查询类型：NEARBY 或 NON_NEAR。
totalResults

integer

找到的结果总数。