# 查询小程序用户隐私保护指引

  • 本接口用于查询第三方代开发小程序的用户隐私保护指引,也可以用来查询有哪些privacy_key可以进行配置

  • 使用过程中如遇到问题,可在开放平台服务商专区发帖交流。

# 请求地址

POST https://api.weixin.qq.com/cgi-bin/component/getprivacysetting?access_token=ACCESS_TOKEN

# 请求参数说明

参数 类型 必填 说明
access_token string 第三方平台接口调用令牌authorizer_access_token
privacy_ver int 1表示现网版本,即,传1则该接口返回的内容是现网版本的;2表示开发版,即,传2则该接口返回的内容是开发版本的。默认是2。

说明:

1、开发版指的是通过setprivacysetting接口已经配置的用户隐私保护指引内容,但是还没发布到现网,还没正式生效的版本。

2、现网版本指的是已经在小程序现网版本已经生效的用户隐私保护指引内容。

请求示例:

  • 如果不传privacy_ver,要传个空的json,否则会报错
{
    "privacy_ver":2
}

# 返回参数说明

参数 类型 说明
errcode Number 返回码
errmsg String 错误信息
code_exist int 代码是否存在, 0 不存在, 1 存在 。如果最近没有通过commit接口上传代码,则会出现 code_exist=0的情况。
privacy_list array 代码检测出来的用户信息类型(privacy_key)
setting_list array object 要收集的用户信息配置
update_time timestamp 更新时间
owner_setting object 收集方(开发者)信息配置
privacy_desc array object 用户信息类型对应的中英文描述

# setting_list结构体

参数 类型 说明
privacy_key String 用户信息类型的英文名称
privacy_text String 该用户信息类型的用途
privacy_label String 用户信息类型的中文名称

# owner_setting结构体

参数 类型 说明
contact_email string 信息收集方(开发者)的邮箱
contact_phone string 信息收集方(开发者)的手机号
contact_qq String 信息收集方(开发者)的qq
contact_weixin String 信息收集方(开发者)的微信号
notice_method String 通知方式,指的是当开发者收集信息有变动时,通过该方式通知用户
store_expire_timestamp String 存储期限,指的是开发者收集用户信息存储多久
ext_file_media_id String 自定义 用户隐私保护指引文件的media_id

# privacy_desc结构体

参数 类型 说明
privacy_desc_list array object 用户信息类型

# privacy_desc_list结构体

参数 类型 说明
privacy_desc string 用户信息类型的中文描述
privacy_key string 用户信息类型的英文key

# sdk_privacy_info_list结构体

参数 类型 是否必填 说明
sdk_name string sdk的名称
sdk_biz_name string sdk提供方的主体名称
sdk_list array object sdk收集的信息以及用途

# sdk_list结构体

参数 类型 是否必填 说明
privacy_key string sdk收集的信息描述
privacy_text string sdk收集的信息用途说明

返回结果示例:


 {
    "errcode": 0,
    "errmsg": "ok",
    "interface_list": [
        {
            "api_name": "wx.onLocationChange",
            "api_ch_name": "监听实时地理位置变化事件",
            "api_desc": "监听实时地理位置变化事件。当用户离开小程序后,此接口无法调用。",
            "status": 1,
            "api_link": "https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.onLocationChange.html",
            "group_name": "地理位置"
        },
        {
            "api_name": "wx.chooseLocation",
            "api_ch_name": "打开地图选择位置",
            "api_desc": "打开地图选择位置。",
            "status": 1,
            "api_link": "https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.chooseLocation.html",
            "group_name": "地理位置"
        },
        {
            "api_name": "wx.chooseAddress",
            "api_ch_name": "获取用户收货地址",
            "api_desc": "调起用户编辑收货地址原生界面,并在编辑完成后返回用户选择的地址。",
            "status": 1,
            "api_link": "https://developers.weixin.qq.com/miniprogram/dev/api/open-api/address/wx.chooseAddress.html",
            "group_name": "地理位置"
        },
        {
            "api_name": "wx.choosePoi",
            "api_ch_name": "选择位置,支持模糊定位(精确到市)和精确定位混选",
            "api_desc": "选择位置,支持模糊定位和精确定位混选",
            "status": 1,
            "api_link": "https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.choosePoi.html",
            "group_name": "地理位置"
        },
        {
            "api_name": "wx.getLocation",
            "api_ch_name": "获取当前的地理位置、速度 ",
            "api_desc": "获取当前的地理位置、速度。当用户离开小程序后,此接口无法调用。 ",
            "status": 1,
            "api_link": "https://developers.weixin.qq.com/miniprogram/dev/api/location/wx.getLocation.html ",
            "group_name": "地理位置"
        }
    ]
}



# 返回码说明

返回码 errmsg 说明
0 ok 查询成功
其他错误码 请查看全局错误码