设置关联城市
收藏我的收藏
收藏功能说明
- •开发者可基于小程序整体或小程序中的指定页面，设置一个关联城市；设置生效后，挂载该小程序的短视频、直播间将更有可能推送给相同城市的抖音用户，以此来提升小程序面向目标人群的推广效果
- •本功能可在「小程序控制台-设置-关联设置-关联城市配置」中进行配置或通过OpenAPI配置，OpenAPI配置可参考本文档实现，通过页面配置请前往控制台查看。
接口说明
添加小程序关联城市
使用限制
无
接口说明
- •开发者通过该接口为【小程序整体】或【小程序某个页面】绑定关联城市。
- •小程序仅能以整体维度或页面维度绑定城市，即一个appid只能2选1。
- •每个小程序绑定的城市数量有限。对于页面维度：小程序内的某个具体页面path可配置1个城市，一个小程序最多配置10个页面的path；对于整体维度：一个小程序整体可配置1个城市。
基本信息
基本信息 | |
HTTP URL | |
HTTP Method | POST |
权限要求 | 无 |
请求头
请求参数
名称 | 类型 | 是否必填 | 描述 | 示例值 |
bind_type | int | 是 | 小程序关联城市的维度，1-整体维度，2-页面维度。仅能2选1 | 1 |
region_id | string | 是 | 小程序或小程序页面关联的城市行政编码。 | 440300 |
path | string | 条件必填 | page/path/index |
请求示例
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" }'
响应参数
err_no | int | 是 | 状态码 0 代表业务处理成功，具体错误码参见后文错误码章节 | 0 |
err_msg | string | 是 | 错误提示信息 | 成功 |
log_id | string | 是 | 日志id，排查问题时使用 | 2023010128382726 |
响应示例
正常示例
{ "err_no": 0, "data_id": "region_7276042845767827500", "err_msg": "成功", "log_id": "02169414664986000000000000000000000ffff0a706f5dd63726" }
异常示例
{ "err_msg": "当前小程序或页面已绑定该区域", "log_id": "02169414710347800000000000000000000ffff0accdb4a904f6e", "err_no": 10001, "data_id": "" }
错误码
错误码 | 错误提示 | 建议解决方案 |
10000 | 系统错误 | 请重试，若多次重试仍然报错，请联系oncall |
10001 | 参数不合法：xxx参数不合法 | 对照错误提示和接口参数定义，检查对应的参数 |
10100 | 鉴权失败，access_token非法 | 检查小程序拥有该接口的调用权限、access_token是否过期 |
删除小程序城市关联关系
使用限制
无
接口说明
- •删除小程序或小程序页面已绑定过的城市
基本信息
基本信息 | |
HTTP URL | |
HTTP Method | POST |
权限要求 | 无 |
请求头
请求参数
注意：如果小程序已经以整体维度绑定城市，path被认为是空字符串。
名称 | 类型 | 是否必填 | 描述 | 示例值 |
region_id | string | 是 | 待解除绑定的城市行政编码 | 440300 |
path | string | 否 | page/path/index |
请求示例
curl --location --request POST 'https://open.douyin.com//api/product/v1/app_region_delete/' \ --header 'Content-Type: application/json' \ --header 'access-token: clt.xxx' \ --data-raw='{ "region_id": "440300", "path": "path/test/index" }'
响应参数
err_no | int | 是 | 状态码 0 代表业务处理成功，具体错误码参见后文错误码章节 | 0 |
err_msg | string | 是 | 错误提示信息 | 成功 |
log_id | string | 是 | 日志id，排查问题时使用 | 2023010128382726 |
响应示例
正常示例
{ "err_no": 0, "err_msg": "成功", "log_id": "02169414840172000000000000000000000ffff0a706aa96275e0" }
异常示例
{ "err_no": 10001, "err_msg": "待删除的数据不存在", "log_id": "02169414844919700000000000000000000ffff0a706aa94966f0" }
错误码
错误码 | 错误提示 | 建议解决方案 |
10000 | 系统错误 | 请重试，若多次重试仍然报错，请联系oncall |
10001 | 参数不合法：xxx参数不合法 | 对照错误提示和接口参数定义，检查对应的参数 |
10100 | 鉴权失败，access_token非法 | 检查小程序拥有该接口的调用权限、access_token是否过期 |
修改小程序城市关联关系
使用限制
无
接口说明
- •修改小程序或小程序页面已绑定过的城市
- •每个绑定城市的小程序或小程序页面，每7天可以执行一次修改（删除也算一次修改）。
基本信息
基本信息 | |
HTTP URL | |
HTTP Method | POST |
权限要求 | 无 |
请求头
请求参数
注意：如果小程序已经以整体维度绑定城市，path被认为是空字符串。
名称 | 类型 | 是否必填 | 描述 | 示例 |
origin_region | string | 是 | 待修改小程序或小程序页面已绑定过的区域 | 440300 |
current_region | string | 是 | 小程序或小程序页面的新绑定区域 | 440400 |
path | string | 否 | page/path/index |
请求示例
curl --location --request POST 'https://open.douyin.com/api/product/v1/app_region_modify/' \ --header 'Content-Type: application/json' \ --header 'access-token: clt.xxx' \ --data-raw='{ "origin_region": "440300", "current_region": "440400, "path": "page/path/index" }'
响应参数
名称 | 类型 | 是否必填 | 描述 | 示例 |
err_no | int | 是 | 错误 码 | 0 |
err_msg | string | 是 | 错误提示 | 成功 |
log_id | string | 是 | 日志id，排查问题时使用 | 2023010128382726 |
响应示例
正常示例
{ "err_no": 0, "err_msg": "成功", "log_id": "02169415096581000000000000000000000ffff0accdb4a97bc9a" }
异常示例
{ "err_no": 10101, "err_msg": "修改区域的频率过高", "log_id": "02169415108248100000000000000000000ffff0a70975562da56" }
错误码
错误码 | 错误提示 | 建议解决方案 |
10000 | 系统错误 | 请重试，若多次重试仍然报错，请联系oncall |
10100 | 鉴权失败，access_token非法 | 检查小程序拥有该接口的调用权限、access_token是否过期 |
10101 | 修改区域的频率过高 | 区域修改的频率有限制，请按规定修改。如按照规定修改仍报错，联系oncall。 |
附、关于城市行政编码
