目录

参数说明

Address

参数

是否必选

类型

说明

countryCode

否

String

国家码。

country

否

String

国家名。

state

否

String

省/州。

county

否

String

县/市。

town

否

String

镇/区。

settlement

否

String

定居点。

AddressDetail

参数

是否必选

类型

说明

countryCode

否

String

国家码,采用ISO 3166-1 alpha-2。

country

否

String

国家名。

adminArea

否

String

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

subAdminArea

否

String

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

locality

否

String

城市。

subLocality

否

String

国家下面的四级行政区,一般是镇。

streetNumber

否

String

街道号。

thoroughfare

否

String

街道名。

postalCode

否

String

邮政编码。

AutocompletePrediction

参数

是否必选

类型

说明

description

是

String

预测的描述。

matchedKeywords

是

Array<Word>

输入的关键字在description里的匹配位置。

matchedWords

是

Array<Word>

description包含的单词,以及位置。

Coordinate

参数

是否必选

类型

说明

lat

是

Number

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

lng

是

Number

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

CoordinateBounds

参数

是否必选

类型

说明

northeast

是

Coordinate

东北角的位置。

southwest

是

Coordinate

西南角的位置。

FitViewOptions

参数

是否必选

类型

说明

padding

否

Array<Number>

四周边距,顺序是上下左右。

maxZoom

否

Number

地图最大缩放级别,取值范围:[2, 20]。

GroundOverlayLatLngBounds

参数

是否必选

类型

说明

east

是

Number

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

west

是

Number

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

north

是

Number

东北角纬度,取值范围:[-90, 90]。

south

是

Number

西南角纬度,取值范围:[-90, 90]。

LatLng

参数

是否必选

类型

说明

lat

是

Number

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

lng

是

Number

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

LatLngBounds

参数

是否必选

类型

说明

ne

是

Coordinate

东北角的位置。

sw

是

Coordinate

西南角的位置。

NaviLineCodes

参数

是否必选

类型

说明

codes

否

Array<Object>

每段路的路牌内容和雪碧图。如果没有设置,不显示路牌。

例如:[{code: 'code2',codeSprite: '110033'}, …...],为indexes的长度1/2。

indexes

否

Array

每段路的点的下标索引。如果没有设置,不显示路牌。

例如:[0, 50,120,180]

Indexes的长度为偶数,每两个一对。

NaviLineFillColors

参数

是否必选

类型

说明

colors

否

Array

每段路的颜色。如果没有设置,使用默认颜色显示。

例如:['#ff0000', 'rgb(255, 0, 0)', ……]

长度为indexes的长度的1/2。

indexes

否

Array

每段路的点的下标索引。

例如:[0, 50, 120, 180, …...]

Indexes的长度为偶数,每两个一对。

NaviLineTexts

参数

是否必选

类型

说明

texts

否

Array<Object>

每段路的路名。如果没有设置,不显示路名。

例如:[{name: '长安街', name_da: 'changanjie'}, …...],第一个name是本地语的路名,第二个name_xx是设置语言的路名,属性名规则是name_{设置语言码}。

数组长度是indexes1/2。

indexes

否

Array

每段路的点的下标索引。如果没有设置,不显示路名。

例如:[0, 50, 120, 180, …...]

Indexes的长度为偶数,每两个一对。

OpeningHours

参数

是否必选

类型

说明

texts

是

Array<String>

每个星期的开放时间段的描述。

periods

是

Array<Period>

开放时间段的详细说明。

Path

参数

是否必选

类型

说明

steps

是

Array<Step>

路线分段信息。

distance

否

Number

行驶距离,单位:米。

duration

否

Number

行驶时长,单位:秒。

distanceText

否

String

Distance的文本描述。

durationInTraffic

否

Number

基于实时路况计算出来的行驶时长,单位:秒。

durationText

否

String

Duration的文本描述。

startLocation

是

Coordinate

出发地的经纬度。

startAddress

否

String

startLocation对应的地址详情。

endLocation

是

Coordinate

目的地的经纬度。

endAddress

否

String

endLocation对应的地址详情。

Period

参数

是否必选

类型

说明

open

是

TimeOfWeek

开放时间。

close

否

TimeOfWeek

关闭时间。

Poi

参数

是否必选

类型

说明

poiTypes

是

Array<String>

POI类型。

hwPoiTypes

是

Array<String>

华为POI分类体系。

说明:

推荐使用hwPoiTypes。

phone

否

String

电话号码。

internationalPhone

否

String

国际电话号码。

rating

否

Number

评分。

websiteUrl

否

String

网址。

