更新时间：2024-10-23 18:09:43文档更新记录 >配置项检测工具收藏订阅更新我的文档设置接入检测（即可查看检测结果）若有未通过的接入检测项，接口将无法调通去登录返回文档完成 后，商家/服务商可根据本文指引快速接入 收藏。说明：●收藏 仅支持自研商家/服务商通过 或 第三方应用 代调用（传入 app_auth_token）方式，调用 api 接入。●收藏 支持沙箱调试。完整时序图创建投放活动商家/服务商可以通过接口创建对应投放活动，通过配置有效的小程序收藏引导（tips）文案，创建小程序收藏引导活动。用户在活动有效期内访问相应页面，将展示配置的个性化文案，引导用户收藏小程序，待人工审核（一般为 1 个工作日）完成后即可生效。商家/服务商可调用 ，创建投放活动。示例代码重要入参说明●delivery_name：收藏引导活动名称，不对用户展示。●delivery_content：收藏引导文案内容，不超过 14 个字。●match_type：匹配类型。枚举值：○global：全局生效。○targeturl：目标页面生效（需配置相应页面地址 match_url）。●match_url：目标页面地址，match_type 为 targeturl 时必填，例如 pages/xxx ，可拼接自定义参数。●start_time：活动开始时间，格式为 yyyy-mm-dd hh:mm:ss，例如 ：2021-11-25 15:23:43。●end_time：活动结束时间，格式为 yyyy-mm-dd hh:mm:ss，例如：2021-11-25 15:23:43。活动配置规则●活动配置规则：当前投放仅支持 1 个全局生效，以及 3 个目标页面投放活动，若超出数量限制将会配置失败。●活动配置流程：调用 alipay.open.mini.tips.delivery.create（小程序收藏引导投放活动配置创建接口）配置收藏引导，平台审核通过后活动生效。●实际展示规则：○展示优先级：■同一小程序的同一页面，若平台和商家/服务商均有配置，则默认商家/服务商优先级高于平台，优先出商家/服务商配置的活动。■同一小程序的同一页面，若商家/服务商有配置多个运行中的活动，则默认按创建时间优先透出 最近创建 的活动。○用户疲劳度：单个投放活动单自然日最多曝光 2 次，单个小程序单自然日最多曝光 3 次。响应示例响应参数delivery_id：创建成功的收藏引导活动 id。更多请求、响应参数说明及错误码详情，可查看文档。商家/服务商还可以调用接口对收藏引导活动状态进行修改，目前支持暂停、恢复、终止单个收藏引导活动。修改投放活动状态商家/服务商可调用 ，对投放活动状态进行修改。示例代码重要入参说明●delivery_id：收藏引导活动 id。●operate_type：活动投放操作类型。枚举值：○resume：恢复，仅对 pause 状态的投放活动有效。○pause：暂停，仅对 working 状态的投放活动有效。○stop：终止，仅对 pause 和 working 状态的投放活动有效。响应示例响应参数delivery_id：修改的收藏引导活动 id。更多请求、响应参数说明及错误码详情，可查看 接口文档。查询活动详情商家/服务商可以通过接口对收藏引导活动信息进行查询，包括投放活动详情查询（获取当前活动 id 对应活动的配置及状态信息）、投放活动分页查询和投放活动汇总数据查询（可查询小程序维度或活动维度的收藏引导词曝光 uv，收藏 uv，以及收藏转化率）。商家/服务商可调用 ，查询活动配置详情信息。示例代码重要入参说明delivery_id：收藏引导活动 id。响应示例响应参数●delivery_id：收藏引导活动 id。●delivery_name：收藏引导活动名称。●delivery_content：收藏引导文案内容。●match_type：收藏引导活动匹配类型，global 为全局生效，targeturl 为目标页面生效。●match_url：目标页面地址，match_type 为 targeturl 时有值。●status：收藏引导活动状态。枚举值：○init：初始状态。○auditing：审核中。○working：进行中。○pause：暂停。○resume：恢复。○audit_rejected：申请驳回。○finished：已结束。○deleted：已删除。●start_time：活动开始时间。●end_time：活动结束时间。更多请求、响应参数说明及错误码详情，可查看 文档。分页查询活动商家/服务商可调用 ，分页查询活动配置信息。示例代码重要入参说明●page_number：当前页码。●page_size：每页展示条数。响应示例响应参数●total_pages：总页数。●total_size：收藏引导活动总数量。●tips_delivery_list：收藏引导活动列表（具体字段说明可查看 活动详情页查询接口响应参数）。更多请求、响应参数说明及错误码详情，可查看 文档。查询活动汇总数据商家/服务商可调用 alipay.open.mini.tips.statistic.query（小程序收藏引导汇总数据查询接口），查询小程序维度或活动维度的收藏引导词曝光 uv，收藏 uv，以及收藏转化率，返回参数中的 昨天 指接口调用当天的昨日。示例代码重要入参说明●delivery_id：收藏引导投放活动 id，供查询收藏引导活动配置接口调用 ，当以小程序维度查询数据（query_type为app）时 delivery_id 为空。●query_type：查询类型，表示以当前维度进行数据聚合。 枚举值：○app：小程序维度。○activity：活动维度。●start_date：查询开始日期，精度为天。●end_date：查询截止日期，精度为天。响应示例响应参数●delivery_id：收藏引导活动 id。●delivery_content：收藏引导文案内容。●app_uv：昨日小程序访问人数。●total_app_uv：时间段内累计小程序访问人数。●app_collect_cnt：昨日小程序收藏人数。●tips_expo_uv：昨日收藏引导文案曝光用户数。●total_app_collect_cnt：截止到当日累计小程序收藏人数。●total_tips_expo_uv：时间段内累计收藏引导文案曝光用户数。●tips_collect_uv：昨日收藏引导文案收藏用户数。●total_tips_collect_uv：时间段内累计收藏引导文案收藏用户数。●tips_collect_rate：昨日收藏引导文案收藏转化率，数据为小数字符串类型，取小数点后两位，单位为百分比。●total_tips_collect_rate：时间段内收藏引导文案收藏转化率，数据为小数字符串类型，取小数点后两位，单位为百分比。更多请求、响应参数说明及错误码详情，可查看 alipay.open.mini.tips.statistic.query（小程序收藏引导汇总数据查询接口）文档。
