完成接入准备后，商家/服务商可根据本文指引快速接入收藏。

说明：

收藏仅支持自研商家/服务商通过小程序应用或第三方应用代调用（传入 app_auth_token）方式，调用 API 接入。

收藏暂不支持沙箱调试。

完整时序图

创建投放活动

商家/服务商可以通过接口创建对应投放活动，通过配置有效的小程序收藏引导（tips）文案，创建小程序收藏引导活动。用户在活动有效期内访问相应页面，将展示配置的个性化文案，引导用户收藏小程序，待人工审核（一般为 1 个工作日）完成后即可生效。

商家/服务商可调用 alipay.open.mini.tips.delivery.create（小程序收藏引导投放活动配置创建），创建投放活动。

示例代码

package com.java.sdk.demo;

import com.alipay.v3.ApiException;
import com.alipay.v3.ApiClient;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.Configuration;
import com.alipay.v3.api.AlipayOpenMiniTipsDeliveryApi;
import com.alipay.v3.model.*;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class AlipayOpenMiniTipsDeliveryApiCreate {

    public static void main(String[] args) throws ApiException {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // 初始化alipay参数（全局设置一次）
        AlipayConfig alipayConfig = new AlipayConfig();
        alipayConfig.setServerUrl("https://openapi.alipay.com");
        alipayConfig.setAppId("<-- 请填写您的AppId，例如：2019091767145019 -->");
        alipayConfig.setPrivateKey("<-- 请填写您的应用私钥，例如：MIIEvQIBADANB ... ... -->");
        alipayConfig.setAlipayPublicKey("<-- 请填写您的支付宝公钥，例如：MIIBIjANBg... -->");
        defaultClient.setAlipayConfig(alipayConfig);
        AlipayOpenMiniTipsDeliveryApi api = new AlipayOpenMiniTipsDeliveryApi();
        AlipayOpenMiniTipsDeliveryCreateModel data = new AlipayOpenMiniTipsDeliveryCreateModel();
        data.setDeliveryContent("点击收藏，下次使用更方便");
        data.setStartTime("2021-11-25 15:23:43");
        data.setDeliveryName("收藏引导首页投放活动");
        data.setMatchType("TARGETURL");
        data.setMatchUrl("/page/web");
        data.setEndTime("2022-12-31 15:23:43");
        try {
            AlipayOpenMiniTipsDeliveryCreateResponseModel response = api.create(data);
        } catch (ApiException e) {
            AlipayOpenMiniTipsDeliveryCreateDefaultResponse errorObject = (AlipayOpenMiniTipsDeliveryCreateDefaultResponse) e.getErrorObject();
            System.out.println("调用失败:" + errorObject);
        }
    }
}

重要入参说明

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":"20211111000000797023"
}

响应参数

delivery_id：创建成功的收藏引导活动 ID。

更多请求、响应参数说明及错误码详情，可查看alipay.open.mini.tips.delivery.create（小程序收藏引导投放活动配置创建）文档。

商家/服务商还可以调用接口对收藏引导活动状态进行修改，目前支持暂停、恢复、终止单个收藏引导活动。

修改投放活动状态

商家/服务商可调用 alipay.open.mini.tips.delivery.modify（小程序收藏引导投放活动修改），对投放活动状态进行修改。

示例代码

package com.java.sdk.demo;

import com.alipay.v3.ApiException;
import com.alipay.v3.ApiClient;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.Configuration;
import com.alipay.v3.api.AlipayOpenMiniTipsDeliveryApi;
import com.alipay.v3.model.*;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class AlipayOpenMiniTipsDeliveryApiModify {

    public static void main(String[] args) throws ApiException {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // 初始化alipay参数（全局设置一次）
        AlipayConfig alipayConfig = new AlipayConfig();
        alipayConfig.setServerUrl("https://openapi.alipay.com");
        alipayConfig.setAppId("<-- 请填写您的AppId，例如：2019091767145019 -->");
        alipayConfig.setPrivateKey("<-- 请填写您的应用私钥，例如：MIIEvQIBADANB ... ... -->");
        alipayConfig.setAlipayPublicKey("<-- 请填写您的支付宝公钥，例如：MIIBIjANBg... -->");
        defaultClient.setAlipayConfig(alipayConfig);
        AlipayOpenMiniTipsDeliveryApi api = new AlipayOpenMiniTipsDeliveryApi();
        AlipayOpenMiniTipsDeliveryModifyModel data = new AlipayOpenMiniTipsDeliveryModifyModel();
        data.setDeliveryId("20211114000003057595");
        data.setOperateType("RESUME");
        try {
            Object response = api.modify(data);
        } catch (ApiException e) {
            AlipayOpenMiniTipsDeliveryModifyDefaultResponse errorObject = (AlipayOpenMiniTipsDeliveryModifyDefaultResponse) e.getErrorObject();
            System.out.println("调用失败:" + errorObject);
        }
    }
}

重要入参说明

delivery_id：收藏引导活动 ID。

operate_type：活动投放操作类型。

