# 地理位置

# getLocation

获取地理定位信息,该方法会异步返回结果。

小程序和微信环境支持在url后面直接拼接参数来获取经纬度(_lat_lng),此方式要求经纬度都同时必传,此方式不会调用微信的api去获取经纬度。

T侧环境下getLocation方法默认调用_tc_bridge_user.get_device_info方法。

3.8.1版本新增字段methodType,showType,cacheType。methodType传入"1"时底层将调用_tc_bridge_map.app_location方法。同时支持showType,cacheType字段

SDK版本要求:1.0.0

# 入参

参数名 描述
needAddress 是否需要反解析地址(0-不需要,1-需要)。非必传,默认0
needPoi 是否需要返回poi信息(0-不返回,1-返回)。非必传,默认0。依赖needAddress
radius 搜索半径(单位:米)。非必传,默认1000
bizType 业务类型(需要找刘洋(yang.liu4)申请)。非必传
uuid 用户唯一标识(建议上传)。非必传
methodType 仅T侧有效。T侧底层调用的方法。string类型 "1":_tc_bridge_map.app_location方法,"2":_tc_bridge_user.get_device_info(默认)。非必传
showType methodType等于"1"时有效。客户端定位loading框是否展示。string类型 "1":显示(默认),"2":不显示。非必传
cacheType methodType等于"1"时有效。定位信息的获取类型。string类型 "1" 使用缓存,如果没有缓存,发起定位(默认),"2" 不使用缓存,强制发起定位,"3" 使用缓存 (无论有无都返回)。非必传
{
  needAddress: 1, 
  needPoi: 1,
  radius: 1000,
  bizType: 'testBizType',
  uuid: 'test-uuid-1'
}

# 返回值

// needAddress为0
{
  "lat": "经度",
  "lng": "纬度",
  "province": "北京市",
  "city": "北京市",
  "coordType": "gcj-02"
}

// needAddress为1
{
  "lat": "经度",
  "lng": "纬度",
  "coordType": "gcj-02", //坐标类型
  "reverseAddress": {
    "address": {
      "formattedAddress": "北京市朝阳区将台镇驼房营路",
      "country":"中国",
      "province":"北京市",
      "city":"北京市",
      "district":"朝阳区",
      "township":"将台镇",
      "street":"万红路",
      "streetNumber":"甲1号",
      "adcode":"110105",
      "regionId":"区域ID",
      "regionName":"区域名称",
      "invertCityName":"北京", //TE统一城市名
      "invertCityId":"100020202", //TE统一城市ID
      "invertCityIdV4":"0101" //TE统一城市ID(v4老版)
    },
    "location": {
      "lat":39.982591,
      "lng":116.502869
    },
    "pois": [
      {"title":"活的3D博物馆","distance":"200.033"},
      {"title":"材艺工房","distance":"266.695"},
      {"title":"北京数字出版云中心","distance":"211.194"}
    ],
    "optimalPoi":{"title":"活的3D博物馆","distance":"200.033"}, //最佳地标(不一定有)
    "additional":{"brand":"高德"} //使用的是哪家的逆地址解析服务(腾讯、百度、高德、google)
  }
}

# 错误码

错误码 描述
1 获取地理位置信息json解析失败
2 未知原因的定位失败
3 微信中定位失败,用户点击取消或系统未开启定位
4 微信配置/授权错误(仅微信环境)
5 定位超时
6 用户拒绝了定位(仅浏览器环境)
7 当前系统不支持定位(仅浏览器环境)
8 当前浏览器不支持定位(仅浏览器环境)
11 逆地址解析接口调用成功,但接口未能返回正确数据。
12 接口调用失败,一般是接口超时,入参缺失等造成。
111 微信签名接口调用失败(仅微信环境)
112 微信授权错误(仅微信环境)

# 兼容性

端类型 最低版本 描述
T-App 7.2.0
E-App 9.5.1
H5 *
微信 *
手Q *

示例


# reverseAddress

