• Home
• com.alipay.sdk
• alipay-sdk-java-v3
• 3.1.6.ALL
• source code
• AlipayOpenPublicAdvertApi.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.alipay.v3.api.AlipayOpenPublicAdvertApi Maven / Gradle / Ivy

/*
 * 支付宝开放平台API
 * 支付宝开放平台v3协议文档
 *
 * The version of the OpenAPI document: 2024-08-30
 * 
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */


package com.alipay.v3.api;

import com.alipay.v3.ApiCallback;
import com.alipay.v3.ApiClient;
import com.alipay.v3.ApiException;
import com.alipay.v3.ApiResponse;
import com.alipay.v3.Configuration;
import com.alipay.v3.Pair;
import com.alipay.v3.ProgressRequestBody;
import com.alipay.v3.ProgressResponseBody;
import com.alipay.v3.util.AlipayLogger;
import com.alipay.v3.util.model.CustomizedParams;

import com.google.common.base.Strings;
import com.google.gson.reflect.TypeToken;

import java.io.IOException;


import com.alipay.v3.model.AlipayOpenPublicAdvertBatchqueryDefaultResponse;
import com.alipay.v3.model.AlipayOpenPublicAdvertBatchqueryResponseModel;
import com.alipay.v3.model.AlipayOpenPublicAdvertCreateDefaultResponse;
import com.alipay.v3.model.AlipayOpenPublicAdvertCreateModel;
import com.alipay.v3.model.AlipayOpenPublicAdvertCreateResponseModel;
import com.alipay.v3.model.AlipayOpenPublicAdvertDeleteDefaultResponse;
import com.alipay.v3.model.AlipayOpenPublicAdvertModifyDefaultResponse;
import com.alipay.v3.model.AlipayOpenPublicAdvertModifyModel;

import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.ws.rs.core.GenericType;

public class AlipayOpenPublicAdvertApi {
    private ApiClient localVarApiClient;
    private int localHostIndex;
    private String localCustomBaseUrl;

    public AlipayOpenPublicAdvertApi() {
        this(Configuration.getDefaultApiClient());
    }

    public AlipayOpenPublicAdvertApi(ApiClient apiClient) {
        this.localVarApiClient = apiClient;
    }

    public ApiClient getApiClient() {
        return localVarApiClient;
    }

    public void setApiClient(ApiClient apiClient) {
        this.localVarApiClient = apiClient;
    }

    public int getHostIndex() {
        return localHostIndex;
    }

    public void setHostIndex(int hostIndex) {
        this.localHostIndex = hostIndex;
    }

    public String getCustomBaseUrl() {
        return localCustomBaseUrl;
    }

    public void setCustomBaseUrl(String customBaseUrl) {
        this.localCustomBaseUrl = customBaseUrl;
    }

