创建抖音搜索直达子服务
收藏
我的收藏接口说明
抖音端的「搜索」是小程序获取流量的最大入口之一,但用户在搜索相关小程序的过程中,不一定是按照小程序名称进行检索,而是按小程序相关功能的关键字进行检索。本 openApi 通过创建子服务的方式,提供小程序相应功能可在抖音被直接搜索的能力,并支持直接跳转到对应的功能页。
- 业务场景:当开发者需要让自己的小程序以功能检索的方式被搜索到时,可调用此openApi开通相关能力。
- 注意事项:当前该openApi仅支持内部小程序进行调用,后期会按照行业进行开放。
使用限制
目前该能力还处于内部试运营阶段,仅支持内部的相关小程序调用,后期会按特定行业开放, 提供给外部开发者使用。
基本信息
名称 | 描述 |
---|---|
HTTP URL | https://open.douyin.com/api/apps/v1/capacity/create_ma_sub_service/ |
HTTP Method | POST |
Scope | ma.search.direct |
权限要求 | 服务商代调用场景下,需商家授予运营管理权限集 |
请求参数
请求头
access-token必填String
当非服务商时,调用https://developer.toutiao.com/api/apps/v2/token生成的token
当服务商时,调用https://open.microapp.bytedance.com/openapi/v1/oauth/token生成的token
当服务商时,调用https://open.microapp.bytedance.com/openapi/v1/oauth/token生成的token
content-type必填String
示例:application/json
固定值"application/json"
Body展开全部子属性
search_key_word必填List
该子服务可用于检索的关键词,例如您打算创建一个宝宝起名服务,而用户可能会通过搜索「起名」,「宝宝起名」等字眼来找到对应的小程序功能,您就可以将关键词设置为「起名」,「宝宝起名」等字眼,方便用户更容易直接搜索到您的小程序功能(关键词的个数为2~6个)(每个关键词的长度为2-20)
展开子属性
start_page_url必填String
对应功能服务页面的路径链接,若用户搜索到了您的小程序相应的功能服务,点击进入该服务,会跳转到您所传入的链接对应的页面中
sub_service_name必填String
搜索直达子服务的名称,例如有一个名为宝宝生成器的小程序,其中有一个功能是给宝宝起名字,那么此搜索直达子服务的名称就可以命名为「宝宝起名服务」(服务名称的长度为2-20)
请求示例
curl --location --request POST 'https://open.douyin.com/api/apps/v1/capacity/create_ma_sub_service/' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \ --data '{"TpAppId":"xicOb21aRE","sub_service_name":"我的子服务","search_key_word":["key1"],"start_page_url":"http://xxx.com"}'
响应参数
Body
err_msg必填String
示例:小程序信用分小于90分,无法提交
错误信息
err_no必填Int32
示例:28001007
错误码
log_id必填String
示例:202311231517488305C037A785Dxxxxx
log_id,用于向内部开发人员进行反馈
响应示例
正常响应示例异常响应示例
{ "err_msg": "", "err_no": 0, "log_id": "202311231517488305C037A785Dxxxxx" }
切换单列布局
错误码
HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
---|---|---|---|
200 | 28001003 | access_token无效 | 检查access_token合法性 |
200 | 28001006 | 网络调用错误 | 建议重试 |
200 | 28001008 | access_token过期 | 刷新或重新授权 |
200 | 28001018 | 应用未获得该能力 | 引导商家授予相关权限集 |
200 | 29003024 | 请求参数不合法 | 检查参数合法性 |
200 | 28001005 | 系统内部错误,请重试 | 建议重试 |
点击纠错