沙箱调试
搜索直达沙箱调试说明
业务用例
品牌认证管理
上传资质图片
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.AlipayOpenMiniMiniappBrandApi;
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 AlipayOpenMiniMiniappBrandApiUpload {
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);
AlipayOpenMiniMiniappBrandApi api = new AlipayOpenMiniMiniappBrandApi();
File fileContent = new File("文件路径");
try {
AlipayOpenMiniMiniappBrandUploadResponseModel response = api.upload(fileContent);
} catch (ApiException e) {
AlipayOpenMiniMiniappBrandUploadDefaultResponse errorObject = (AlipayOpenMiniMiniappBrandUploadDefaultResponse) e.getErrorObject();
System.out.println("调用失败:" + errorObject);
}
}
}
{
"file_key":"A*BTRVJSTHEBRE784685"
}
提交品牌认证申请
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.AlipayOpenMiniMiniappBrandApi;
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 AlipayOpenMiniMiniappBrandApiSubmit {
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);
AlipayOpenMiniMiniappBrandApi api = new AlipayOpenMiniMiniappBrandApi();
AlipayOpenMiniMiniappBrandSubmitModel data = new AlipayOpenMiniMiniappBrandSubmitModel();
data.setApplyType("AUTHORIZE_BRAND_APPLY");
AuthorizeInfo authorizeInfo = new AuthorizeInfo();
authorizeInfo.setStartDate("2020-10-16");
authorizeInfo.setAuthName("张三");
authorizeInfo.setEndDate("2021-10-16");
List<String> authIds = new ArrayList<String>();
authIds.add("ua2qD53TRpyfX-UYYin6sQAAACMAAQED");
authIds.add("ua2qD53TRpyfX-UYYin6sQAAACMAAQED");
authorizeInfo.setAuthIds(authIds);
List<String> authMaterials = new ArrayList<String>();
authMaterials.add("ua2qD53TRpyfX-UYYin6sQAAACMAAQED");
authMaterials.add("ua2qD53TRpyfX-UYYin6sQAAACMAAQED");
authorizeInfo.setAuthMaterials(authMaterials);
data.setAuthorizeInfo(authorizeInfo);
List<String> idMaterials = new ArrayList<String>();
idMaterials.add("ua2qD53TRpyfX-UYYin6sQAAACMAAQED");
idMaterials.add("ua2qD53TRpyfX-UYYin6sQAAACMAAQED");
data.setIdMaterials(idMaterials);
data.setBrandName("CR7合作");
BrandRegistrationInfo brandRegistrationInfo = new BrandRegistrationInfo();
List<String> regMaterials = new ArrayList<String>();
regMaterials.add("ua2qD53TRpyfX-UYYin6sQAAACMAAQED");
regMaterials.add("ua2qD53TRpyfX-UYYin6sQAAACMAAQED");
brandRegistrationInfo.setRegMaterials(regMaterials);
brandRegistrationInfo.setStartDate("2020-10-16");
brandRegistrationInfo.setRegistrant("张三");
brandRegistrationInfo.setEndDate("2021-10-16");
brandRegistrationInfo.setRegNumber("654893218979520200916249621");
data.setBrandRegistrationInfo(brandRegistrationInfo);
data.setBrandId("brand2020091614782813");
try {
Object response = api.submit(data);
} catch (ApiException e) {
AlipayOpenMiniMiniappBrandSubmitDefaultResponse errorObject = (AlipayOpenMiniMiniappBrandSubmitDefaultResponse) e.getErrorObject();
System.out.println("调用失败:" + errorObject);
}
}
}
{}
查询申请审核结果
{
"merchant_brand_list_result":{
"brand_list_result":[
{
"brand_name":"brand_namecr7officials",
"brand_id":"brand_id2020091685456316"
}
]
},
"miniapp_brand_audit_result":{
"has_brand":"true",
"brand_name":"brand_namecr7officials",
"invalid_reason":"品牌授权日期已到",
"reject_reason":"申请人身份认证不通过",
"brand_status":"AUDITING(审核中)",
"brand_id":"brand_id2020091684564595"
}
}
miniapp_brand_audit_result
的值是未认证状态。取消品牌认证
{}
搜索直达管理
上传图片资料
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.AlipayOpenFileApi;
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 AlipayOpenFileApiUpload {
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);
AlipayOpenFileApi api = new AlipayOpenFileApi();
AlipayOpenFileUploadModel data = new AlipayOpenFileUploadModel();
data.setBizCode("content_creation");
data.setMd5("9cff2d79bc81acf12abbaca7328a4dc5");
FileUploadExtraParam extraParameters = new FileUploadExtraParam();
extraParameters.setExternUpload("youku");
data.setExtraParameters(extraParameters);
File fileContent = new File("文件路径");
try {
AlipayOpenFileUploadResponseModel response = api.upload(data, fileContent);
} catch (ApiException e) {
AlipayOpenFileUploadDefaultResponse errorObject = (AlipayOpenFileUploadDefaultResponse) e.getErrorObject();
System.out.println("调用失败:" + errorObject);
}
}
}
{
"file_id":"A*6XqwQKpS1t0AAAAAAAAAAAAADi92AA",
"extern_id":"XNTk0NjE5NjI4OA=="
}
搜索直达创建预校验
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.AlipayOpenSearchBoxApi;
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 AlipayOpenSearchBoxApiConsult {
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);
AlipayOpenSearchBoxApi api = new AlipayOpenSearchBoxApi();
AlipayOpenSearchBoxConsultModel data = new AlipayOpenSearchBoxConsultModel();
List<SearchBoxServiceInfo> serviceInfos = new ArrayList<SearchBoxServiceInfo>();
SearchBoxServiceInfo serviceInfos0 = new SearchBoxServiceInfo();
serviceInfos0.setServiceCategoryCode("XS2075");
serviceInfos0.setServiceCode("2021012121000864802961");
serviceInfos0.setServiceName("点餐");
serviceInfos0.setServiceCategoryName("点餐与排队");
serviceInfos.add(serviceInfos0);
data.setServiceInfos(serviceInfos);
List<SearchBoxAppInfo> relatedAccounts = new ArrayList<SearchBoxAppInfo>();
SearchBoxAppInfo relatedAccounts0 = new SearchBoxAppInfo();
relatedAccounts0.setRelateAppid("2018061360108419");
relatedAccounts0.setAppType("TINY_APP");
relatedAccounts0.setAppName("小程序名称");
relatedAccounts.add(relatedAccounts0);
data.setRelatedAccounts(relatedAccounts);
data.setImageName("氛围图1");
List<String> customKeywords = new ArrayList<String>();
customKeywords.add("自定义触发词");
data.setCustomKeywords(customKeywords);
data.setBoxDesc("品牌介绍");
data.setImageId("A*oZQmT4xTBPUAAAAAAAAAAAAAAQAAAQ");
data.setAreaKeywords("简称触发词");
List<String> businessDistrictIds = new ArrayList<String>();
businessDistrictIds.add("商圈id");
data.setBusinessDistrictIds(businessDistrictIds);
data.setTargetAppid("2018092561XXXXXX");
data.setBusinessBenefitSwitch(true);
data.setBrandId("1000467882");
try {
AlipayOpenSearchBoxConsultResponseModel response = api.consult(data);
} catch (ApiException e) {
AlipayOpenSearchBoxConsultDefaultResponse errorObject = (AlipayOpenSearchBoxConsultDefaultResponse) e.getErrorObject();
System.out.println("调用失败:" + errorObject);
}
}
}
{
"access":true,
"not_pass_items":[
"小程序未设置搜索可见"
]
}
创建搜索直达配置
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.AlipayOpenSearchBoxApi;
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 AlipayOpenSearchBoxApiApply {
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);
AlipayOpenSearchBoxApi api = new AlipayOpenSearchBoxApi();
AlipayOpenSearchBoxApplyModel data = new AlipayOpenSearchBoxApplyModel();
List<SearchBoxServiceInfo> serviceInfos = new ArrayList<SearchBoxServiceInfo>();
SearchBoxServiceInfo serviceInfos0 = new SearchBoxServiceInfo();
serviceInfos0.setServiceCategoryCode("XS2075");
serviceInfos0.setServiceCode("2021012121000864802961");
serviceInfos0.setServiceName("点餐");
serviceInfos0.setServiceCategoryName("点餐与排队");
serviceInfos.add(serviceInfos0);
data.setServiceInfos(serviceInfos);
List<SearchBoxAppInfo> relatedAccounts = new ArrayList<SearchBoxAppInfo>();
SearchBoxAppInfo relatedAccounts0 = new SearchBoxAppInfo();
relatedAccounts0.setRelateAppid("2018061360108419");
relatedAccounts0.setAppType("TINY_APP");
relatedAccounts0.setAppName("小程序名称");
relatedAccounts.add(relatedAccounts0);
data.setRelatedAccounts(relatedAccounts);
data.setImageName("氛围图1");
List<String> customKeywords = new ArrayList<String>();
customKeywords.add("自定义触发词");
data.setCustomKeywords(customKeywords);
data.setBoxDesc("品牌介绍");
data.setImageId("A*oZQmT4xTBPUAAAAAAAAAAAAAAQAAAQ");
List<String> areaKeywords = new ArrayList<String>();
areaKeywords.add("简称触发词");
data.setAreaKeywords(areaKeywords);
List<String> businessDistrictIds = new ArrayList<String>();
businessDistrictIds.add("商圈id");
data.setBusinessDistrictIds(businessDistrictIds);
data.setTargetAppid("2018092561507369");
data.setBusinessBenefitSwitch(true);
data.setBrandId("1000467882");
try {
AlipayOpenSearchBoxApplyResponseModel response = api.apply(data);
} catch (ApiException e) {
AlipayOpenSearchBoxApplyDefaultResponse errorObject = (AlipayOpenSearchBoxApplyDefaultResponse) e.getErrorObject();
System.out.println("调用失败:" + errorObject);
}
}
}
{
"box_id":"20220117000000112680"
}
接收搜索直达审核通过通知
消息业务参数示例值:
{
"box_id": "20221229000000100882",
"module_id": "20221229000000100899",
"module_type": "BOX_ATMOSPHERE_IMAGE",
"event": "PASS"
}
修改搜索直达配置
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.AlipayOpenSearchBoxApi;
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 AlipayOpenSearchBoxApiModify {
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);
AlipayOpenSearchBoxApi api = new AlipayOpenSearchBoxApi();
AlipayOpenSearchBoxModifyModel data = new AlipayOpenSearchBoxModifyModel();
List<SearchBoxServiceInfo> serviceInfos = new ArrayList<SearchBoxServiceInfo>();
SearchBoxServiceInfo serviceInfos0 = new SearchBoxServiceInfo();
serviceInfos0.setServiceCategoryCode("XS2075");
serviceInfos0.setServiceCode("2021012121000864802961");
serviceInfos0.setServiceName("点餐");
serviceInfos0.setServiceCategoryName("点餐与排队");
serviceInfos.add(serviceInfos0);
data.setServiceInfos(serviceInfos);
List<SearchBoxAppInfo> relatedAccounts = new ArrayList<SearchBoxAppInfo>();
SearchBoxAppInfo relatedAccounts0 = new SearchBoxAppInfo();
relatedAccounts0.setRelateAppid("2018061360108419");
relatedAccounts0.setAppType("TINY_APP");
relatedAccounts0.setAppName("小程序名称");
relatedAccounts.add(relatedAccounts0);
data.setRelatedAccounts(relatedAccounts);
data.setImageName("搜索直达氛围图1");
data.setModuleId("20220308000000168465");
data.setCustomKeywords("[\"自定义关键词\"]");
data.setBoxDesc("品牌介绍");
data.setImageId("A*oZQmT4xTBPUAAAAAAAAAAAAAAQAAAQ");
List<String> areaKeywords = new ArrayList<String>();
areaKeywords.add("简称触发词");
data.setAreaKeywords(areaKeywords);
List<String> businessDistrictIds = new ArrayList<String>();
businessDistrictIds.add("商圈id");
data.setBusinessDistrictIds(businessDistrictIds);
data.setTargetAppid("2018092561507369");
data.setBoxId("20220308000000128693");
data.setModuleType("BOX_EXCLUSIVE_KEYWORD");
data.setBusinessBenefitSwitch(false);
data.setBrandId("1000467882");
try {
AlipayOpenSearchBoxModifyResponseModel response = api.modify(data);
} catch (ApiException e) {
AlipayOpenSearchBoxModifyDefaultResponse errorObject = (AlipayOpenSearchBoxModifyDefaultResponse) e.getErrorObject();
System.out.println("调用失败:" + errorObject);
}
}
}
{
"module_id":"20220116000000130147"
}
接收搜索直达审核通过通知
消息业务参数示例值:
{
"box_id": "20221229000000100882",
"module_id": "20221229000000100899",
"module_type": "BOX_EXCLUSIVE_KEYWORD",
"event": "PASS"
}
查询搜索直达配置列表
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.AlipayOpenSearchBoxApi;
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 AlipayOpenSearchBoxApiBatchquery {
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);
AlipayOpenSearchBoxApi api = new AlipayOpenSearchBoxApi();
AlipayOpenSearchBoxBatchqueryModel data = new AlipayOpenSearchBoxBatchqueryModel();
data.setPageSize(10);
data.setPageNumber(1);
try {
AlipayOpenSearchBoxBatchqueryResponseModel response = api.batchquery(data);
} catch (ApiException e) {
AlipayOpenSearchBoxBatchqueryDefaultResponse errorObject = (AlipayOpenSearchBoxBatchqueryDefaultResponse) e.getErrorObject();
System.out.println("调用失败:" + errorObject);
}
}
}
{
"page_number":1,
"total_count":100,
"total_page_count":5,
"box_infos":[
{
"box_id":"20220117000000112680",
"name":"搜索直达名称",
"target_appid":"2018092561507369",
"status":"ONLINE",
"brand_id":"1000467882"
}
],
"page_size":10
}
查询搜索直达配置详情
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.AlipayOpenSearchBoxApi;
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 AlipayOpenSearchBoxApiQuery {
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);
AlipayOpenSearchBoxApi api = new AlipayOpenSearchBoxApi();
String boxId = "20220308000000128693";
String merchantId = null;
try {
AlipayOpenSearchBoxQueryResponseModel response = api.query(boxId, merchantId);
} catch (ApiException e) {
AlipayOpenSearchBoxQueryDefaultResponse errorObject = (AlipayOpenSearchBoxQueryDefaultResponse) e.getErrorObject();
System.out.println("调用失败:" + errorObject);
}
}
}
{
"box_id":"20220308000000128693",
"box_status":"ONLINE",
"account_module":{
"module_id":"20220308000000168465",
"app_infos":[
{
"app_name":"小程序名称",
"app_type":"TINY_APP",
"relate_appid":"2018061360108419"
}
],
"module_type":"BOX_EXCLUSIVE_ACCOUNTS"
},
"basic_info_module":{
"module_id":"20220308000000168465",
"box_desc":"品牌介绍",
"module_type":"BOX_EXCLUSIVE_BASE",
"apply_no":"2022010700503000000000487728",
"gmt_modified":"2022-01-07 18:22:04",
"fail_reason":"品牌触发词必须完整包含品牌名称且不得使用泛词,建议调整。",
"latest_audit_box_desc":"品牌介绍",
"status":"AUDIT"
},
"valid_image":{
"module_id":"20220308000000168465",
"module_type":"BOX_ATMOSPHERE_IMAGE",
"apply_no":"2022010700503000000000487728",
"gmt_modified":"2022-01-07 18:22:04",
"fail_reason":"品牌触发词必须完整包含品牌名称且不得使用泛词,建议调整。",
"status":"OFFLINE"
},
"business_district_module":{
"module_id":"20220308000000168465",
"module_type":"BOX_BUSINESS_DISTRICT",
"business_district_infos":[
{
"app_name":"应用名",
"relate_appid":"2018061360108419",
"business_district_name":"商圈名称",
"service_code":"2019112021000906169109",
"business_district_id":"169109"
}
]
},
"service_module":{
"module_id":"20220308000000168465",
"module_type":"BOX_EXCLUSIVE_FUNCTIONS",
"service_infos":[
{
"service_category_name":"点餐与排队",
"service_name":"点餐",
"service_category_code":"XS2075",
"service_code":"2021012121000864802961"
}
]
},
"latest_audit_image":{
"module_id":"20220308000000168465",
"module_type":"BOX_ATMOSPHERE_IMAGE",
"apply_no":"2022010700503000000000487728",
"gmt_modified":"2022-01-07 18:22:04",
"fail_reason":"品牌触发词必须完整包含品牌名称且不得使用泛词,建议调整。",
"status":"OFFLINE"
},
"area_keyword_module":{
"module_id":"20220308000000168465",
"valid_area_keyword_info":{
"module_id":"20220308000000168465",
"keywords":[
"关键词"
],
"apply_no":"2022102700503000000002199914",
"gmt_modified":"2022",
"fail_reason":"审核失败原因",
"status":"ONLINE"
},
"module_type":"BOX_EXCLUSIVE_AREA_KEYWORD",
"latest_audit_area_keyword_info":{
"module_id":"20220308000000168465",
"keywords":[
"关键词"
],
"apply_no":"2022102700503000000002199914",
"gmt_modified":"2022",
"fail_reason":"审核失败原因",
"status":"ONLINE"
}
},
"default_keywords":[
"默认触发词"
],
"keyword_module":{
"module_id":"20220308000000168465",
"keywords":[
"自定义触发词"
],
"module_type":"BOX_EXCLUSIVE_KEYWORD",
"apply_no":"2022010700503000000000487728",
"gmt_modified":"2022-01-07 18:22:04",
"fail_reason":"品牌触发词必须完整包含品牌名称且不得使用泛词,建议调整。",
"latest_audit_keywords":[
"自定义触发词"
],
"status":"ONLINE"
}
}
上架搜索直达
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.AlipayOpenSearchBoxApi;
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 AlipayOpenSearchBoxApiOnline {
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);
AlipayOpenSearchBoxApi api = new AlipayOpenSearchBoxApi();
AlipayOpenSearchBoxOnlineModel data = new AlipayOpenSearchBoxOnlineModel();
data.setBoxId("20211130000000100415");
try {
Object response = api.online(data);
} catch (ApiException e) {
AlipayOpenSearchBoxOnlineDefaultResponse errorObject = (AlipayOpenSearchBoxOnlineDefaultResponse) e.getErrorObject();
System.out.println("调用失败:" + errorObject);
}
}
}
{}
下架搜索直达
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.AlipayOpenSearchBoxApi;
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 AlipayOpenSearchBoxApiOffline {
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);
AlipayOpenSearchBoxApi api = new AlipayOpenSearchBoxApi();
AlipayOpenSearchBoxOfflineModel data = new AlipayOpenSearchBoxOfflineModel();
data.setBoxId("20211130000000100415");
try {
Object response = api.offline(data);
} catch (ApiException e) {
AlipayOpenSearchBoxOfflineDefaultResponse errorObject = (AlipayOpenSearchBoxOfflineDefaultResponse) e.getErrorObject();
System.out.println("调用失败:" + errorObject);
}
}
}
{}
搜索直达活动管理
上传图片资料
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.AlipayOpenFileApi;
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 AlipayOpenFileApiUpload {
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);
AlipayOpenFileApi api = new AlipayOpenFileApi();
AlipayOpenFileUploadModel data = new AlipayOpenFileUploadModel();
data.setBizCode("content_creation");
data.setMd5("9cff2d79bc81acf12abbaca7328a4dc5");
FileUploadExtraParam extraParameters = new FileUploadExtraParam();
extraParameters.setExternUpload("youku");
data.setExtraParameters(extraParameters);
File fileContent = new File("文件路径");
try {
AlipayOpenFileUploadResponseModel response = api.upload(data, fileContent);
} catch (ApiException e) {
AlipayOpenFileUploadDefaultResponse errorObject = (AlipayOpenFileUploadDefaultResponse) e.getErrorObject();
System.out.println("调用失败:" + errorObject);
}
}
}
{
"file_id":"A*6XqwQKpS1t0AAAAAAAAAAAAADi92AA",
"extern_id":"XNTk0NjE5NjI4OA=="
}
创建搜索直达活动配置
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.AlipayOpenSearchBoxactivityApi;
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 AlipayOpenSearchBoxactivityApiApply {
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);
AlipayOpenSearchBoxactivityApi api = new AlipayOpenSearchBoxactivityApi();
AlipayOpenSearchBoxactivityApplyModel data = new AlipayOpenSearchBoxactivityApplyModel();
data.setMaterialType("IMAGE");
data.setBackgroundWord("搜索底纹推广词");
SearchBoxActivityVideoInfo videoInfo = new SearchBoxActivityVideoInfo();
videoInfo.setVideoBtnText("去领取");
videoInfo.setVideoCoverimgId("A*oZQmT4xTBPUAAAAAAAAAAAAAAQAAAQ");
videoInfo.setVideoTitle("XX美容套组0元领");
videoInfo.setVideoSubTitle("洁面+电动洁面仪=免费试用");
data.setVideoInfo(videoInfo);
data.setActionUrl("alipays://platformapi/startapp?appId=2021001198637195&pages/kaq_maid/kaq_maid");
data.setBoxId("20211130000000100415");
data.setStartTime("2022-02-10 08:00:00");
data.setTitle("活动标题");
data.setEndTime("2022-09-30 23:59:59");
data.setTargetAppid("2021001191699651");
List<DeliveryTargetRegion> targetRegions = new ArrayList<DeliveryTargetRegion>();
DeliveryTargetRegion targetRegions0 = new DeliveryTargetRegion();
targetRegions0.setRegionName("北京市");
targetRegions0.setRegionType("3");
targetRegions0.setRegionCode("110100");
targetRegions.add(targetRegions0);
data.setTargetRegions(targetRegions);
data.setMaterialId("A*oZQmT4xTBPUAAAAAAAAAAAAAAQAAAQ");
data.setTargetAppname("跳转小程序名称");
try {
AlipayOpenSearchBoxactivityApplyResponseModel response = api.apply(data);
} catch (ApiException e) {
AlipayOpenSearchBoxactivityApplyDefaultResponse errorObject = (AlipayOpenSearchBoxactivityApplyDefaultResponse) e.getErrorObject();
System.out.println("调用失败:" + errorObject);
}
}
}
{
"box_activity_id":"20211223000000100000"
}
接收搜索直达活动审核通过通知
消息业务参数示例值:
{
"box_id": "20221229000000100882",
"module_id": "20221229000000100899",
"box_activity_id": "20230105000000101137",
"module_type": "BOX_EXCLUSIVE_ACTIVITY",
"event": "PASS"
}
修改搜索直达活动配置
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.AlipayOpenSearchBoxactivityApi;
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 AlipayOpenSearchBoxactivityApiModify {
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);
AlipayOpenSearchBoxactivityApi api = new AlipayOpenSearchBoxactivityApi();
AlipayOpenSearchBoxactivityModifyModel data = new AlipayOpenSearchBoxactivityModifyModel();
data.setBoxActivityId("20220308000000168465");
data.setMaterialType("IMAGE");
data.setBackgroundWord("搜索底纹推广词");
SearchBoxActivityVideoInfo videoInfo = new SearchBoxActivityVideoInfo();
videoInfo.setVideoBtnText("去领取");
videoInfo.setVideoCoverimgId("A*oZQmT4xTBPUAAAAAAAAAAAAAAQAAAQ");
videoInfo.setVideoTitle("XX美容套组0元领");
videoInfo.setVideoSubTitle("洁面+电动洁面仪=免费试用");
data.setVideoInfo(videoInfo);
data.setActionUrl("alipays://platformapi/startapp?appId=2021001198637195&pages/kaq_maid/kaq_maid");
data.setStartTime("2022-02-10 08:00:00");
data.setTitle("活动标题");
data.setEndTime("2022-09-30 23:59:59");
data.setTargetAppid("2021001191699651");
List<DeliveryTargetRegion> targetRegions = new ArrayList<DeliveryTargetRegion>();
DeliveryTargetRegion targetRegions0 = new DeliveryTargetRegion();
targetRegions0.setRegionName("北京市");
targetRegions0.setRegionType("3");
targetRegions0.setRegionCode("110100");
targetRegions.add(targetRegions0);
data.setTargetRegions(targetRegions);
data.setMaterialId("20211206OB020010034807196034");
data.setTargetAppname("跳转小程序名称");
try {
Object response = api.modify(data);
} catch (ApiException e) {
AlipayOpenSearchBoxactivityModifyDefaultResponse errorObject = (AlipayOpenSearchBoxactivityModifyDefaultResponse) e.getErrorObject();
System.out.println("调用失败:" + errorObject);
}
}
}
{}
接收搜索直达活动审核通过通知
消息业务参数示例值:
{
"box_id": "20221229000000100882",
"module_id": "20221229000000100899",
"box_activity_id": "20230105000000101137",
"module_type" : "BOX_EXCLUSIVE_ACTIVITY",
"event" : "PASS"
}
批量查询搜索直达活动配置
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.AlipayOpenSearchBoxactivityApi;
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 AlipayOpenSearchBoxactivityApiBatchquery {
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);
AlipayOpenSearchBoxactivityApi api = new AlipayOpenSearchBoxactivityApi();
AlipayOpenSearchBoxactivityBatchqueryModel data = new AlipayOpenSearchBoxactivityBatchqueryModel();
data.setPageSize(10);
data.setBoxId("20211130000000100415");
data.setPageNumber(1);
try {
AlipayOpenSearchBoxactivityBatchqueryResponseModel response = api.batchquery(data);
} catch (ApiException e) {
AlipayOpenSearchBoxactivityBatchqueryDefaultResponse errorObject = (AlipayOpenSearchBoxactivityBatchqueryDefaultResponse) e.getErrorObject();
System.out.println("调用失败:" + errorObject);
}
}
}
{
"models":[
{
"box_id":"20211130000000100415",
"box_activity_id":"20211223000000100000",
"end_time":"2022-09-30 23:59:59",
"title":"活动标题",
"material_type":"IMAGE",
"start_time":"2022-02-10 08:00:00",
"target_appname":"目标小程序名称",
"target_appid":"2021001191699651",
"material_url":"http://mdn.alipayobjects.com/mrch_spc/afts/img/A*0XA2Qo_omj4AAAAAAAAAAAAADsF1AQ/original",
"run_status":"ONLINE",
"fail_reason":"品牌触发词必须完整包含品牌名称且不得使用泛词,建议调整。",
"target_regions":[
{
"region_type":"3",
"region_name":"北京市",
"region_code":"110100"
}
],
"video_info":{
"video_sub_title":"洁面+电动洁面仪=免费试用",
"video_title":"XX美容套组0元领",
"video_btn_text":"去领取",
"video_coverimg_id":"A*oZQmT4xTBPUAAAAAAAAAAAAAAQAAAQ"
},
"status":"ONLINE"
}
],
"page_number":"1",
"total_count":100,
"total_page_count":5,
"page_size":"10"
}
查询搜索直达活动配置详情
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.AlipayOpenSearchBoxactivityApi;
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 AlipayOpenSearchBoxactivityApiQuery {
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);
AlipayOpenSearchBoxactivityApi api = new AlipayOpenSearchBoxactivityApi();
String boxActivityId = "20211223000000100000";
String merchantId = null;
try {
AlipayOpenSearchBoxactivityQueryResponseModel response = api.query(boxActivityId, merchantId);
} catch (ApiException e) {
AlipayOpenSearchBoxactivityQueryDefaultResponse errorObject = (AlipayOpenSearchBoxactivityQueryDefaultResponse) e.getErrorObject();
System.out.println("调用失败:" + errorObject);
}
}
}
{
"box_id":"20211130000000100415",
"box_activity_id":"20211223000000100000",
"background_word_info":{
"fail_reason":"审核失败原因",
"background_word":"底纹词",
"status":"ONLINE"
},
"end_time":"2022-09-30 23:59:59",
"gmt_modified":"2022-02-10 08:00:00",
"title":"活动标题",
"material_type":"IMAGE",
"start_time":"2022-02-10 08:00:00",
"target_appname":"目标小程序名",
"target_appid":"2021001191699651",
"run_status":"ONLINE",
"fail_reason":"审核失败原因",
"material_url":"http://mdn.alipayobjects.com/mrch_spc/afts/img/A*0XA2Qo_omj4AAAAAAAAAAAAADsF1AQ/original",
"target_regions":[
{
"region_type":"3",
"region_name":"北京市",
"region_code":"110100"
}
],
"background_word":"底纹词",
"video_info":{
"video_sub_title":"洁面+电动洁面仪=免费试用",
"video_title":"XX美容套组0元领",
"video_btn_text":"去领取",
"video_coverimg_id":"A*oZQmT4xTBPUAAAAAAAAAAAAAAQAAAQ"
},
"status":"AUDIT"
}
下架搜索直达活动
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.AlipayOpenSearchBoxactivityApi;
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 AlipayOpenSearchBoxactivityApiOffline {
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);
AlipayOpenSearchBoxactivityApi api = new AlipayOpenSearchBoxactivityApi();
AlipayOpenSearchBoxactivityOfflineModel data = new AlipayOpenSearchBoxactivityOfflineModel();
data.setBoxActivityId("20211223000000100000");
try {
Object response = api.offline(data);
} catch (ApiException e) {
AlipayOpenSearchBoxactivityOfflineDefaultResponse errorObject = (AlipayOpenSearchBoxactivityOfflineDefaultResponse) e.getErrorObject();
System.out.println("调用失败:" + errorObject);
}
}
}
{}
修改于 2023-11-21 03:49:28