枚举值：

RESUME：恢复，仅对 PAUSE 状态的投放活动有效。

PAUSE：暂停，仅对 WORKING 状态的投放活动有效。

STOP：终止，仅对 PAUSE 和 WORKING 状态的投放活动有效。

响应示例

{}

响应参数

delivery_id：修改的收藏引导活动 ID。

更多请求、响应参数说明及错误码详情，可查看 alipay.open.mini.tips.delivery.modify（小程序收藏引导投放活动修改）接口文档。

查询活动详情

商家/服务商可以通过接口对收藏引导活动信息进行查询，包括投放活动详情查询（获取当前活动 ID 对应活动的配置及状态信息）、投放活动分页查询和投放活动汇总数据查询（可查询小程序维度或活动维度的收藏引导词曝光 UV，收藏 UV，以及收藏转化率）。

商家/服务商可调用 alipay.open.mini.tips.delivery.query（小程序收藏引导投放活动详情查询），查询活动配置详情信息。

示例代码

package com.java.sdk.demo;

import com.alipay.v3.ApiException;
import com.alipay.v3.ApiClient;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.Configuration;
import com.alipay.v3.api.AlipayOpenMiniTipsDeliveryApi;
import com.alipay.v3.model.*;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class AlipayOpenMiniTipsDeliveryApiQuery {

    public static void main(String[] args) throws ApiException {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // 初始化alipay参数（全局设置一次）
        AlipayConfig alipayConfig = new AlipayConfig();
        alipayConfig.setServerUrl("https://openapi.alipay.com");
        alipayConfig.setAppId("<-- 请填写您的AppId，例如：2019091767145019 -->");
        alipayConfig.setPrivateKey("<-- 请填写您的应用私钥，例如：MIIEvQIBADANB ... ... -->");
        alipayConfig.setAlipayPublicKey("<-- 请填写您的支付宝公钥，例如：MIIBIjANBg... -->");
        defaultClient.setAlipayConfig(alipayConfig);
        AlipayOpenMiniTipsDeliveryApi api = new AlipayOpenMiniTipsDeliveryApi();
        String deliveryId = "20211114000003057595";
        try {
            AlipayOpenMiniTipsDeliveryQueryResponseModel response = api.query(deliveryId);
        } catch (ApiException e) {
            AlipayOpenMiniTipsDeliveryQueryDefaultResponse errorObject = (AlipayOpenMiniTipsDeliveryQueryDefaultResponse) e.getErrorObject();
            System.out.println("调用失败:" + errorObject);
        }
    }
}

重要入参说明

delivery_id：收藏引导活动 ID。

响应示例

{
    "start_time":"2021-11-11 14:31:13",
    "delivery_content":"点击收藏，下次访问更方便",
    "delivery_name":"收藏引导配置投放活动",
    "delivery_id":"20211114000003057595",
    "end_time":"2021-11-12 14:31:13",
    "match_type":"TARGETURL",
    "match_url":"/page/web",
    "fail_reason":"当前文案语义不通顺，请修改",
    "status":"WORKING"
}

响应参数

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：活动结束时间。

更多请求、响应参数说明及错误码详情，可查看 alipay.open.mini.tips.delivery.query（小程序收藏引导投放活动详情查询）文档。

分页查询活动

商家/服务商可调用 alipay.open.mini.tips.delivery.batchquery（小程序收藏引导投放活动配置批量查询），分页查询活动配置信息。

示例代码

package com.java.sdk.demo;

import com.alipay.v3.ApiException;
import com.alipay.v3.ApiClient;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.Configuration;
import com.alipay.v3.api.AlipayOpenMiniTipsDeliveryApi;
import com.alipay.v3.model.*;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class AlipayOpenMiniTipsDeliveryApiBatchquery {

    public static void main(String[] args) throws ApiException {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // 初始化alipay参数（全局设置一次）
        AlipayConfig alipayConfig = new AlipayConfig();
        alipayConfig.setServerUrl("https://openapi.alipay.com");
        alipayConfig.setAppId("<-- 请填写您的AppId，例如：2019091767145019 -->");
        alipayConfig.setPrivateKey("<-- 请填写您的应用私钥，例如：MIIEvQIBADANB ... ... -->");
        alipayConfig.setAlipayPublicKey("<-- 请填写您的支付宝公钥，例如：MIIBIjANBg... -->");
        defaultClient.setAlipayConfig(alipayConfig);
        AlipayOpenMiniTipsDeliveryApi api = new AlipayOpenMiniTipsDeliveryApi();
        AlipayOpenMiniTipsDeliveryBatchqueryModel data = new AlipayOpenMiniTipsDeliveryBatchqueryModel();
        data.setPageNumber("1");
        data.setPageSize("5");
        try {
            AlipayOpenMiniTipsDeliveryBatchqueryResponseModel response = api.batchquery(data);
        } catch (ApiException e) {
            AlipayOpenMiniTipsDeliveryBatchqueryDefaultResponse errorObject = (AlipayOpenMiniTipsDeliveryBatchqueryDefaultResponse) e.getErrorObject();
            System.out.println("调用失败:" + errorObject);
        }
    }
}

