# 获取小程序用户隐私保护指引
接口应在服务器端调用，详细说明参见服务端API。
# 接口说明
# 接口英文名
getPrivacySetting
# 功能描述
本接口用于查询第三方代开发小程序的用户隐私保护指引，也可以用来查询有哪些privacy_key可以进行配置
使用过程中如遇到问题，可在开放平台服务商专区发帖交流。
# 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/cgi-bin/component/getprivacysetting?access_token=ACCESS_TOKEN
# 第三方调用
调用方式以及出入参和HTTPS相同，仅是调用的token不同
该接口所属的权限集id为：18
服务商获得其中之一权限集授权后，可通过使用authorizer_access_token代商家进行调用
# 请求参数
| 属性 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token | string | 是 | 接口调用凭证，该参数为 URL 参数，非 Body 参数。使用authorizer_access_token |
| privacy_ver | number | 是 | 1表示现网版本，即，传1则该接口返回的内容是现网版本的；2表示开发版，即，传2则该接口返回的内容是开发版本的。默认是2。 |
# 返回参数
| 属性 | 类型 | 说明 | |||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| errcode | number | 返回码 | |||||||||||||||||||||||||||||||||||||
| errmsg | string | 错误信息 | |||||||||||||||||||||||||||||||||||||
| code_exist | number | 代码是否存在， 0 不存在， 1 存在 。如果最近没有通过commit接口上传代码，则会出现 code_exist=0的情况。 | |||||||||||||||||||||||||||||||||||||
| privacy_list | array<string> | 代码检测出来的用户信息类型（privacy_key） | |||||||||||||||||||||||||||||||||||||
| setting_list | array<object> | 要收集的用户信息配置 | |||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
| update_time | number | 更新时间 | |||||||||||||||||||||||||||||||||||||
| owner_setting | object | 收集方（开发者）信息配置 | |||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
| privacy_desc | object | 用户信息类型对应的中英文描述 | |||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
| sdk_privacy_info_list | array<object> | 该小程序中引用了第三方sdk的信息说明 | |||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
# 其他说明
1、开发版指的是通过setprivacysetting接口已经配置的用户隐私保护指引内容，但是还没发布到现网，还没正式生效的版本。
2、现网版本指的是已经在小程序现网版本已经生效的用户隐私保护指引内容。
3、如果不传privacy_ver，要传个空的json，否则会报错
# 调用示例
示例说明: HTTPS请求
# 请求数据示例
{
"privacy_ver":2
}
# 返回数据示例
{
"errcode": 0,
"errmsg": "ok",
"code_exist": 1,
"privacy_list": [
"UserInfo"
],
"setting_list": [
{
"privacy_key": "EXIDNumber",
"privacy_text": "用来登记会员信息xxx",
"privacy_label": ""
},
{
"privacy_key": "UserInfo",
"privacy_text": "用来展示你的xxxx",
"privacy_label": ""
}
],
"update_time": 1641548861,
"owner_setting": {
"contact_phone": "",
"contact_email": "melody4444@qq.com",
"contact_qq": "11111111",
"contact_weixin": "",
"store_expire_timestamp": "10000天",
"ext_file_media_id": "",
"notice_method": "弹窗222"
},
"privacy_desc": {
"privacy_desc_list": [
{
"privacy_key": "UserInfo",
"privacy_desc": "用户信息（微信昵称、头像）"
},
{
"privacy_key": "Location",
"privacy_desc": "位置信息"
},
{
"privacy_key": "Address",
"privacy_desc": "地址"
},
{
"privacy_key": "Invoice",
"privacy_desc": "发票信息"
},
{
"privacy_key": "RunData",
"privacy_desc": "微信运动数据"
},
{
"privacy_key": "Record",
"privacy_desc": "麦克风"
},
{
"privacy_key": "Album",
"privacy_desc": "选中的照片或视频信息"
},
{
"privacy_key": "Camera",
"privacy_desc": "摄像头"
},
{
"privacy_key": "PhoneNumber",
"privacy_desc": "手机号"
},
{
"privacy_key": "Contact",
"privacy_desc": "通讯录（仅写入）权限"
},
{
"privacy_key": "DeviceInfo",
"privacy_desc": "设备信息"
},
{
"privacy_key": "EXIDNumber",
"privacy_desc": "身份证号码"
},
{
"privacy_key": "EXOrderInfo",
"privacy_desc": "订单信息"
},
{
"privacy_key": "EXUserPublishContent",
"privacy_desc": "发布内容"
},
{
"privacy_key": "EXUserFollowAcct",
"privacy_desc": "所关注账号"
},
{
"privacy_key": "EXUserOpLog",
"privacy_desc": "操作日志"
},
{
"privacy_key": "AlbumWriteOnly",
"privacy_desc": "相册（仅写入）权限"
},
{
"privacy_key": "LicensePlate",
"privacy_desc": "车牌号"
},
{
"privacy_key": "BlueTooth",
"privacy_desc": "蓝牙"
},
{
"privacy_key": "CalendarWriteOnly",
"privacy_desc": "日历（仅写入）权限"
},
{
"privacy_key": "Email",
"privacy_desc": "邮箱"
},
{
"privacy_key": "MessageFile",
"privacy_desc": "选中的文件"
},
{
"privacy_key": "ChooseLocation",
"privacy_desc": "选择的位置信息"
},
{
"privacy_key": "Accelerometer",
"privacy_desc": "加速传感器"
},
{
"privacy_key": "Compass",
"privacy_desc": "磁场传感器"
},
{
"privacy_key": "DeviceMotion",
"privacy_desc": "方向传感器"
},
{
"privacy_key": "Gyroscope",
"privacy_desc": "陀螺仪传感器"
},
{
"privacy_key": "Clipboard",
"privacy_desc": "剪切板"
}
]
},
"sdk_privacy_info_list": [
{
"sdk_name": "测试sdk",
"sdk_biz_name": "小麦有限公司",
"sdk_list": [
{
"privacy_key": "自定义",
"privacy_text": "用来展示你的美貌",
"privacy_label": "头像信息"
}
]
}
]
}
# 错误码
| 错误码 | 错误码取值 | 解决方案 |
|---|---|---|
| 0 | ok | ok |