方法名称
hotel.keyword
使用说明
本接口用于获取与用户输入关键字匹配的关键字列表,关键字可以是除了城市以外的任何信息(比如车站、医院、学校等)。
使用本接口可以不再使用GEO静态数据,本接口数据和功能比GEO数据完善许多。
本接口适于和hotel.list接口结合使用,获取的关键字信息中的关键字名称(Name字段)可以作为hotel.list接口的QueryText参数。
本接口与目的地接口(hotel.destination)功能类似,相较于目的地接口,本接口一般不用于获取城市信息,而只用于确定城市后,搜索该城市下的关键字。
具体用法可以参考艺龙官网的关键字输入框逻辑。
输入参数
节点 | 名称 | 类型 | 可为空 | 说明 |
---|---|---|---|---|
CityId | 城市ID | String(4) | N | 城市ID,可以从hotel.destination接口或者GEO静态数据中获取。 |
QueryText | 关键字 | String(50) | N | 用户输入的关键字 |
IsSameCity | 是否同一城市 | Boolean | N | 传入的经纬度坐标是否在CityId指定的城市范围内。 使用场景举例:
注意:为true时Longitude、Latitude不可为空 |
Longitude | 经度 | Decimal | Y | IsSameCity为true时不可为空,百度坐标系 |
Latitude | 纬度 | Decimal | Y | IsSameCity为true时不可为空,百度坐标系 |
DeviceId | 用户设备ID | String | Y | 用户设备的唯一识别号,可以是mac地址,手机也可以是IMEI,一般不需要传入 |
OSType | 用户系统类型 | String | Y | 可传入Android、IOS、PC、Other中的任意一个 |
IsNeedMoreType | 是否返回更多类型 | Boolean | Y | 是否获取更多类型,默认为false。 更多类型包括医院、学校、景点、地铁站、机场/车站 |
IsNeedBrandGroup | 是否返回酒店集团 | Boolean | Y | 是否获取酒店集团、品牌,默认为false。 |
响应结果
节点 | 名称 | 类型 | 可为空 | 说明 |
---|---|---|---|---|
KeywordResult | 目的地结果列表 | KeywordResult[] | N | 包含多个KeywordResult节点 |
KeywordResult节点
节点 | 名称 | 类型 | 可为空 | 说明 |
---|---|---|---|---|
Name | 关键字名称 | String | N | |
Lng | 经度 | String | N | 百度坐标系 |
Lat | 纬度 | String | N | |
Type | 关键字类型 | String | N | 关键字的类型 0-酒店 3-品牌 4-行政区 5-商圈 6-POI(大学、周边游[风景区]、汽车站、火车站、地铁等),如果艺龙没有进行分类,那么就属于此项 8-医院 9-学校 10-景点 11-地铁站 12-机场/车站 13-集团 14-景区 16-设施 17-床型 18-主题 19-星级 |
GroupName | 集团名称 | String | Y | 仅当Type为13时有值 |
SugActInfo | sug标记信息 | String | N | 本条关键字的唯一标识,一般不需要关注 |
PropertiesId | 关键字特征ID | String | N | 本条关键字的唯一标识,一般不需要关注 |
SearchName | 搜索页关键字展示名称 | String | Y | 搜索页的关键字展示名称,一般是空的,建议使用Name字段 |
ListName | 列表页关键字展示名称 | Int | N | 列表页的关键字展示名称,一般是空的,建议使用Name字段 |
IsKeywordFilter | 是否包含筛选项 | Boolean | N | 即这个关键字是否更为细致的筛选项,比如朝阳区这个关键字会有酒店品牌、产品类型、是否含早等筛选项,可以通过hotel.filter接口获取。 |
FilterType | 筛选项类型 | Int | N | 在IsKeywordFilter为true时有效,作为hotel.filter接口入参。 IsKeywordFilter为false时,本字段为-1 |
FilterId | 筛选项ID | Int | N | 一般不需要关注,仅用于筛选项标识 |
StarInfo | 酒店星级 | Int | N | 仅在关键字类型为酒店时使用,其他类型本字段均为0 |
Score | 酒店点评分 | String | Y | 满分5分,仅当关键字类型是酒店时有效,其他类型返回为空 |
MallName | 酒店所属商圈 | String | Y | 仅当关键字类型为酒店时且艺龙维护了该酒店商圈后才会返回 |
HotelId | 酒店ID | String | Y | 仅当关键字类型为酒店时有效,其他时候返回为空 |
Address | poi地址信息 | String | Y | 仅当关键字类型为POI时有效,其他时候返回为空 |
Distance | 酒店距离用户的距离 | String | Y | 仅当传入坐标且关键字类型为酒店时有效 |
输入参数示例
https://api-test.elong.com/rest?timestamp=1490001050&format=json &method=hotel.keyword&signature=d19ce1e910def16453801405581c9d7c &user={userid}&data={"Version":"1.33","Local":"zh_CN","Request":{"QueryText":"朝阳区","CityId":"0101","IsNeedMoreType":true,"IsNeedBrandGroup":false}}
输出参数示例
{ "Code": "0", "Result": { "keywordResult": [ { "name": "朝阳区中日友好医院", "type": 6, "propertiesId": "100314290", "lat": "39.980064", "lng": "116.43241", "starInfo": 0, "isKeywordFilter": false, "filterType": -1, "filterId": 314290, "sugActInfo": "7055270352054470291|jproxy|keyword|3|0|6", "address": "北京市朝阳区樱花园东街2号" } ] }, "Guid": "d0ef843f-9638-4b24-b9c2-f5fde8fd811d" }
注意事项
本接口返回信息较多,请根据实际情况使用,不要为了使用某个字段而去开发功能。