    /**
     * Build call for batchquery
     * @param _callback Callback for upload/download progress
     * @param customizedParams
     * @return Call to execute
     * @throws ApiException If fail to serialize the request body object
     * @http.response.details
     

        
 Status Code 
 Description 
 Response Headers 
        
 200 
 common response 
  -  
        
 0 
 请求失败 
  -  
     
     */
    public okhttp3.Call batchqueryCall(final ApiCallback _callback, CustomizedParams customizedParams) throws ApiException {
        String basePath = null;
        // Operation Servers
        String[] localBasePaths = new String[] {  };

        // Determine Base Path to Use
        if (localCustomBaseUrl != null){
            basePath = localCustomBaseUrl;
        } else if ( localBasePaths.length > 0 ) {
            basePath = localBasePaths[localHostIndex];
        } else {
            basePath = null;
        }

        Object localVarPostBody = null;

        // create path and map variables
        String localVarPath = "/v3/alipay/open/public/advert/batchquery";

        List localVarQueryParams = new ArrayList();
        List localVarCollectionQueryParams = new ArrayList();
        Map localVarHeaderParams = new HashMap();
        Map localVarCookieParams = new HashMap();
        Map localVarFormParams = new HashMap();

        final String[] localVarAccepts = {
            "application/json"
        };
        final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
        if (localVarAccept != null) {
            localVarHeaderParams.put("Accept", localVarAccept);
        }

        final String[] localVarContentTypes = {
            
        };
        final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
        if (localVarContentType != null) {
            localVarHeaderParams.put("Content-Type", localVarContentType);
        }

        if (customizedParams != null) {
            //额外query参数
            if (customizedParams.getQueryParams() != null && customizedParams.getQueryParams().size() > 0) {
                for (Map.Entry entry : customizedParams.getQueryParams().entrySet()) {
                    localVarQueryParams.addAll(localVarApiClient.parameterToPair(entry.getKey(), entry.getValue()));
                }
            }

            if (!Strings.isNullOrEmpty(customizedParams.getAppAuthToken())) {
                localVarHeaderParams.put("alipay-app-auth-token", customizedParams.getAppAuthToken());
            }

            //额外非全局header参数
            if (customizedParams.getHeaderParams() != null && customizedParams.getHeaderParams().size() > 0) {
                localVarHeaderParams.putAll(customizedParams.getHeaderParams());
            }
        }

        String[] localVarAuthNames = new String[] {  };
        return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
    }

    @SuppressWarnings("rawtypes")
    private okhttp3.Call batchqueryValidateBeforeCall(final ApiCallback _callback, CustomizedParams customizedParams) throws ApiException {
        

        okhttp3.Call localVarCall = batchqueryCall(_callback, customizedParams);
        return localVarCall;

    }

    /**
     * 生活号广告位查询接口
     * 可以通过此接口查询所有广告位的配置信息
     * @return AlipayOpenPublicAdvertBatchqueryResponseModel
     * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
     * @http.response.details
     

        
 Status Code 
 Description 
 Response Headers 
        
 200 
 common response 
  -  
        
 0 
 请求失败 
  -  
     
     */
    public AlipayOpenPublicAdvertBatchqueryResponseModel batchquery() throws ApiException {
        ApiResponse localVarResp = batchqueryWithHttpInfo(null);
        return localVarResp.getData();
    }

    public AlipayOpenPublicAdvertBatchqueryResponseModel batchquery(CustomizedParams customizedParams) throws ApiException {
        ApiResponse localVarResp = batchqueryWithHttpInfo(customizedParams);
        return localVarResp.getData();
    }

    /**
     * 生活号广告位查询接口
     * 可以通过此接口查询所有广告位的配置信息
     * @return ApiResponse<AlipayOpenPublicAdvertBatchqueryResponseModel>
     * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
     * @http.response.details
     

        
 Status Code 
 Description 
 Response Headers 
        
 200 
 common response 
  -  
        
 0 
 请求失败 
  -  
     
     */
    public ApiResponse batchqueryWithHttpInfo(CustomizedParams customizedParams) throws ApiException {
        okhttp3.Call localVarCall = batchqueryValidateBeforeCall(null, customizedParams);
        try {
            Type localVarReturnType = new TypeToken(){}.getType();
            return localVarApiClient.execute(localVarCall, localVarReturnType);
        } catch (ApiException e) {
            try {
                e.setErrorObject(localVarApiClient.getJSON().getGson().fromJson(e.getResponseBody(), new TypeToken(){}.getType()));
            } catch (Exception ex) {
                AlipayLogger.logBizWarn(ex);
            }
            throw e;
        }
    }

    /**
     * 生活号广告位查询接口 (asynchronously)
     * 可以通过此接口查询所有广告位的配置信息
     * @param _callback The callback to be executed when the API call finishes
     * @return The request call
     * @throws ApiException If fail to process the API call, e.g. serializing the request body object
     * @http.response.details
     

        
 Status Code 
 Description 
 Response Headers 
        
 200 
 common response 
  -  
        
 0 
 请求失败 
  -  
     
     * @deprecated
     */
    @Deprecated
    public okhttp3.Call batchqueryAsync(final ApiCallback _callback) throws ApiException {

        okhttp3.Call localVarCall = batchqueryValidateBeforeCall(_callback, null);
        Type localVarReturnType = new TypeToken(){}.getType();
        localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
        return localVarCall;
    }

