添加小程序关联城市

收藏
我的收藏

接口说明

开发者可基于小程序整体或小程序中的指定页面,设置一个关联城市;设置生效后,挂载该小程序的短视频、直播间将更有可能推送给相同城市的抖音用户,以此来提升小程序面向目标人群的推广效果, 开发者通过该接口为【小程序整体】或【小程序某个页面】绑定关联城市。 小程序仅能以整体维度或页面维度绑定城市,即一个appid只能2选1。 每个小程序绑定的城市数量有限。对于页面维度:小程序内的某个具体页面path可配置1个城市,一个小程序最多配置10个页面的path;对于整体维度:一个小程序整体可配置1个城市。

使用限制

基本信息

名称描述
HTTP URL
https://open.douyin.com/api/product/v1/app_region_add/
HTTP Method
POST
Scope
open.developer.app_region_bind
权限要求

请求参数

请求头
access-token必填String
示例:08011218462b6b4b5054626e426e50685a7554643144644449413d3d
content-type必填String
示例:application/json
固定值"application/json"
Body展开全部子属性
bind_type必填Enum
示例:1
城市绑定归属维度
展开子属性
region_id必填String
示例:440300
关联地区编码,地区可能是城市维度、可能是省维度、也可能是县区维度
pathString
示例:pages/xxx/path1
页面path,不带query参数,不可以'/'开头
请求示例
curl --location --request POST 'https://open.douyin.com//api/product/v1/app_region_add/' \ --header 'Content-Type: application/json' \ --header 'access-token: clt.xxx' \ --data-raw='{ "bind_type": 2, "region_id": "130400", "path": "page/test/index" }'

响应参数

Body
data_id必填String
示例:region_7276042845767827500
绑定数据的唯一记录id
err_msg必填String
示例:成功
错误信息
err_no必填Int32
示例:0
错误码
log_id必填String
示例:02169414664986000000000000000000000ffff0a706f5dd63726
平台交互的日志id
响应示例
正常响应示例异常响应示例
{ "err_no": 0, "data_id": "region_7276042845767827500", "err_msg": "成功", "log_id": "02169414664986000000000000000000000ffff0a706f5dd63726" }
切换单列布局

错误码

HTTP 状态码错误码错误码描述排查建议
20010000
系统错误
请重试,若多次重试仍然报错,请联系oncall
20010001
参数不合法:xxx参数不合法
对照错误提示和接口参数定义,检查对应的参数
20010100
鉴权失败,access_token非法
检查小程序拥有该接口的调用权限、access_token是否过期