开发者完成接入准备后，商家/服务商可根据本文指引快速集成 搜索关键词 产品，获取小程序自然流量等推广。

说明：

搜索关键词 产品仅支持自研商家/服务商通过小程序应用或第三方应用代调用（传入 app_auth_token）代调用，调用 API 接入。

搜索关键词 产品暂不支持支持沙箱调试。

商家/服务商可根据业务需求选择申请搜索关键词、服务关键词。

申请搜索关键词

商家设置精准描述小程序的关键词，用户搜索关键词或其相关词时，搜索结果页将有机会出现相关的小程序，帮助小程序轻松获取搜索自然流量。搜索关键词配置得越准、越多、越符合用户搜索习惯，小程序曝光可能性越大。以下为接口调用流程图，商家/服务商可按如下指引调用接口，完成小程序关键词的配置。

查询小程序剩余可配置关键词数

商家/服务商在配置关键词之前，可以调用 alipay.open.search.appkeywordquota.query（查询小程序可配置关键词数）查询小程序可配置关键词剩余额度，若无额度，提报关键词会失败。

批量提报搜索关键词

商家/服务商可调用 alipay.open.search.appkeyword.apply（提报搜索关键词）进行关键词批量提报，获取审核工单 id（apply_no）。

说明：

提报之前，建议先做关键词可配置数量查询，防止提报关键词超出可配置数量，导致创建失败；

可提报关键词数量可以通过查询小程序剩余可配置关键词数步骤获取。

查询小程序服务关键词的审核工单的状态

商家/服务商可调用 alipay.open.search.appkeyword.querystatus（查询小程序搜索关键词的审核工单的状态）进行关键词审核进度查询。

说明：

审核工单（apply_no）可以通过批量提报搜索关键词步骤的提报搜索关键词接口获取

每个关键词都有唯一的配置 ID（config_id）进行标识, 如果一个工单提报了多个关键词，则返回多个 config_id。

修改搜索关键词

商家/服务商可调用 alipay.open.search.appkeyword.apply（提报搜索关键词）进行单个关键词修改，并返回最新的审核工单 id（apply_no）。

说明：修改时，每次仅能修改一个关键词，配置 ID（config_id）为必传字段。

删除搜索关键词

商家/服务商可调用 alipay.open.search.appkeyword.delete（删除搜索关键词）进行单个关键词配置信息删除。

分页查询小程序关键词配置列表

商家/服务商可调用 alipay.open.search.appkeyword.batchquery（查询小程序已配置关键词）进行关键词配置记录查询。

申请服务关键词（服务推广）

商家设置精准描述小程序服务的关键词，用户搜索关键词或其相关词时，搜索结果页将有机会出现小程序服务，用户可点击服务直接进入小程序的服务功能页，帮助小程序轻松获取搜索自然流量。服务关键词配置得越准、越多、越符合用户搜索习惯，小程序服务曝光可能性越大。以下为接口调用流程图，商家/服务商可按如下指引调用接口，完成服务推广的配置。

批量提报服务关键词

商家/服务商可调用 alipay.open.search.subservicekeyword.apply（提报服务关键词）进行关键词批量提报，获取审核工单 id（apply_no）。

说明：sub_service_code（子服务 code）为 服务提报 alipay.open.app.service.apply（服务提报申请接口）获取的 service_code（服务 id）。

查询服务关键词的审核工单的状态

商家/服务商可调用 alipay.open.search.subservicekeyword.querystatus（查询小程序服务关键词的审核工单的状态）进行服务关键词审核进度查询。

说明：

审核工单（apply_no）可以通过批量提报服务关键词步骤获取。

每个关键词都有唯一的配置ID（config_id）进行标识, 如果一个工单提报了多个关键词，则返回多个 config_id。

修改服务关键词

商家/服务商可调用 alipay.open.search.subservicekeyword.apply（提报服务关键词）进行单个关键词修改，并返回最新的审核工单 id（apply_no）。

说明：修改时，每次仅能修改一个关键词，配置 ID（config_id）为必传字段。

删除服务关键词

商家/服务商可调用 alipay.open.search.subservicekeyword.delete（删除服务关键词）进行单个关键词删除。

分页查询服务关键词配置列表

商家/服务商可调用 alipay.open.search.subservicekeyword.batchquery（服务关键词批量查询接口）进行关键词配置信息查询。

关键词审核进度消息通知

当提交关键词配置申请后，支付宝将在审核通过或被驳回时通过 From 蚂蚁消息服务向商家应用或第三方应用应用网关地址发送审核结果通知，同步对应操作结果。涉及审核的信息如下：

搜索关键词

服务关键词

若商家/服务商网络环境比较复杂，如：通过统一网关间连互联网，推荐使用网络兼容性更好的标准 http(s) 协议进行对接。

第一步：订阅消息

商家/服务商需根据订阅消息指引，为接入搜索关键词的 商家小程序 或 第三方应用 订阅如下消息接口。

注意：

仅完成订阅后才会收到支付宝发送的对应异步通知消息。

商家/服务商可通过消息通知中 msg_method 参数判断消息类型。

消息接口英文名	消息接口中文名	作用
alipay.open.search.keyword.changed（小程序关键词审核进度消息通知）	小程序关键词审核进度消息通知	同步搜索关键词和服务关键词的关键词审核进度。

第二步：验签

商家/服务商可使用支付宝 SDK 可根据数据验签指引，使用应用密钥信息验证异步通知消息来源是否为支付宝。

第三步：反馈消息接收结果

收到异步通知完成验签后，商家/服务商需返回 success 表示消息获取成功，支付宝就会停止发送异步通知。如果返回 fail 或其它值，表示消息获取失败，支付宝会根据投递重试策略重新发送消息到应用网关地址。

**说明：**完成异步通知验签时，如果验签成功返回 success，验签失败返回 fail，重新接收异步进行处理。

响应值	描述	是否重试
fail	消息获取失败	重试
success	消息获取成功	不重试

消息示例

ISV_GATEWAY_URL?charset=GBK&biz_content=
{
"apply_no":"20220308000000168465",
"event":"REJECT",
"reject_reason":"关键词包含违禁词"
}
&msg_method=alipay.open.search.keyword.changed&utc_timestamp=1516797622752&version=1.1&sign_type=RSA2&notify_id=d275fec564e62af6bedbcee73f3f05fi5x&app_id=2013121700999429&sign=I+Y/lvqYUEEc10EPdpntRhFIQ==

快速接入

申请搜索关键词#

查询小程序剩余可配置关键词数#

批量提报搜索关键词#

查询小程序服务关键词的审核工单的状态#

修改搜索关键词#

删除搜索关键词#

分页查询小程序关键词配置列表#

申请服务关键词（服务推广）#

批量提报服务关键词#

查询服务关键词的审核工单的状态#

修改服务关键词#

删除服务关键词#

分页查询服务关键词配置列表#

关键词审核进度消息通知#

第一步：订阅消息#

第二步：验签#

第三步：反馈消息接收结果#

消息示例#