    @Deprecated
    public okhttp3.Call batchqueryAsync(final ApiCallback _callback, CustomizedParams customizedParams) throws ApiException {

        okhttp3.Call localVarCall = batchqueryValidateBeforeCall(_callback, customizedParams);
        Type localVarReturnType = new TypeToken(){}.getType();
        localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
        return localVarCall;
    }
    /**
     * Build call for create
     * @param alipayOpenPublicAdvertCreateModel  (optional)
     * @param _callback Callback for upload/download progress
     * @param customizedParams
     * @return Call to execute
     * @throws ApiException If fail to serialize the request body object
     * @http.response.details
     

        
 Status Code 
 Description 
 Response Headers 
        
 200 
 common response 
  -  
        
 0 
 请求失败 
  -  
     
     */
    public okhttp3.Call createCall(AlipayOpenPublicAdvertCreateModel alipayOpenPublicAdvertCreateModel, final ApiCallback _callback, CustomizedParams customizedParams) throws ApiException {
        String basePath = null;
        // Operation Servers
        String[] localBasePaths = new String[] {  };

        // Determine Base Path to Use
        if (localCustomBaseUrl != null){
            basePath = localCustomBaseUrl;
        } else if ( localBasePaths.length > 0 ) {
            basePath = localBasePaths[localHostIndex];
        } else {
            basePath = null;
        }

        Object localVarPostBody = (customizedParams != null && !Strings.isNullOrEmpty(customizedParams.getBodyContent()))
                ? customizedParams.getBodyContent() : alipayOpenPublicAdvertCreateModel;

        // create path and map variables
        String localVarPath = "/v3/alipay/open/public/advert/create";

        List localVarQueryParams = new ArrayList();
        List localVarCollectionQueryParams = new ArrayList();
        Map localVarHeaderParams = new HashMap();
        Map localVarCookieParams = new HashMap();
        Map localVarFormParams = new HashMap();

        final String[] localVarAccepts = {
            "application/json"
        };
        final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
        if (localVarAccept != null) {
            localVarHeaderParams.put("Accept", localVarAccept);
        }

        final String[] localVarContentTypes = {
            "application/json"
        };
        final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
        if (localVarContentType != null) {
            localVarHeaderParams.put("Content-Type", localVarContentType);
        }

        if (customizedParams != null) {
            //额外query参数
            if (customizedParams.getQueryParams() != null && customizedParams.getQueryParams().size() > 0) {
                for (Map.Entry entry : customizedParams.getQueryParams().entrySet()) {
                    localVarQueryParams.addAll(localVarApiClient.parameterToPair(entry.getKey(), entry.getValue()));
                }
            }

            if (!Strings.isNullOrEmpty(customizedParams.getAppAuthToken())) {
                localVarHeaderParams.put("alipay-app-auth-token", customizedParams.getAppAuthToken());
            }

            //额外非全局header参数
            if (customizedParams.getHeaderParams() != null && customizedParams.getHeaderParams().size() > 0) {
                localVarHeaderParams.putAll(customizedParams.getHeaderParams());
            }
        }

        String[] localVarAuthNames = new String[] {  };
        return localVarApiClient.buildCall(basePath, localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
    }

    @SuppressWarnings("rawtypes")
    private okhttp3.Call createValidateBeforeCall(AlipayOpenPublicAdvertCreateModel alipayOpenPublicAdvertCreateModel, final ApiCallback _callback, CustomizedParams customizedParams) throws ApiException {
        

        okhttp3.Call localVarCall = createCall(alipayOpenPublicAdvertCreateModel, _callback, customizedParams);
        return localVarCall;

    }

    /**
     * 生活号广告位添加接口
     * 可通过本接口在生活号主页添加广告位，根据业务需求配置不同的图片和跳转链接
     * @param alipayOpenPublicAdvertCreateModel  (optional)
     * @return AlipayOpenPublicAdvertCreateResponseModel
     * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
     * @http.response.details
     

        
 Status Code 
 Description 
 Response Headers 
        
 200 
 common response 
  -  
        
 0 
 请求失败 
  -  
     
     */
    public AlipayOpenPublicAdvertCreateResponseModel create(AlipayOpenPublicAdvertCreateModel alipayOpenPublicAdvertCreateModel) throws ApiException {
        ApiResponse localVarResp = createWithHttpInfo(alipayOpenPublicAdvertCreateModel, null);
        return localVarResp.getData();
    }

    public AlipayOpenPublicAdvertCreateResponseModel create(AlipayOpenPublicAdvertCreateModel alipayOpenPublicAdvertCreateModel, CustomizedParams customizedParams) throws ApiException {
        ApiResponse localVarResp = createWithHttpInfo(alipayOpenPublicAdvertCreateModel, customizedParams);
        return localVarResp.getData();
    }

    /**
     * 生活号广告位添加接口
     * 可通过本接口在生活号主页添加广告位，根据业务需求配置不同的图片和跳转链接
     * @param alipayOpenPublicAdvertCreateModel  (optional)
     * @return ApiResponse<AlipayOpenPublicAdvertCreateResponseModel>
     * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
     * @http.response.details
     

        
 Status Code 
 Description 
 Response Headers 
        
 200 
 common response 
  -  
        
 0 
 请求失败 
  -  
     
     */
    public ApiResponse createWithHttpInfo(AlipayOpenPublicAdvertCreateModel alipayOpenPublicAdvertCreateModel, CustomizedParams customizedParams) throws ApiException {
        okhttp3.Call localVarCall = createValidateBeforeCall(alipayOpenPublicAdvertCreateModel, null, customizedParams);
        try {
            Type localVarReturnType = new TypeToken(){}.getType();
            return localVarApiClient.execute(localVarCall, localVarReturnType);
        } catch (ApiException e) {
            try {
                e.setErrorObject(localVarApiClient.getJSON().getGson().fromJson(e.getResponseBody(), new TypeToken(){}.getType()));
            } catch (Exception ex) {
                AlipayLogger.logBizWarn(ex);
            }
            throw e;
        }
    }

    /**
     * 生活号广告位添加接口 (asynchronously)
     * 可通过本接口在生活号主页添加广告位，根据业务需求配置不同的图片和跳转链接
     * @param alipayOpenPublicAdvertCreateModel  (optional)
     * @param _callback The callback to be executed when the API call finishes
     * @return The request call
     * @throws ApiException If fail to process the API call, e.g. serializing the request body object
     * @http.response.details
     

        
 Status Code 
 Description 
 Response Headers 
        
 200 
 common response 
  -  
        
 0 
 请求失败 
  -  
     
     * @deprecated
     */
    @Deprecated
    public okhttp3.Call createAsync(AlipayOpenPublicAdvertCreateModel alipayOpenPublicAdvertCreateModel, final ApiCallback _callback) throws ApiException {

        okhttp3.Call localVarCall = createValidateBeforeCall(alipayOpenPublicAdvertCreateModel, _callback, null);
        Type localVarReturnType = new TypeToken(){}.getType();
        localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
        return localVarCall;
    }

    @Deprecated
    public okhttp3.Call createAsync(AlipayOpenPublicAdvertCreateModel alipayOpenPublicAdvertCreateModel, final ApiCallback _callback, CustomizedParams customizedParams) throws ApiException {

        okhttp3.Call localVarCall = createValidateBeforeCall(alipayOpenPublicAdvertCreateModel, _callback, customizedParams);
        Type localVarReturnType = new TypeToken(){}.getType();
        localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
        return localVarCall;
    }
    /**
     * Build call for delete
     * @param advertId 待删除的广告位id (optional)
     * @param advertGroup 待删除的广告位分组标识 (optional)
     * @param _callback Callback for upload/download progress
     * @param customizedParams
     * @return Call to execute
     * @throws ApiException If fail to serialize the request body object
     * @http.response.details
     

        
 Status Code 
 Description 
 Response Headers 
        
 200 
 common response 
  -  
        
 0 
 请求失败 
  -  
     
     */
    public okhttp3.Call deleteCall(String advertId, String advertGroup, final ApiCallback _callback, CustomizedParams customizedParams) throws ApiException {
        String basePath = null;
        // Operation Servers
        String[] localBasePaths = new String[] {  };

        // Determine Base Path to Use
        if (localCustomBaseUrl != null){
            basePath = localCustomBaseUrl;
        } else if ( localBasePaths.length > 0 ) {
            basePath = localBasePaths[localHostIndex];
        } else {
            basePath = null;
        }

        Object localVarPostBody = null;

        // create path and map variables
        String localVarPath = "/v3/alipay/open/public/advert/delete";

        List localVarQueryParams = new ArrayList();
        List localVarCollectionQueryParams = new ArrayList();
        Map localVarHeaderParams = new HashMap();
        Map localVarCookieParams = new HashMap();
        Map localVarFormParams = new HashMap();

        if (advertId != null) {
            localVarQueryParams.addAll(localVarApiClient.parameterToPair("advert_id", advertId));
        }

        if (advertGroup != null) {
            localVarQueryParams.addAll(localVarApiClient.parameterToPair("advert_group", advertGroup));
        }

        final String[] localVarAccepts = {
            "application/json"
        };
        final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
        if (localVarAccept != null) {
            localVarHeaderParams.put("Accept", localVarAccept);
        }

        final String[] localVarContentTypes = {
            
        };
        final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
        if (localVarContentType != null) {
            localVarHeaderParams.put("Content-Type", localVarContentType);
        }

        if (customizedParams != null) {
            //额外query参数
            if (customizedParams.getQueryParams() != null && customizedParams.getQueryParams().size() > 0) {
                for (Map.Entry entry : customizedParams.getQueryParams().entrySet()) {
                    localVarQueryParams.addAll(localVarApiClient.parameterToPair(entry.getKey(), entry.getValue()));
                }
            }

            if (!Strings.isNullOrEmpty(customizedParams.getAppAuthToken())) {
                localVarHeaderParams.put("alipay-app-auth-token", customizedParams.getAppAuthToken());
            }

            //额外非全局header参数
            if (customizedParams.getHeaderParams() != null && customizedParams.getHeaderParams().size() > 0) {
                localVarHeaderParams.putAll(customizedParams.getHeaderParams());
            }
        }

        String[] localVarAuthNames = new String[] {  };
        return localVarApiClient.buildCall(basePath, localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
    }

    @SuppressWarnings("rawtypes")
    private okhttp3.Call deleteValidateBeforeCall(String advertId, String advertGroup, final ApiCallback _callback, CustomizedParams customizedParams) throws ApiException {
        

        okhttp3.Call localVarCall = deleteCall(advertId, advertGroup, _callback, customizedParams);
        return localVarCall;

    }

    /**
     * 生活号广告位删除接口
     * 可以通过此接口删除指定广告位的配置信息
     * @param advertId 待删除的广告位id (optional)
     * @param advertGroup 待删除的广告位分组标识 (optional)
     * @return Object
     * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
     * @http.response.details
     

        
 Status Code 
 Description 
 Response Headers 
        
 200 
 common response 
  -  
        
 0 
 请求失败 
  -  
     
     */
    public Object delete(String advertId, String advertGroup) throws ApiException {
        ApiResponse