com.criteo.marketing.api

Class AdvertiserApi

java.lang.Object

com.criteo.marketing.api.AdvertiserApi

public class AdvertiserApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
AdvertiserApi()
AdvertiserApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
GetPortfolioResponse	apiPortfolioGet() Use this call to fetch a list of all advertisers in your account.
okhttp3.Call	apiPortfolioGetAsync(ApiCallback<GetPortfolioResponse> _callback) (asynchronously) Use this call to fetch a list of all advertisers in your account.
okhttp3.Call	apiPortfolioGetCall(ApiCallback _callback) Build call for apiPortfolioGet
ApiResponse<GetPortfolioResponse>	apiPortfolioGetWithHttpInfo() Use this call to fetch a list of all advertisers in your account.
ApiClient	getApiClient()
java.util.List<CategoryMessage>	getCategories(java.lang.Integer advertiserId, java.lang.Boolean enabledOnly) Gets all advertiser's categories Get the list of all the categories linked to the requested advertiser.
okhttp3.Call	getCategoriesAsync(java.lang.Integer advertiserId, java.lang.Boolean enabledOnly, ApiCallback<java.util.List<CategoryMessage>> _callback) Gets all advertiser's categories (asynchronously) Get the list of all the categories linked to the requested advertiser.
okhttp3.Call	getCategoriesCall(java.lang.Integer advertiserId, java.lang.Boolean enabledOnly, ApiCallback _callback) Build call for getCategories
ApiResponse<java.util.List<CategoryMessage>>	getCategoriesWithHttpInfo(java.lang.Integer advertiserId, java.lang.Boolean enabledOnly) Gets all advertiser's categories Get the list of all the categories linked to the requested advertiser.
java.util.List<CategoryMessage>	getCategory(java.lang.Integer advertiserId, java.lang.Integer categoryHashCode) Gets a specific advertiser's category Get a specific category linked to the requested advertiser.
okhttp3.Call	getCategoryAsync(java.lang.Integer advertiserId, java.lang.Integer categoryHashCode, ApiCallback<java.util.List<CategoryMessage>> _callback) Gets a specific advertiser's category (asynchronously) Get a specific category linked to the requested advertiser.
okhttp3.Call	getCategoryCall(java.lang.Integer advertiserId, java.lang.Integer categoryHashCode, ApiCallback _callback) Build call for getCategory
ApiResponse<java.util.List<CategoryMessage>>	getCategoryWithHttpInfo(java.lang.Integer advertiserId, java.lang.Integer categoryHashCode) Gets a specific advertiser's category Get a specific category linked to the requested advertiser.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

AdvertiserApi

public AdvertiserApi()

AdvertiserApi

public AdvertiserApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

apiPortfolioGetCall

public okhttp3.Call apiPortfolioGetCall(ApiCallback _callback)
                                 throws ApiException

Build call for apiPortfolioGet

Parameters:

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Success	-
401	Unauthorized	-

apiPortfolioGet

public GetPortfolioResponse apiPortfolioGet()
                                     throws ApiException

Use this call to fetch a list of all advertisers in your account.

Returns:

GetPortfolioResponse

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	Success	-
401	Unauthorized	-

apiPortfolioGetWithHttpInfo

public ApiResponse<GetPortfolioResponse> apiPortfolioGetWithHttpInfo()
                                                              throws ApiException

Use this call to fetch a list of all advertisers in your account.

Returns:

ApiResponse<GetPortfolioResponse>

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	Success	-
401	Unauthorized	-

apiPortfolioGetAsync

public okhttp3.Call apiPortfolioGetAsync(ApiCallback<GetPortfolioResponse> _callback)
                                  throws ApiException

(asynchronously) Use this call to fetch a list of all advertisers in your account.

Parameters:

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

Returns:

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	Success	-
401	Unauthorized	-

getCategoriesCall

public okhttp3.Call getCategoriesCall(java.lang.Integer advertiserId,
                                      java.lang.Boolean enabledOnly,
                                      ApiCallback _callback)
                               throws ApiException

Build call for getCategories

Parameters:

advertiserId - Mandatory. The id of the advertiser to return. (required)

enabledOnly - Optional. Returns only categories you can bid on. Defaults to false. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Categories returned OK.	-
401	Authentication failed.	-
403	The requested advertiser is missing from current user’s portfolio.	-
429	Throttling failure. Maximum sending rate exceeded.	-
500	Unknown error.	-

getCategories

public java.util.List<CategoryMessage> getCategories(java.lang.Integer advertiserId,
                                                     java.lang.Boolean enabledOnly)
                                              throws ApiException

Gets all advertiser's categories Get the list of all the categories linked to the requested advertiser.

Parameters:

advertiserId - Mandatory. The id of the advertiser to return. (required)

