目录
小程序隐私协议开发指南
一、功能介绍
二、接入流程
1. 配置《小程序用户隐私保护指引》
2. 主动查询隐私授权同步状态以及展示隐私协议
3. 被动监听隐私接口需要用户授权事件
4. 清空历史同步状态
三、其他说明
四、完整示例demo
五、常见错误说明
uniapp小程序特别指导：
封装公共方法
封装的弹窗提示组件
同意后，如何清除隐私授权，重新触发wx.getPrivacySetting回调的needAuthorization: true判断？
来自官方文档：小程序隐私协议开发指南 | 微信开放文档
文章中所有红字内容为重点！！！！！！
因为不设置隐私说明告知用户，会导致小程序审核不通过，隐私api无法调用
uniapp小程序需要阅读文章最后的 uniapp小程序特别指导：uniapp小程序特别指导：
小程序隐私协议开发指南
一、功能介绍
涉及处理用户个人信息的小程序开发者，需通过弹窗等明显方式提示用户阅读隐私政策等收集使用规则。
为规范开发者的用户个人信息处理行为，保障用户合法权益，微信要求开发者主动同步微信当前用户已阅读并同意小程序的隐私政策等收集使用规则，方可调用微信提供的隐私接口。
特别注意：
以下指南中涉及的 getPrivacySetting、onNeedPrivacyAuthorization、requirePrivacyAuthorize 等接口，目前仍处于 Beta 调试阶段，目前并未按预期返回正确的结果。开发者目前可以先阅读本指南文档和接口文档进行理解，平台将会尽快正式上线这些接口以及调试方法，上线后会在本指南文档和相关公告中进行说明。
2023.08.22更新：
以下指南中涉及的 getPrivacySetting、onNeedPrivacyAuthorization、requirePrivacyAuthorize 等接口目前可以正常接入调试。调试说明：
在 2023年9月15号之前，在 app.json 中配置 __usePrivacyCheck__: true 后，会启用隐私相关功能，如果不配置或者配置为 false 则不会启用。 在 2023年9月15号之后，不论 app.json 中是否有配置 __usePrivacyCheck__，隐私相关功能都会启用。
uniapp则在manifest.json中对应位置添加
"mp-weixin": {
"__usePrivacyCheck__": true,
接口用法可参考下方完整示例demo
二、接入流程
1. 配置《小程序用户隐私保护指引》
开发者需在「小程序管理后台」配置《小程序用户隐私保护指引》，详细指引可见：用户隐私保护指引填写说明。
需要注意的是，仅有在指引中声明所处理的用户信息，才可以调用平台提供的对应接口或组件。若未声明，对应接口或组件将直接禁用。隐私接口与对应的处理的信息关系可见：小程序用户隐私保护指引内容介绍。
配置完成后，对于每个使用小程序的用户，开发者均需要同步微信当前用户已阅读并同意小程序的隐私政策等收集使用规则后，才可以调用已声明的接口或组件。同步的开发方式见下文。
对于已经同步过的用户，后续若开发者更新了配置，对于旧版本已经有接口或组件，不需要重新同步；对于更新后产生的新的接口或组件，需要重新同步。例如，7月11日更新的版本中包含「收集你选择的位置信息」，7月12日同步用户同意状态，7月13日更新后新增了「收集你的微信运动步数」，则在未再次同步的情况下，可以调用 wx.chooseLocation 接口，无法调用 wx.getWeRunData 接口。
2. 主动查询隐私授权同步状态以及展示隐私协议
从基础库 2.32.3 开始支持
开发者可通过 wx.getPrivacySetting 接口，查询微信侧记录的用户是否有待同意的隐私政策信息。该信息可通过返回结果 res 中的 needAuthorization 字段获取。
同时，wx.getPrivacySetting 接口会返回开发者在小程序管理后台配置的《小程序用户隐私保护指引》名称信息，开发者可以调用 wx.openPrivacyContract 接口打开该页面。
如果存在有待用户同意的隐私政策信息，开发者需要主动提示用户阅读隐私政策等收集使用规则，对于提示方式，小程序开发者可自行设计，同时需要在相关界面中使用
代码示例
<view wx:if="{{showPrivacy}}">
<view>隐私弹窗内容....view>
<button bindtap="handleOpenPrivacyContract">查看隐私协议button>
<button id="agree-btn" open-type="agreePrivacyAuthorization" bindagreeprivacyauthorization="handleAgreePrivacyAuthorization">同意button>
view>
// page.js
Page({
data: {
showPrivacy: false
},
onLoad() {
wx.getPrivacySetting({
success: res => {
console.log(res) // 返回结果为: res = { needAuthorization: true/false, privacyContractName: '《xxx隐私保护指引》' }
if (res.needAuthorization) {
// 需要弹出隐私协议
this.setData({
showPrivacy: true
})
} else {
// 用户已经同意过隐私协议，所以不需要再弹出隐私协议，也能调用已声明过的隐私接口
// wx.getUserProfile()
// wx.chooseMedia()
// wx.getClipboardData()
// wx.startRecord()
}
},
fail: () => {},
complete: () => {}
})
},
handleAgreePrivacyAuthorization() {
// 用户同意隐私协议事件回调
// 用户点击了同意，之后所有已声明过的隐私接口和组件都可以调用了
// wx.getUserProfile()
// wx.chooseMedia()
// wx.getClipboardData()
// wx.startRecord()
},
handleOpenPrivacyContract() {
// 打开隐私协议页面
wx.openPrivacyContract({
success: () => {}, // 打开成功
fail: () => {}, // 打开失败
complete: () => {}
})
}
})
从基础库 2.32.3 版本起，隐私同意按钮支持与手机号快速验证组件、手机号实时验证组件耦合使用，调用方式为
也支持隐私同意按钮与获取用户信息组件耦合使用，调用方式为
示例代码
<button id="agree-btn1" open-type="getPhoneNumber|agreePrivacyAuthorization" bindgetphonenumber="handleGetPhoneNumber" bindagreeprivacyauthorization="handleAgreePrivacyAuthorization">同意隐私协议并授权手机号button>
<button id="agree-btn2" open-type="getRealtimePhoneNumber|agreePrivacyAuthorization" bindgetrealtimephonenumber="handleGetRealtimePhoneNumber" bindagreeprivacyauthorization="handleAgreePrivacyAuthorization">同意隐私协议并授权手机号button>
<button id="agree-btn3" open-type="getUserInfo|agreePrivacyAuthorization" bindgetuserinfo="handleGetUserInfo" bindagreeprivacyauthorization="handleAgreePrivacyAuthorization">同意隐私协议并获取头像昵称信息button>
// page.js
Page({
handleAgreePrivacyAuthorization() {
// 用户同意隐私协议事件回调
// 用户点击了同意，之后所有已声明过的隐私接口和组件都可以调用了
// wx.getUserProfile()
// wx.chooseMedia()
// wx.getClipboardData()
// wx.startRecord()
},
handleGetPhoneNumber(e) {
// 获取手机号成功
console.log(e)
},
handleGetRealtimePhoneNumber(e) {
// 获取实时手机号成功
console.log(e)
},
handleGetUserInfo(e) {
// 获取头像昵称成功
console.log(e)
}
})
3. 被动监听隐私接口需要用户授权事件
从基础库 2.32.3 开始支持
小程序开发者除了可以自行判断时机，提示用户阅读隐私政策等收集使用规则外，也可以通过 wx.onNeedPrivacyAuthorization 接口来监听何时需要提示用户阅读隐私政策。当用户触发了一个微信侧未记录过同意的隐私接口调用，则会触发该事件。开发者可在该事件触发时提示用户阅读隐私政策。
需要注意的是，对于 组件，由于 的特殊性，如果用户未同意隐私协议，则 聚焦时不会触发 onNeedPrivacyAuthorization 事件，而是降级为 。
此外，微信还提供了 wx.requirePrivacyAuthorize 接口，可用于模拟隐私接口调用。
代码示例
// page.wxml
<view wx:if="{{showPrivacy}}">
<view>隐私弹窗内容....view>
<button id="agree-btn" open-type="agreePrivacyAuthorization" bindagreeprivacyauthorization="handleAgreePrivacyAuthorization">同意button>
view>
// page.js
Page({
data: {
showPrivacy: false
},
onLoad() {
wx.onNeedPrivacyAuthorization((resolve, eventInfo) => {
console.log('触发本次事件的接口是：' + eventInfo.referrer)
// 需要用户同意隐私授权时
// 弹出开发者自定义的隐私授权弹窗
this.setData({
showPrivacy: true
})
this.resolvePrivacyAuthorization = resolve
})
wx.getUserProfile({
success: console.log,
fail: console.error
})
},
handleAgreePrivacyAuthorization() {
// 用户点击同意按钮后
this.resolvePrivacyAuthorization({ buttonId: 'agree-btn', event: 'agree' })
// 用户点击同意后，开发者调用 resolve({ buttonId: 'agree-btn', event: 'agree' }) 告知平台用户已经同意，参数传同意按钮的id
// 用户点击拒绝后，开发者调用 resolve({ event:'disagree' }) 告知平台用户已经拒绝
}
})
4. 清空历史同步状态
当用户从「微信下拉-最近-最近使用的小程序」中删除小程序，将清空历史同步状态。下次访问小程序后，需要重新同步微信当前用户已阅读并同意小程序的隐私政策等收集使用规则。
开发者可通过此方式进行调试，也可以在开发者工具中「清除模拟器缓存-清除授权数据」清空历史同步状态。
三、其他说明
低于 2.32.3 版本的基础库未集成隐私相关功能，也不会拦截隐私接口调用。
四、完整示例demo
demo1: 演示使用 wx.getPrivacySetting 和
demo2: 演示使用 wx.onNeedPrivacyAuthorization 和
demo3: 演示 wx.onNeedPrivacyAuthorization、wx.requirePrivacyAuthorize、
demo4: 演示使用 wx.onNeedPrivacyAuthorization 和
五、常见错误说明
{ "errMsg": "A:fail api scope is not declared in the privacy agreement", "errno": 112 } 使用到了 A 隐私接口，但是开发者未在[mp后台-设置-服务内容声明-用户隐私保护指引]中声明收集 A 接口对应的隐私类型
uniapp小程序特别指导：
uniapp则在manifest.json中对应位置添加
"mp-weixin": {
"__usePrivacyCheck__": true,
封装公共方法
// 查询隐私设置
export const getPrivacySetting = () => new Promise((resolve, reject) => {
wx.getPrivacySetting({
success: res => {
// 返回结果为: res = { needAuthorization: true/false, privacyContractName: '《xxx隐私保护指引》' }
console.log('隐私设置getPrivacySetting', res)
resolve(res)
},
fail: () => {
reject()
},
});
})
封装的弹窗提示组件
title="用户隐私协议" v-model="showModal" :show-confirm-button="false" :show-cancel-button="false" > >欢迎使用“xxx”！我们非常重视您的个人信息和隐私保护。在您使用xxx服务之前，请仔细阅读 privacyContractName }} >，我们将严格按照经您同意的各项条款使用您的个人信息，以便为您提供更好的服务。 > >如您同意此协议，请点击“同意”并开始使用我们的产品和服务，我们将尽全力保护您的个人信息安全。 > open-type="agreePrivacyAuthorization" @agreeprivacyauthorization="agreeprivacyauthorization" style="color: #2979ff" @click="confirm" > 同意 你可以在你想要的地方引入组件，并在想要的地方调用判断 如我的页面需要微信登录调用 wx.getUserProfile 可以在涉及调用隐私api之前调用弹窗查询隐私是否同意弹窗，可以加载首页直接根据判断弹窗，可以在登录页添加等等，根据需要进行添加 可以主动查询，也可以被动查询 :title="'我的'" :isBack="false" :background="{ backgroundColor: '#ffffff', }" /> 同意后，如何清除隐私授权，重新触发wx.getPrivacySetting回调的needAuthorization: true判断？ 当用户从「微信下拉-最近-最近使用的小程序」中删除小程序，将清空历史同步状态。下次访问小程序后，需要重新同步微信当前用户已阅读并同意小程序的隐私政策等收集使用规则。 开发者可通过此方式进行调试，也可以在开发者工具中「清除模拟器缓存-清除授权数据」清空历史同步状态。 如下图：先点击清除授权数据，再点击编译进行重新编译 精彩链接
您阅读本篇文章共花了：
发表评论