openingHours

否

OpeningHours

营业时间。

photoUrls

否

Array<String>

图片地址。

priceLevel

否

Number

价格等级,取值范围:[0, 4]。

说明:

仅地址详情接口返回。

businessStatus

否

String

营业状态,其中包括:

  • OPEN_NOW:正在营业。
  • CLOSE_NOW:已休息。
  • CLOSED_TEMPORARILY:临时关闭。
  • CLOSED_PERMANENTLY:永久关闭。
说明:

仅地址详情接口返回。

icon

否

String

POI类型图标。

QuantityUrls

参数

是否必选

类型

说明

num

是

Number

标记聚合数量。

url

是

String

图标地址,可以是图片的URL路径或文件路径。默认有内置图片。

Route

参数

是否必选

类型

说明

取值

paths

是

Array<Path>

路线规划信息。

-

optimizedWaypoints

否

Array<Number>

当viaType=false且optimize=true时才会有结果,表示进行路径优化之后途径点的索引。

-

bounds

否

CoordinateBounds

路线边界范围。

-

hasRestrictedRoad

否

Number

此路段是否包含私家/限制用途。

取值包括:

  • 0:没有
  • 1:有

dstInRestrictedArea

否

Number

终点是否在限制区域,进入前请确认。

crossCountry

否

Number

是否穿越国境线(出发前请确认COVID-19边境限制)。

crossMultiCountries

否

Number

是否穿越(多条)国境线。

hasRoughRoad

否

Number

此路段是否经过崎岖道路。

dstInDiffTimeZone

否

Number

目的地是否在不同时区。

hasFerry

否

Number

是否途径轮渡。

hasTrafficLight

否

Number

是否含红绿灯。

hasTolls

否

Number

此路段是否含收费站。

trafficLightNum

否

Number

红绿灯个数。

-

overviewPolyline

否

String

该路线的编码后的折线。

-

Site

参数

是否必选

类型

说明

siteId

是

String

地点的唯一主键。

name

否

String

地点名称。

formatAddress

是

String

格式化的地点详细地址。

address

是

AddressDetail

地址详细信息。

location

否

Coordinate

地点的经纬度。

viewport

否

CoordinateBounds

地点的视口范围。

说明:

输入提示不支持返回此字段。

distance

否

Number

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

说明:

目前仅关键字搜索、周边搜索和地点搜索建议接口支持返回此字段。

poi

否

Poi

如果地点是POI,返回POI信息。

utcOffset

否

Number

位置所在时区和UTC时区的差值,单位:分钟。

说明:

仅地点详情接口返回。

prediction

否

AutocompletePrediction

地点搜索建议和自动补全接口,返回自动填充的描述信息。

Step

参数

是否必选

类型

说明

distance

否

Number

行驶距离,单位:米。

distanceText

否

String

Distance的文本描述。

durationInTraffic

否

Number

基于实时路况计算出来的行驶时长,单位:秒。

durationText

否

String

Duration的文本描述。

startLocation

否

Coordinate

出发地的经纬度。

startAddress

否

String

startLocation对应的地址详情。

endLocation

否

Coordinate

目的地的经纬度。

endAddress

否

String

endLocation对应的地址详情。

action

否

String

当前步骤要执行的操作,取值包括:

  • TURN_SLIGHT_LEFT
  • TURN_SHARP_LEFT
  • UTURN_LEFT
  • TURN_LEFT
  • TURN_SLIGHT_RIGHT
  • TURN_SHARP_RIGHT
  • UTURN_RIGHT
  • TURN_RIGHT
  • STRAIGHT
  • RAMP_LEFT
  • RAMP_RIGHT
  • MERGE
  • FORK_LEFT
  • FORK_RIGHT
  • FERRY(暂不支持)
  • FERRY_TRAIN(暂不支持)
  • ROUNDABOUT_LEFT
  • ROUNDABOUT_RIGHT

polyline

否

Array<Coordinate>

此路段的一系列坐标点(包含起点和终点坐标)。

roadName

否

String

路名。

orientation

否

Number

道路方向。取值包括:

  • 0:双向
  • 1:正向
  • 2:反向

instruction

否

String

文字指引。

TimeOfWeek

参数

是否必选

类型

说明

week

是

Number

  • 0:星期日
  • 1:星期一
  • 2:星期二
  • 3:星期三
  • 4:星期四
  • 5:星期五
  • 6:星期六

time

是

String

24小时制时间,hhmm格式。

Word

参数

是否必选

类型

说明

offset

是

Number

单词在description里的偏移位。

value

是

Number

单词。