enabledOnly - Optional. Returns only categories you can bid on. Defaults to false. (optional)

Returns:

List<CategoryMessage>

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	Categories returned OK.	-
401	Authentication failed.	-
403	The requested advertiser is missing from current user’s portfolio.	-
429	Throttling failure. Maximum sending rate exceeded.	-
500	Unknown error.	-

getCategoriesWithHttpInfo

public ApiResponse<java.util.List<CategoryMessage>> getCategoriesWithHttpInfo(java.lang.Integer advertiserId,
                                                                              java.lang.Boolean enabledOnly)
                                                                       throws ApiException

Gets all advertiser's categories Get the list of all the categories linked to the requested advertiser.

Parameters:

advertiserId - Mandatory. The id of the advertiser to return. (required)

enabledOnly - Optional. Returns only categories you can bid on. Defaults to false. (optional)

Returns:

ApiResponse<List<CategoryMessage>>

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	Categories returned OK.	-
401	Authentication failed.	-
403	The requested advertiser is missing from current user’s portfolio.	-
429	Throttling failure. Maximum sending rate exceeded.	-
500	Unknown error.	-

getCategoriesAsync

public okhttp3.Call getCategoriesAsync(java.lang.Integer advertiserId,
                                       java.lang.Boolean enabledOnly,
                                       ApiCallback<java.util.List<CategoryMessage>> _callback)
                                throws ApiException

Gets all advertiser's categories (asynchronously) Get the list of all the categories linked to the requested advertiser.

Parameters:

advertiserId - Mandatory. The id of the advertiser to return. (required)

enabledOnly - Optional. Returns only categories you can bid on. Defaults to false. (optional)

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

Returns:

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	Categories returned OK.	-
401	Authentication failed.	-
403	The requested advertiser is missing from current user’s portfolio.	-
429	Throttling failure. Maximum sending rate exceeded.	-
500	Unknown error.	-

getCategoryCall

public okhttp3.Call getCategoryCall(java.lang.Integer advertiserId,
                                    java.lang.Integer categoryHashCode,
                                    ApiCallback _callback)
                             throws ApiException

Build call for getCategory

Parameters:

advertiserId - Mandatory. The id of the advertiser to return. (required)

categoryHashCode - Mandatory. The id of the category to return. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Category returned OK.	-
401	Authentication failed.	-
403	The requested advertiser is missing from current user’s portfolio.	-
404	The requested category was not found for the advertiser.	-
429	Throttling failure. Maximum sending rate exceeded.	-
500	Unknown error.	-

getCategory

public java.util.List<CategoryMessage> getCategory(java.lang.Integer advertiserId,
                                                   java.lang.Integer categoryHashCode)
                                            throws ApiException

Gets a specific advertiser's category Get a specific category linked to the requested advertiser.

Parameters:

advertiserId - Mandatory. The id of the advertiser to return. (required)

categoryHashCode - Mandatory. The id of the category to return. (required)

Returns:

List<CategoryMessage>

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	Category returned OK.	-
401	Authentication failed.	-
403	The requested advertiser is missing from current user’s portfolio.	-
404	The requested category was not found for the advertiser.	-
429	Throttling failure. Maximum sending rate exceeded.	-
500	Unknown error.	-

getCategoryWithHttpInfo

public ApiResponse<java.util.List<CategoryMessage>> getCategoryWithHttpInfo(java.lang.Integer advertiserId,
                                                                            java.lang.Integer categoryHashCode)
                                                                     throws ApiException

Gets a specific advertiser's category Get a specific category linked to the requested advertiser.

Parameters:

advertiserId - Mandatory. The id of the advertiser to return. (required)

categoryHashCode - Mandatory. The id of the category to return. (required)

Returns:

ApiResponse<List<CategoryMessage>>

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	Category returned OK.	-
401	Authentication failed.	-
403	The requested advertiser is missing from current user’s portfolio.	-
404	The requested category was not found for the advertiser.	-
429	Throttling failure. Maximum sending rate exceeded.	-
500	Unknown error.	-

getCategoryAsync

public okhttp3.Call getCategoryAsync(java.lang.Integer advertiserId,
                                     java.lang.Integer categoryHashCode,
                                     ApiCallback<java.util.List<CategoryMessage>> _callback)
                              throws ApiException

Gets a specific advertiser's category (asynchronously) Get a specific category linked to the requested advertiser.

Parameters:

advertiserId - Mandatory. The id of the advertiser to return. (required)

categoryHashCode - Mandatory. The id of the category to return. (required)

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

Returns:

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	Category returned OK.	-
401	Authentication failed.	-
403	The requested advertiser is missing from current user’s portfolio.	-
404	The requested category was not found for the advertiser.	-
429	Throttling failure. Maximum sending rate exceeded.	-
500	Unknown error.	-