逆地址解析(通过经纬度获取地址相关信息)。

SDK版本要求:1.0.0

# 入参

参数名 描述
bizType 业务线类型。必传,需找刘洋(yang.liu4)申请
lng 纬度。必传
lat 经度。必传
coordType 坐标类型。非必传,可选值:gcj-02、wgs84、bd-09,默认gcj-02
needPoi 是否需要周边地标数据(0-不需要,1需要)。非必传,默认0
radius 查询周边地标的范围。非必传,默认1000米
clientType 客户端类型。非必传,可选值:1-iOS、3-Android、7-h5、9-微信小程序、11-TIOS、13-TAndroid,默认为当前客户端类型
uuid 用户唯一标识。非必传,建议传
timeout 超时时间。非必传,默认5000毫秒
{
  lat: 39.98711364223102, //北京同程艺龙大厦坐标
  lng: 116.50773442402787,
  coordType: 'gcj-02',
  clientType: 11,
  bizType: 'testBizType',
  needPoi: 0,
  radius: 3000,
  uuid: 'test-uuid-1',
  timeout: 5000
}

# 返回值

{
  "address": {
    "formattedAddress": "北京市朝阳区将台镇驼房营路",
    "country":"中国",
    "province":"北京市",
    "city":"北京市",
    "district":"朝阳区",
    "township":"将台镇",
    "street":"万红路",
    "streetNumber":"甲1号",
    "adcode":"110105",
    "regionId":"区域ID",
    "regionName":"区域名称",
    "invertCityName":"北京", //TE统一城市名
    "invertCityId":"100020202", //TE统一城市ID
    "invertCityIdV4":"0101" //TE统一城市ID(v4老版)
  },
  "location": {
    "lat":39.982591,
    "lng":116.502869
  },
  "pois": [
    {"title":"活的3D博物馆","distance":"200.033"},
    {"title":"材艺工房","distance":"266.695"},
    {"title":"北京数字出版云中心","distance":"211.194"}
  ],
  "optimalPoi":{"title":"活的3D博物馆","distance":"200.033"}, //最佳地标(不一定有)
  "additional":{"brand":"高德"} //使用的是哪家的逆地址解析服务(腾讯、百度、高德、google)
}

# 错误码

错误码 描述
11 逆地址解析接口调用成功,但接口未能返回正确数据。
12 接口调用失败,一般是接口超时,入参缺失等造成。

# 兼容性

端类型 最低版本 描述
T-App 9.2.0
E-App 9.50.0
H5 *
微信Web *
微信小程序 *
手Q *

示例

# getPoiSearch

获取周边关键字数据。

SDK版本要求:3.7.1

# 入参

参数名 描述
keyword 查询的关键字。必传
latitude 经度。必传
longitude 纬度。必传
radius 查询周边地标的范围。非必传,默认5000
type 地图类型。非必传,默认0 系统地图传0,百度地图传1
mapKey 百度地图的key。如果type为1,则必传
{
  keywrod: "美食",
  latitude: "39",
  longitude: "116",
  radius: 5000,
  type: 0
}

# 返回值

{
  "data": [
    {
      distance: "5529.729842",
      latitude: "38.996237",
      longitude: "116.063653",
      poiAddress: "温白快速路保靖线交叉口路东",
      poiName: "大唐铜锅涮肉",
      poiPhone: "‭+86 159 3394 9696‬"
    },
    {
      distance: "5551.383304",
      latitude: "39.002655",
      longitude: "116.063995",
      poiAddress: "东槐村温白快速路东槐道口88号",
      poiName: "清香斋饭店",
      poiPhone: "‭+86 156 0325 8828‬"
    }
  ],
  "error": 0
}

# 错误码

错误码 描述
1 缺少必传参数

# 兼容性

端类型 最低版本 描述
T-App 不支持
E-App 9.67.0
H5 不支持
微信Web 不支持
微信小程序 不支持
手Q 不支持

示例

更新时间: 11/26/2020, 8:08:04 PM