com.tencent.ads.api

类 OauthApi

java.lang.Object

com.tencent.ads.api.OauthApi

public class OauthApi
extends Object

构造器概要

构造器

构造器和说明
OauthApi()
OauthApi(ApiClient apiClient)

方法概要

限定符和类型	方法和说明
ApiClient	getApiClient()
String	oauthAuthorize(Long clientId, String redirectUri, String state, String scope, String accountType, Long accountDisplayNumber, List<String> fields) 获取Authorization Code
com.squareup.okhttp.Call	oauthAuthorizeAsync(Long clientId, String redirectUri, String state, String scope, String accountType, Long accountDisplayNumber, List<String> fields, ApiCallback<String> callback) 获取Authorization Code (asynchronously)
com.squareup.okhttp.Call	oauthAuthorizeCall(Long clientId, String redirectUri, String state, String scope, String accountType, Long accountDisplayNumber, List<String> fields, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for oauthAuthorize
ApiResponse<String>	oauthAuthorizeWithHttpInfo(Long clientId, String redirectUri, String state, String scope, String accountType, Long accountDisplayNumber, List<String> fields) 获取Authorization Code
OauthTokenResponse	oauthToken(Long clientId, String clientSecret, String grantType, String authorizationCode, String refreshToken, String redirectUri) 通过Authorization Code获取Access Token或刷新Access Token
com.squareup.okhttp.Call	oauthTokenAsync(Long clientId, String clientSecret, String grantType, String authorizationCode, String refreshToken, String redirectUri, ApiCallback<OauthTokenResponse> callback) 通过Authorization Code获取Access Token或刷新Access Token (asynchronously)
com.squareup.okhttp.Call	oauthTokenCall(Long clientId, String clientSecret, String grantType, String authorizationCode, String refreshToken, String redirectUri, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for oauthToken
ApiResponse<OauthTokenResponse>	oauthTokenWithHttpInfo(Long clientId, String clientSecret, String grantType, String authorizationCode, String refreshToken, String redirectUri) 通过Authorization Code获取Access Token或刷新Access Token
void	setApiClient(ApiClient apiClient)

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

OauthApi

public OauthApi()

OauthApi

public OauthApi(ApiClient apiClient)

方法详细资料

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

oauthAuthorizeCall

public com.squareup.okhttp.Call oauthAuthorizeCall(Long clientId,
                                                   String redirectUri,
                                                   String state,
                                                   String scope,
                                                   String accountType,
                                                   Long accountDisplayNumber,
                                                   List<String> fields,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for oauthAuthorize

参数:

clientId - (required)

redirectUri - (required)

state - (optional)

scope - (optional)

accountType - (optional)

accountDisplayNumber - (optional)

fields - 返回参数的字段列表 (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

返回:

Call to execute

抛出:

ApiException - If fail to serialize the request body object

oauthAuthorize

public String oauthAuthorize(Long clientId,
                             String redirectUri,
                             String state,
                             String scope,
                             String accountType,
                             Long accountDisplayNumber,
                             List<String> fields)
                      throws ApiException

获取Authorization Code

参数:

clientId - (required)

redirectUri - (required)

state - (optional)

scope - (optional)

accountType - (optional)

accountDisplayNumber - (optional)

fields - 返回参数的字段列表 (optional)

返回:

String

抛出:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

oauthAuthorizeWithHttpInfo

public ApiResponse<String> oauthAuthorizeWithHttpInfo(Long clientId,
                                                      String redirectUri,
                                                      String state,
                                                      String scope,
                                                      String accountType,
                                                      Long accountDisplayNumber,
                                                      List<String> fields)
                                               throws ApiException

获取Authorization Code

参数:

clientId - (required)

redirectUri - (required)

state - (optional)

scope - (optional)

accountType - (optional)

accountDisplayNumber - (optional)

fields - 返回参数的字段列表 (optional)

返回:

ApiResponse<String>

抛出:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

oauthAuthorizeAsync

public com.squareup.okhttp.Call oauthAuthorizeAsync(Long clientId,
                                                    String redirectUri,
                                                    String state,
                                                    String scope,
                                                    String accountType,
                                                    Long accountDisplayNumber,
                                                    List<String> fields,
                                                    ApiCallback<String> callback)
                                             throws ApiException

获取Authorization Code (asynchronously)

参数:

clientId - (required)

redirectUri - (required)

state - (optional)

scope - (optional)

accountType - (optional)

accountDisplayNumber - (optional)

fields - 返回参数的字段列表 (optional)

callback - The callback to be executed when the API call finishes

返回:

The request call

抛出:

ApiException - If fail to process the API call, e.g. serializing the request body object

oauthTokenCall

public com.squareup.okhttp.Call oauthTokenCall(Long clientId,
                                               String clientSecret,
                                               String grantType,
                                               String authorizationCode,
                                               String refreshToken,
                                               String redirectUri,
                                               ProgressResponseBody.ProgressListener progressListener,
                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                        throws ApiException

Build call for oauthToken

参数:

clientId - (required)

clientSecret - (required)

grantType - (required)

authorizationCode - (optional)

refreshToken - (optional)

redirectUri - 应用回调地址，当 grant_type=authorization_code时，redirect_uri 为必传参数，仅支持 http 和 https，不支持指定端口号，且传入的地址需要与获取authorization_code时，传入的回调地址保持一致 (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

返回:

Call to execute

抛出:

ApiException - If fail to serialize the request body object

oauthToken

public OauthTokenResponse oauthToken(Long clientId,
                                     String clientSecret,
                                     String grantType,
                                     String authorizationCode,
                                     String refreshToken,
                                     String redirectUri)
                              throws ApiException

通过Authorization Code获取Access Token或刷新Access Token

参数:

clientId - (required)

clientSecret - (required)

grantType - (required)

authorizationCode - (optional)

refreshToken - (optional)

redirectUri - 应用回调地址，当 grant_type=authorization_code时，redirect_uri 为必传参数，仅支持 http 和 https，不支持指定端口号，且传入的地址需要与获取authorization_code时，传入的回调地址保持一致 (optional)

返回:

OauthTokenResponse

抛出:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

oauthTokenWithHttpInfo

public ApiResponse<OauthTokenResponse> oauthTokenWithHttpInfo(Long clientId,
                                                              String clientSecret,
                                                              String grantType,
                                                              String authorizationCode,
                                                              String refreshToken,
                                                              String redirectUri)
                                                       throws ApiException

通过Authorization Code获取Access Token或刷新Access Token

参数:

clientId - (required)

clientSecret - (required)

grantType - (required)

authorizationCode - (optional)

refreshToken - (optional)

redirectUri - 应用回调地址，当 grant_type=authorization_code时，redirect_uri 为必传参数，仅支持 http 和 https，不支持指定端口号，且传入的地址需要与获取authorization_code时，传入的回调地址保持一致 (optional)

返回:

ApiResponse<OauthTokenResponse>

抛出:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

oauthTokenAsync

public com.squareup.okhttp.Call oauthTokenAsync(Long clientId,
                                                String clientSecret,
                                                String grantType,
                                                String authorizationCode,
                                                String refreshToken,
                                                String redirectUri,
                                                ApiCallback<OauthTokenResponse> callback)
                                         throws ApiException

通过Authorization Code获取Access Token或刷新Access Token (asynchronously)

参数:

clientId - (required)

clientSecret - (required)

grantType - (required)

authorizationCode - (optional)

refreshToken - (optional)

redirectUri - 应用回调地址，当 grant_type=authorization_code时，redirect_uri 为必传参数，仅支持 http 和 https，不支持指定端口号，且传入的地址需要与获取authorization_code时，传入的回调地址保持一致 (optional)

callback - The callback to be executed when the API call finishes

返回:

The request call

抛出:

ApiException - If fail to process the API call, e.g. serializing the request body object