更新时间:2023-08-07 GMT+08:00
分享

HMS位置服务

HMS位置服务连接器包含“周边搜索”、“关键字搜索”和“地点详情”三个执行动作。

连接参数

HMS位置服务连接器使用APIkey认证,创建HMS位置服务连接时连接参数说明如表1所示。

表1 连接参数说明

名称

必填

说明

示例值/默认值

连接名称

设置连接名称。

HMS位置服务连接。

描述

对于连接的信息描述说明。

description

key

API密钥。

获取方式请参考API Console操作指南进行配置后,登录开发者联盟获取AppKey。

周边搜索

搜索周边位置信息。

  • 输入参数

    用户配置周边搜索执行动作,相关参数说明如表2所示。

    表2 周边搜索输入参数说明

    参数

    必填

    说明

    经度

    用户定义经度,取值范围:[-180,180]。

    维度

    用户定义维度,取值范围:[-90,90]。

    搜索关键字

    输入搜索关键字。

    搜索半径

    搜索半径,单位:米,取值范围:[1,50000],默认50000米。

    每页返回的记录数

    每页返回的记录数,取值范围:[1,20],默认20。

    当前页数

    当前页数,取值范围:[1,60],默认1。

  • 输出参数

    用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表3

    表3 周边搜索输出参数说明

    参数

    说明

    错误码

    错误码。

    错误码描述

    错误码描述。

    记录总数

    如果查询成功,返回记录总数。如果没有结果,返回0。

    搜索结果

    如果查询成功,返回搜索结果。如果没有结果,返回空数组。

    详细地址

    格式化的地点详细地址。

    国家名

    国家名。

    三级行政区

    国家下面的三级行政区。

    一级行政区

    国家下面的一级行政区,一般是省/州。

    二级行政区

    国家下面的二级行政区,一般是市。

    城市

    城市。

    区/县

    区/县。

    街道号

    街道号。

    街道名

    街道名。

    邮政编码

    邮政编码。

    地点名称

    地点名称。

    地址ID

    地点的唯一主键。

    经度

    经度,取值范围:[-180,180]。

    维度

    维度,取值范围:[-90,90]。

    距离

    预测地点和传参经维度之间的直线距离,单位:米。

关键字搜索

根据位置关键字搜索。

  • 输入参数

    用户配置关键字搜索执行动作,相关参数说明如表4所示。

    表4 关键字搜索输入参数说明

    参数

    必填

    说明

    搜索关键字

    输入搜索关键字。

    搜索半径

    搜索半径,单位:米,取值范围:[1,50000],默认50000米。

    地点经度

    地点经度,取值范围:[-180,180]。

    地点维度

    地点维度,取值范围:[-90,90]。

    每页返回的记录数

    每页返回的记录数,取值范围:[1,20],默认20。

    当前页数

    当前页数,取值范围:[1,60],默认1。

    • 输出参数

      用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表5

      表5 关键字搜索输出参数说明

      参数

      说明

      错误码

      错误码。

      错误码描述

      错误码描述。

      记录总数

      如果查询成功,返回记录总数。如果没有结果,返回0。

      搜索结果

      如果查询成功,返回搜索结果。如果没有结果,返回空数组。

      详细地址

      格式化的地点详细地址。

      国家名

      国家名。

      三级行政区

      国家下面的三级行政区。

      一级行政区

      国家下面的一级行政区,一般是省/州。

      二级行政区

      国家下面的二级行政区,一般是市。

      城市

      城市。

      区/县

      区/县。

      街道号

      街道号。

      街道名

      街道名。

      邮政编码

      邮政编码。

      地点名称

      地点名称。

      地址ID

      地点的唯一主键。

      经度

      经度,取值范围:[-180,180]。

      维度

      维度,取值范围:[-90,90]。

      距离

      预测地点和传参经维度之间的直线距离,单位:米。

地点详情

地点的详情信息。

  • 输入参数

    用户配置地点详情执行动作,相关参数说明如表6所示。

    表6 地点详情输入参数说明

    参数

    必填

    说明

    地址ID

    地点的唯一主键。

  • 输出参数

    用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表7

    表7 地点详情输出参数说明

    参数

    说明

    错误码

    错误码。

    错误码描述

    错误码描述。

    记录总数

    如果查询成功,返回记录总数。如果没有结果,返回0。

    搜索结果

    如果查询成功,返回搜索结果。如果没有结果,返回空数组。

    详细地址

    格式化的地点详细地址。

    国家名

    国家名。

    三级行政区

    国家下面的三级行政区。

    一级行政区

    国家下面的一级行政区,一般是省/州。

    二级行政区

    国家下面的二级行政区,一般是市。

    城市

    城市。

    区/县

    区/县。

    街道号

    街道号。

    街道名

    街道名。

    邮政编码

    邮政编码。

    地点名称

    地点名称。

    地址ID

    地点的唯一主键。

    经度

    经度,取值范围:[-180, 180]。

    维度

    维度,取值范围:[-90, 90]。

相关文档