API测试>>

酒店

国内酒店-关键字补全更新时间:2018/11/27 11:41

方法名称

hotel.keyword

使用说明

本接口用于获取与用户输入关键字匹配的关键字列表,关键字可以是除了城市以外的任何信息(比如车站、医院、学校等)。

使用本接口可以不再使用GEO静态数据,本接口数据和功能比GEO数据完善许多。

本接口适于和hotel.list接口结合使用,获取的关键字信息中的关键字名称(Name字段)可以作为hotel.list接口的QueryText参数。

本接口与目的地接口(hotel.destination)功能类似,相较于目的地接口,本接口一般不用于获取城市信息,而只用于确定城市后,搜索该城市下的关键字。

具体用法可以参考艺龙官网的关键字输入框逻辑。

输入参数

节点名称类型可为空说明
CityId城市IDString(4)N城市ID,可以从hotel.destination接口或者GEO静态数据中获取。
QueryText关键字String(50)N用户输入的关键字
IsSameCity是否同一城市BooleanN

传入的经纬度坐标是否在CityId指定的城市范围内。

使用场景举例:

  1. CityId传入北京的CityId,然后又传入了经纬度,经纬度指定为天安门广场的一个点,那么此时该字段传入true。这时返回的关键字将是天安门附近的一些酒店、地标等。

  2. CityId传入上海的CityId,然后又传入了表示天安门的坐标,此时该字段传入false。这时返回的关键字将是上海全城的酒店、地标等。

  3. CityId传入北京的CityId,然后不传入经纬度,那么此字段传入false。返回北京全城的酒店、地标等。

  4. CityId传入北京的CityId,然后传入了西安兵马俑的坐标,根据2所述本字段应该传入false,但是如果传入了true,那么会返回北京市中离传入坐标比较近的一些酒店、地标等。

注意:为true时Longitude、Latitude不可为空

Longitude经度DecimalYIsSameCity为true时不可为空,百度坐标系
Latitude纬度DecimalYIsSameCity为true时不可为空,百度坐标系
DeviceId用户设备IDStringY用户设备的唯一识别号,可以是mac地址,手机也可以是IMEI,一般不需要传入
OSType用户系统类型StringY可传入Android、IOS、PC、Other中的任意一个
IsNeedMoreType
是否返回更多类型BooleanY

是否获取更多类型,默认为false。

更多类型包括医院、学校、景点、地铁站、机场/车站

IsNeedBrandGroup是否返回酒店集团BooleanY是否获取酒店集团、品牌,默认为false。

响应结果

节点名称类型可为空说明
KeywordResult目的地结果列表KeywordResult[]N包含多个KeywordResult节点


KeywordResult节点

节点名称类型可为空说明
Name关键字名称StringN
Lng经度StringN百度坐标系

Lat

纬度StringN
Type关键字类型StringN

关键字的类型

0-酒店

3-品牌

4-行政区

5-商圈

6-POI(大学、周边游[风景区]、汽车站、火车站、地铁等),如果艺龙没有进行分类,那么就属于此项

8-医院

9-学校

10-景点

11-地铁站

12-机场/车站

13-集团

14-景区

16-设施

17-床型

18-主题

19-星级

GroupName集团名称StringY仅当Type为13时有值
SugActInfosug标记信息StringN

本条关键字的唯一标识,一般不需要关注

PropertiesId关键字特征IDStringN本条关键字的唯一标识,一般不需要关注
SearchName搜索页关键字展示名称StringY

搜索页的关键字展示名称,一般是空的,建议使用Name字段

ListName列表页关键字展示名称IntN

列表页的关键字展示名称,一般是空的,建议使用Name字段

IsKeywordFilter是否包含筛选项BooleanN即这个关键字是否更为细致的筛选项,比如朝阳区这个关键字会有酒店品牌、产品类型、是否含早等筛选项,可以通过hotel.filter接口获取。
FilterType筛选项类型IntN

在IsKeywordFilter为true时有效,作为hotel.filter接口入参。

IsKeywordFilter为false时,本字段为-1

FilterId筛选项IDIntN一般不需要关注,仅用于筛选项标识
StarInfo酒店星级IntN仅在关键字类型为酒店时使用,其他类型本字段均为0
Score酒店点评分StringY

满分5分,仅当关键字类型是酒店时有效,其他类型返回为空

MallName酒店所属商圈String
Y
仅当关键字类型为酒店时且艺龙维护了该酒店商圈后才会返回
HotelId酒店IDStringY仅当关键字类型为酒店时有效,其他时候返回为空
Addresspoi地址信息StringY仅当关键字类型为POI时有效,其他时候返回为空
Distance酒店距离用户的距离StringY仅当传入坐标且关键字类型为酒店时有效

输入参数示例

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"
}

注意事项

本接口返回信息较多,请根据实际情况使用,不要为了使用某个字段而去开发功能。