[P055]检索式创建专利导出任务
通过标准的PATSNAP检索式查询搜索我们的全球专利数据库,创建批量获取结果数据的任务ID。 要了解更多关于PatSnap搜索语法的信息,请参阅https://analytics.zhihuiya.com/search_helper。导出服务允许选择要导出的字段,从而提高响应率,允许导出的字段和字段分级(不同分级字段的调用费用不同),详见导出说明。
1、对于 full_text 导出类型,只支持以下四个字段:PN, ABST, CLMS, DESC;字段 DESC 只在 full_text 导出类型中受支持; 字段 CLMS只在 full_text 、pdf导出类型中受支持;full_text 导出类型的结果是一个 ZIP 文件,里面的文件是以 PN 号命名的 xml 文件。
2、结果的大小最大是10万个最相关的专利。
3、本接口根据实际导出的专利量进行扣费,请注意limit参数的设置。
请求参数
此 API 接口支持的参数列表
| 名称 | 类型 | 示例 | 描述 |
|---|---|---|---|
| string | PBD | 选择专利去重的排序字段,如:APD按申请日排序、PBD按公开日排序、AUTHORITY按受理局排序,以及SCORE按照查询相关性排序 |
| string | LATEST | 选择专利去重的排序顺序,如果collapse_type等于APNO,collapse_by等于APD或PBD,collapse_order的有效值应该为OLDEST或LATEST |
| array | [
"CN",
"US",
"EP",
"JP",
"KR"
] | 按照受理局进行排序去重,按照输入的受理局优先级保留对应专利 |
| string | DOCDB | 选择专利去重条件,如:ALL不去重、APNO按申请号去重、DOCDB按简单同族去重、INPADOC按inpadoc同族去重,以及EXTEND按patsnap同族去重,空值默认为ALL |
必填 | string | TTL:car | 专利搜索查询,详细的语法参考可以在这里找到 https://analytics.patsnap.com/search_helper |
必填 | string | PN,APNO | 允许导出的字段。详见导出说明。多个导出字段之间用英文,分隔开。 |
必填 | string | csv | 允许导出的文件格式。可以选择json、csv、xls、pdf、full_text、xml。只能选择1个。 对于 full_text 导出类型,只支持以下四个字段:PN, ABST, CLMS, DESC;字段 DESC 只在 full_text 导出类型中受支持; 字段 CLMS只在 full_text 、pdf导出类型中受支持;full_text 导出类型的结果是一个 ZIP 文件,里面的文件是以 PN 号命名的 xml 文件。 |
必填 | integer<int32> | 100 | 单次最大导出量,rows >= 1 , (csv/xls/json/xml: 100k ; pdf/full_text: 1k) |
| string | 20110101 | 申请日起始时间. 格式: 'yyyyMMdd';或*,表示日期不受限制 |
| string | 20180619 | 申请日结束时间. 格式: 'yyyyMMdd';或*,表示日期不受限制 |
| string | 20110101 | 公开日起始时间. 格式: 'yyyyMMdd';或*,表示日期不受限制 |
| string | 20180619 | 公开日结束时间. 格式: 'yyyyMMdd';或*,表示日期不受限制 |
| string | en | 原文可选择的语言,默认值为中文。可选项包括cn、en、jp、de、fr、kr,分别为中文、英文、日文、德语、法语和韩文,请使用小写字母。 |
| string | en | 翻译可选择的语言,默认值为中文。可多选,可选项包括cn、en、jp,分别为中文、英文、日文,请使用小写字母。 |
| integer<int32> | - | 偏移量,0 <= rows + offset <= 100000,默认为0
如需要获取排名在100名之后的专利,可以设置offset=100 |
| integer<int32> | - | 是否开启截词功能,1:开启;0:关闭。默认关闭 注:开启截词,在保留原词的同时,并扩展其对应的单复数及时态,例如搜索 "come",会扩展为 "come", "comes", "came", "coming" 等等; 关闭截词,只搜索检索式中关键词本身; 在搜索语句中使用通配符,会影响截词在含通配符的关键词中生效; 截词仅作用于英文关键词,且在申请人、发明人等涉及人名的字段中不起作用。 |
响应结构
API 响应数据的结构说明
| 字段名 | 类型 | 示例 | 描述 |
|---|---|---|---|
data | object | - | 响应数据 |
count | integer<int32> | 24 | 导出专利数 |
task_id | string | b4bdae6b4a65432d91f25b5c52bdfd80 | 导出任务ID,ID有效期为24小时 |
status必填 | boolean | false | 状态 |
error_msg | string | The request parameter format is incorrect! | 错误信息 |
error_code必填 | integer | 0 | 错误代码 |
成功响应示例
成功调用 API 的响应示例
{
"data": {
"count": 24,
"task_id": "b4bdae6b4a65432d91f25b5c52bdfd80"
},
"status": true,
"error_code": 0
}错误码
此接口可能返回的错误码列表
业务错误码
| 错误码 | 描述 |
|---|---|
68300004 | 请求参数异常! |
68300005 | 查询Api失败! |
68300006 | 解析基本存取错误! |
68300007 | 存在错误的请求! |
68300008 | 服务中断异常,请稍后再试! |
68300010 | 文件不符合上传规范! |
平台错误码
| 错误码 | 描述 |
|---|---|
67200001 | API整体限流错误! |
67200002 | 用户调用请求限流限制错误! |
67200003 | 申请token的key和secret不正确或者状态错误! |
67200004 | 无权限或该接口的套餐已超过系统设置的上限! |
67200005 | 账户余额不足,调用失败! |
67200006 | 客户端已过期,调用失败! |
67200007 | 超过调用额度,调用失败! |
HTTP 状态码
| 状态码 | 描述 |
|---|---|
0 | 请求成功 |
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
性能指标
此接口的预期性能特征
正常响应时间
5000 ms
最大响应时间
10000 ms