• JS API 列表
  • 基础
  • TTML
  • 网络
  • 媒体
  • 地图
  • 文件
  • 数据缓存
  • 地理位置
  • tt.getLocation
  • tt.openLocation
  • tt.chooseLocation
  • tt.startLocationUpdate
  • tt.stopLocationUpdate
  • tt.onLocationChange
  • tt.offLocationChange
  • tt.onLocationChangeError
  • tt.offLocationChangeError
  • 设备
  • 画布
  • 界面
  • 页面导航
  • 开放接口
  • 行业开放
  • 第三方平台
  • 其它
  • tt.openLocation
    收藏
    我的收藏

    基础库 1.0.0 开始支持本方法,这是一个异步方法。

    使用内置地图查看位置。

    自2024年4月23日起,该API仅针对满足服务类目条件的小程序开放申请。满足申请条件后,开发者登录控制台,在小程序应用中筛选“能力-用户数据能力-设备数据”,申请打开地理位置能力权限,详情见一次性地理位置能力开通及使用规范

    前提条件
    业务背景
    使用限制

    该 API 需要用户授权方可调用,详细信息可参考用户授权

    注意事项
    • 该 API 有一定性能消耗,请注意不要频繁调用,以防设备过热和耗电过快,小程序框架也会做相应的节流处理;
    • 输入的坐标坐标系应当为 gcj02。
    支持沙盒
    相关教程

    语法

    tt.openLocation(options)

    参数说明

    options 为 object 类型,属性如下:

    属性名类型默认值必填说明最低支持版本
    namestring
    位置名
    1.0.0
    addressstring
    地址的详细说明
    1.0.0
    scalenumber18

    缩放比例,范围 5 ~ 18

    1.0.0
    longitudenumber

    经度,范围为 -180 ~ 180,正数表示东,负数表示西

    1.0.0
    latitudenumber

    纬度,范围为 -90 ~ 90,正数表示北,负数表示南

    1.0.0
    successfunction
    接口调用成功的回调函数
    1.0.0
    failfunction
    接口调用失败的回调函数
    1.0.0
    completefunction
    接口调用结束的回调函数(调用成功、失败都会执行)
    1.0.0

    回调成功

    object 类型,属性如下:

    属性名类型说明最低支持版本
    errMsgstring
    "openLocation:ok"
    1.0.0

    回调失败

    object 类型,属性如下:

    属性名类型说明最低支持版本
    errMsgstring
    "openLocation:fail" + 详细错误信息
    1.0.0

    错误码

    errorCodeerrMsgerrorType说明最低支持版本
    114990openLocation:fail auth denyU
    用户拒绝授权小程序权限

    用户未授予小程序授权,请引导用户按需授权,详情参考 用户授权

    1.0.0
    114989openLocation:fail system auth denyU
    用户拒绝授权系统权限

    用户未授予系统权限,请引导用户按需授权

    1.0.0
    114999openLocation:fail invalid latitudeD
    入参不对

    检查经纬度入参

    1.0.0
    114983openLocation:fail platform auth denyD
    该小程序没有调用此 API 的白名单

    请查看能力对应文档,申请对应的能力白名单

    1.0.0
    114979openLocation:fail api scope is not declared in the privacy agreementD
    隐私能力不在申请的 scope 内

    检查隐私协议

    1.0.0
    114980openLocation:fail privacy permission is not authorizedU
    隐私协议未授权

    用户未授权隐私协议,请引导用户按需授权

    1.0.0

    扫码体验

    请使用字节宿主APP扫码

    代码示例