重要入参说明

page_number：当前页码。

page_size：每页展示条数。

响应示例

{
    "tips_delivery_list":[
        {
            "start_time":"2021-11-11 14:31:13",
            "delivery_content":"点击收藏，下次访问更方便",
            "delivery_name":"首页收藏引导投放活动",
            "delivery_id":"20211114000003057595",
            "end_time":"2021-12-23 14:29:00",
            "match_type":"TARGETURL",
            "match_url":"/page/web",
            "fail_reason":"当前文案语义不通顺，请修改",
            "status":"WORKING"
        }
    ],
    "total_size":20,
    "total_pages":1
}

响应参数

total_pages：总页数。

total_size：收藏引导活动总数量。

tips_delivery_list：收藏引导活动列表（具体字段说明可查看 活动详情页查询接口响应参数）。

更多请求、响应参数说明及错误码详情，可查看 alipay.open.mini.tips.delivery.batchquery（小程序收藏引导投放活动配置批量查询）文档。

查询活动汇总数据

商家/服务商可调用 alipay.open.mini.tips.statistic.query（小程序收藏引导汇总数据查询），查询小程序维度或活动维度的收藏引导词曝光 UV，收藏 UV，以及收藏转化率，返回参数中的昨天指接口调用当天的昨日。

示例代码

package com.java.sdk.demo;

import com.alipay.v3.ApiException;
import com.alipay.v3.ApiClient;
import com.alipay.v3.util.model.AlipayConfig;
import com.alipay.v3.Configuration;
import com.alipay.v3.api.AlipayOpenMiniTipsStatisticApi;
import com.alipay.v3.model.*;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class AlipayOpenMiniTipsStatisticApiQuery {

    public static void main(String[] args) throws ApiException {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        // 初始化alipay参数（全局设置一次）
        AlipayConfig alipayConfig = new AlipayConfig();
        alipayConfig.setServerUrl("https://openapi.alipay.com");
        alipayConfig.setAppId("<-- 请填写您的AppId，例如：2019091767145019 -->");
        alipayConfig.setPrivateKey("<-- 请填写您的应用私钥，例如：MIIEvQIBADANB ... ... -->");
        alipayConfig.setAlipayPublicKey("<-- 请填写您的支付宝公钥，例如：MIIBIjANBg... -->");
        defaultClient.setAlipayConfig(alipayConfig);
        AlipayOpenMiniTipsStatisticApi api = new AlipayOpenMiniTipsStatisticApi();
        String deliveryId = "20220308000000934758";
        String queryType = "app";
        String startDate = "20220322";
        String endDate = "20220328";
        try {
            AlipayOpenMiniTipsStatisticQueryResponseModel response = api.query(deliveryId, queryType, startDate, endDate);
        } catch (ApiException e) {
            AlipayOpenMiniTipsStatisticQueryDefaultResponse errorObject = (AlipayOpenMiniTipsStatisticQueryDefaultResponse) e.getErrorObject();
            System.out.println("调用失败:" + errorObject);
        }
    }
}

重要入参说明

delivery_id：收藏引导投放活动 ID，供查询收藏引导活动配置接口调用，当以小程序维度查询数据（query_type为app）时 delivery_id 为空。

query_type：查询类型，表示以当前维度进行数据聚合。

枚举值：

app：小程序维度。

activity：活动维度。

start_date：查询开始日期，精度为天。

end_date：查询截止日期，精度为天。

响应示例

{
    "app_collect_cnt":4798780,
    "total_tips_expo_uv":2333900,
    "tips_expo_uv":434000,
    "delivery_content":"点击收藏，下次使用更方便",
    "delivery_id":"2018092061468502",
    "tips_collect_rate":"33.33",
    "tips_collect_uv":440000,
    "app_uv":3080000,
    "total_app_uv":79980000,
    "total_tips_collect_uv":5030000,
    "total_app_collect_cnt":7800000,
    "total_tips_collect_rate":"33.33"
}

响应参数

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（小程序收藏引导汇总数据查询）文档。

接入指南

完整时序图#

创建投放活动#

示例代码#

重要入参说明#

活动配置规则#

响应示例#

响应参数#

修改投放活动状态#

示例代码#

重要入参说明#

响应示例#

响应参数#

查询活动详情#

示例代码#

重要入参说明#

响应示例#

响应参数#

分页查询活动#

示例代码#

重要入参说明#

响应示例#

响应参数#

查询活动汇总数据#

示例代码#

重要入参说明#

响应示例#

响应参数#

完整时序图

创建投放活动

示例代码

重要入参说明

活动配置规则

响应示例

响应参数

修改投放活动状态

示例代码

重要入参说明

响应示例

响应参数

查询活动详情

示例代码

重要入参说明

响应示例

响应参数

分页查询活动

示例代码

重要入参说明

响应示例

响应参数

查询活动汇总数据

示例代码

重要入参说明

响应示例

响应参数