com.criteo.marketing.api

Class CampaignApi

java.lang.Object

com.criteo.marketing.api.CampaignApi

public class CampaignApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
CampaignApi()
CampaignApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ResponseReadAdSet	getAdSet(java.lang.String adSetId) Get the data for the specified ad set
okhttp3.Call	getAdSetAsync(java.lang.String adSetId, ApiCallback<ResponseReadAdSet> _callback) (asynchronously) Get the data for the specified ad set
okhttp3.Call	getAdSetCall(java.lang.String adSetId, ApiCallback _callback) Build call for getAdSet
ApiResponse<ResponseReadAdSet>	getAdSetWithHttpInfo(java.lang.String adSetId) Get the data for the specified ad set
ApiClient	getApiClient()
java.util.List<CampaignBidMessage>	getBids(java.lang.String campaignIds, java.lang.String advertiserIds, java.lang.String categoryHashCodes, java.lang.String bidType, java.lang.String campaignStatus, java.lang.Boolean pendingChanges) Gets a the bids for campaigns and their categories Get the campaigns' bids, as well as the bids of their categories
okhttp3.Call	getBidsAsync(java.lang.String campaignIds, java.lang.String advertiserIds, java.lang.String categoryHashCodes, java.lang.String bidType, java.lang.String campaignStatus, java.lang.Boolean pendingChanges, ApiCallback<java.util.List<CampaignBidMessage>> _callback) Gets a the bids for campaigns and their categories (asynchronously) Get the campaigns' bids, as well as the bids of their categories
okhttp3.Call	getBidsCall(java.lang.String campaignIds, java.lang.String advertiserIds, java.lang.String categoryHashCodes, java.lang.String bidType, java.lang.String campaignStatus, java.lang.Boolean pendingChanges, ApiCallback _callback) Build call for getBids
ApiResponse<java.util.List<CampaignBidMessage>>	getBidsWithHttpInfo(java.lang.String campaignIds, java.lang.String advertiserIds, java.lang.String categoryHashCodes, java.lang.String bidType, java.lang.String campaignStatus, java.lang.Boolean pendingChanges) Gets a the bids for campaigns and their categories Get the campaigns' bids, as well as the bids of their categories
CategoryMessage	getCategories(java.lang.Integer campaignId, java.lang.Boolean enabledOnly) Gets categories Get the list of categories linked to the requested campaign.
okhttp3.Call	getCategoriesAsync(java.lang.Integer campaignId, java.lang.Boolean enabledOnly, ApiCallback<CategoryMessage> _callback) Gets categories (asynchronously) Get the list of categories linked to the requested campaign.
okhttp3.Call	getCategoriesCall(java.lang.Integer campaignId, java.lang.Boolean enabledOnly, ApiCallback _callback) Build call for getCategories
ApiResponse<CategoryMessage>	getCategoriesWithHttpInfo(java.lang.Integer campaignId, java.lang.Boolean enabledOnly) Gets categories Get the list of categories linked to the requested campaign.
CategoryMessage	getCategory(java.lang.Integer campaignId, java.lang.Integer categoryHashCode) Gets a specific category Get a specific category linked to the requested campaign.
okhttp3.Call	getCategoryAsync(java.lang.Integer campaignId, java.lang.Integer categoryHashCode, ApiCallback<CategoryMessage> _callback) Gets a specific category (asynchronously) Get a specific category linked to the requested campaign.
okhttp3.Call	getCategoryCall(java.lang.Integer campaignId, java.lang.Integer categoryHashCode, ApiCallback _callback) Build call for getCategory
ApiResponse<CategoryMessage>	getCategoryWithHttpInfo(java.lang.Integer campaignId, java.lang.Integer categoryHashCode) Gets a specific category Get a specific category linked to the requested campaign.
ResponseAdSetId	patchAdSets(RequestsPatchAdSet requestsPatchAdSet) Patch a list of AdSets.
okhttp3.Call	patchAdSetsAsync(RequestsPatchAdSet requestsPatchAdSet, ApiCallback<ResponseAdSetId> _callback) (asynchronously) Patch a list of AdSets.
okhttp3.Call	patchAdSetsCall(RequestsPatchAdSet requestsPatchAdSet, ApiCallback _callback) Build call for patchAdSets
ApiResponse<ResponseAdSetId>	patchAdSetsWithHttpInfo(RequestsPatchAdSet requestsPatchAdSet) Patch a list of AdSets.
ResponsesReadAdSet	searchAdSets(RequestAdSetSearch requestAdSetSearch) Search for ad sets
okhttp3.Call	searchAdSetsAsync(RequestAdSetSearch requestAdSetSearch, ApiCallback<ResponsesReadAdSet> _callback) (asynchronously) Search for ad sets
okhttp3.Call	searchAdSetsCall(RequestAdSetSearch requestAdSetSearch, ApiCallback _callback) Build call for searchAdSets
ApiResponse<ResponsesReadAdSet>	searchAdSetsWithHttpInfo(RequestAdSetSearch requestAdSetSearch) Search for ad sets
void	setApiClient(ApiClient apiClient)
ResponsesAdSetId	startAdSets(RequestsAdSetId requestsAdSetId) Start the specified list of ad sets
okhttp3.Call	startAdSetsAsync(RequestsAdSetId requestsAdSetId, ApiCallback<ResponsesAdSetId> _callback) (asynchronously) Start the specified list of ad sets
okhttp3.Call	startAdSetsCall(RequestsAdSetId requestsAdSetId, ApiCallback _callback) Build call for startAdSets
ApiResponse<ResponsesAdSetId>	startAdSetsWithHttpInfo(RequestsAdSetId requestsAdSetId) Start the specified list of ad sets
ResponsesAdSetId	stopAdSets(RequestsAdSetId requestsAdSetId) Stop the specified list of ad sets
okhttp3.Call	stopAdSetsAsync(RequestsAdSetId requestsAdSetId, ApiCallback<ResponsesAdSetId> _callback) (asynchronously) Stop the specified list of ad sets
okhttp3.Call	stopAdSetsCall(RequestsAdSetId requestsAdSetId, ApiCallback _callback) Build call for stopAdSets
ApiResponse<ResponsesAdSetId>	stopAdSetsWithHttpInfo(RequestsAdSetId requestsAdSetId) Stop the specified list of ad sets
java.util.List<CampaignMessage>	updateBids(java.util.List<CampaignBidChangeRequest> bidChanges) Update bids for campaigns and their categories If a campaign bid is updated, all (if any) category bids for this campaign will be updated with the new value if they are initially equal to the campaign bid.
okhttp3.Call	updateBidsAsync(java.util.List<CampaignBidChangeRequest> bidChanges, ApiCallback<java.util.List<CampaignMessage>> _callback) Update bids for campaigns and their categories (asynchronously) If a campaign bid is updated, all (if any) category bids for this campaign will be updated with the new value if they are initially equal to the campaign bid.
okhttp3.Call	updateBidsCall(java.util.List<CampaignBidChangeRequest> bidChanges, ApiCallback _callback) Build call for updateBids
ApiResponse<java.util.List<CampaignMessage>>	updateBidsWithHttpInfo(java.util.List<CampaignBidChangeRequest> bidChanges) Update bids for campaigns and their categories If a campaign bid is updated, all (if any) category bids for this campaign will be updated with the new value if they are initially equal to the campaign bid.

Methods inherited from class java.lang.Object

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

Constructor Detail

CampaignApi

public CampaignApi()

CampaignApi

public CampaignApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getAdSetCall

public okhttp3.Call getAdSetCall(java.lang.String adSetId,
                                 ApiCallback _callback)
                          throws ApiException

Build call for getAdSet

Parameters:

adSetId - Id of the ad set (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	data for the ad set	-
401	The API client is not properly authenticated.	-
403	The API client is not authorized to access this resource or the resource does not exist.	-

getAdSet

public ResponseReadAdSet getAdSet(java.lang.String adSetId)
                           throws ApiException

Get the data for the specified ad set

Parameters:

adSetId - Id of the ad set (required)

Returns:

ResponseReadAdSet

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	data for the ad set	-
401	The API client is not properly authenticated.	-
403	The API client is not authorized to access this resource or the resource does not exist.	-

getAdSetWithHttpInfo

public ApiResponse<ResponseReadAdSet> getAdSetWithHttpInfo(java.lang.String adSetId)
                                                    throws ApiException

Get the data for the specified ad set

Parameters:

adSetId - Id of the ad set (required)

Returns:

ApiResponse<ResponseReadAdSet>

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	data for the ad set	-
401	The API client is not properly authenticated.	-
403	The API client is not authorized to access this resource or the resource does not exist.	-

getAdSetAsync

public okhttp3.Call getAdSetAsync(java.lang.String adSetId,
                                  ApiCallback<ResponseReadAdSet> _callback)
                           throws ApiException

(asynchronously) Get the data for the specified ad set

Parameters:

adSetId - Id of the ad set (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	data for the ad set	-
401	The API client is not properly authenticated.	-
403	The API client is not authorized to access this resource or the resource does not exist.	-

getBidsCall

public okhttp3.Call getBidsCall(java.lang.String campaignIds,
                                java.lang.String advertiserIds,
                                java.lang.String categoryHashCodes,
                                java.lang.String bidType,
                                java.lang.String campaignStatus,
                                java.lang.Boolean pendingChanges,
                                ApiCallback _callback)
                         throws ApiException

Build call for getBids

Parameters:

campaignIds - Optional. The ids of the campaigns we want to get the bids on. If not specified, advertiserIds will be used. (optional)

advertiserIds - Optional. The ids of the advertisers' campaigns we want to get the bids on. If campaignIds not specified, and neither is advertiserIds, all the advertisers in the user's portfolio are used. (optional)

categoryHashCodes - Optional. Filters only specified categories. By default no filtering is applied. (optional)

bidType - Optional. Filters by bid type. By default no filtering is applied. (optional)

campaignStatus - Optional. Filters by campaign status. By default no filtering is applied. (optional)

pendingChanges - Optional. Filters only pending changes or settled ones. By default no filtering is applied. (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	Bids returned OK.	-
401	Authentication failed.	-
403	There is not even one valid advertiserId or campaignId requested.	-
429	Throttling failure. Maximum sending rate exceeded.	-
500	Unknown error.	-

getBids

public java.util.List<CampaignBidMessage> getBids(java.lang.String campaignIds,
                                                  java.lang.String advertiserIds,
                                                  java.lang.String categoryHashCodes,
                                                  java.lang.String bidType,
                                                  java.lang.String campaignStatus,
                                                  java.lang.Boolean pendingChanges)
                                           throws ApiException

Gets a the bids for campaigns and their categories Get the campaigns' bids, as well as the bids of their categories

Parameters:

campaignIds - Optional. The ids of the campaigns we want to get the bids on. If not specified, advertiserIds will be used. (optional)

advertiserIds - Optional. The ids of the advertisers' campaigns we want to get the bids on. If campaignIds not specified, and neither is advertiserIds, all the advertisers in the user's portfolio are used. (optional)

categoryHashCodes - Optional. Filters only specified categories. By default no filtering is applied. (optional)

bidType - Optional. Filters by bid type. By default no filtering is applied. (optional)

campaignStatus - Optional. Filters by campaign status. By default no filtering is applied. (optional)

pendingChanges - Optional. Filters only pending changes or settled ones. By default no filtering is applied. (optional)

Returns:

List<CampaignBidMessage>

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	Bids returned OK.	-
401	Authentication failed.	-
403	There is not even one valid advertiserId or campaignId requested.	-
429	Throttling failure. Maximum sending rate exceeded.	-
500	Unknown error.	-

getBidsWithHttpInfo

public ApiResponse<java.util.List<CampaignBidMessage>> getBidsWithHttpInfo(java.lang.String campaignIds,
                                                                           java.lang.String advertiserIds,
                                                                           java.lang.String categoryHashCodes,
                                                                           java.lang.String bidType,
                                                                           java.lang.String campaignStatus,
                                                                           java.lang.Boolean pendingChanges)
                                                                    throws ApiException

Gets a the bids for campaigns and their categories Get the campaigns' bids, as well as the bids of their categories

Parameters:

campaignIds - Optional. The ids of the campaigns we want to get the bids on. If not specified, advertiserIds will be used. (optional)

advertiserIds - Optional. The ids of the advertisers' campaigns we want to get the bids on. If campaignIds not specified, and neither is advertiserIds, all the advertisers in the user's portfolio are used. (optional)

categoryHashCodes - Optional. Filters only specified categories. By default no filtering is applied. (optional)

bidType - Optional. Filters by bid type. By default no filtering is applied. (optional)

campaignStatus - Optional. Filters by campaign status. By default no filtering is applied. (optional)

pendingChanges - Optional. Filters only pending changes or settled ones. By default no filtering is applied. (optional)

Returns:

ApiResponse<List<CampaignBidMessage>>

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	Bids returned OK.	-
401	Authentication failed.	-
403	There is not even one valid advertiserId or campaignId requested.	-
429	Throttling failure. Maximum sending rate exceeded.	-
500	Unknown error.	-

getBidsAsync

public okhttp3.Call getBidsAsync(java.lang.String campaignIds,
                                 java.lang.String advertiserIds,
                                 java.lang.String categoryHashCodes,
                                 java.lang.String bidType,
                                 java.lang.String campaignStatus,
                                 java.lang.Boolean pendingChanges,
                                 ApiCallback<java.util.List<CampaignBidMessage>> _callback)
                          throws ApiException

Gets a the bids for campaigns and their categories (asynchronously) Get the campaigns' bids, as well as the bids of their categories

Parameters:

campaignIds - Optional. The ids of the campaigns we want to get the bids on. If not specified, advertiserIds will be used. (optional)

advertiserIds - Optional. The ids of the advertisers' campaigns we want to get the bids on. If campaignIds not specified, and neither is advertiserIds, all the advertisers in the user's portfolio are used. (optional)

categoryHashCodes - Optional. Filters only specified categories. By default no filtering is applied. (optional)

bidType - Optional. Filters by bid type. By default no filtering is applied. (optional)

campaignStatus - Optional. Filters by campaign status. By default no filtering is applied. (optional)

pendingChanges - Optional. Filters only pending changes or settled ones. By default no filtering is applied. (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	Bids returned OK.	-
401	Authentication failed.	-
403	There is not even one valid advertiserId or campaignId requested.	-
429	Throttling failure. Maximum sending rate exceeded.	-
500	Unknown error.	-

getCategoriesCall

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

Build call for getCategories

Parameters:

campaignId - Mandatory. The id of the campaign the categories are linked to. (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	One of the requested campaigns doesn't belong to the API user's portfolio which prevents from accessing its data.	-
404	The requested campaign was not found.	-
429	Throttling failure. Maximum sending rate exceeded.	-
500	Unknown error.	-

getCategories

public CategoryMessage getCategories(java.lang.Integer campaignId,
                                     java.lang.Boolean enabledOnly)
                              throws ApiException

Gets categories Get the list of categories linked to the requested campaign.

Parameters:

campaignId - Mandatory. The id of the campaign the categories are linked to. (required)

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

Returns:

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	One of the requested campaigns doesn't belong to the API user's portfolio which prevents from accessing its data.	-
404	The requested campaign was not found.	-
429	Throttling failure. Maximum sending rate exceeded.	-
500	Unknown error.	-

getCategoriesWithHttpInfo

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

Gets categories Get the list of categories linked to the requested campaign.

Parameters:

campaignId - Mandatory. The id of the campaign the categories are linked to. (required)

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

Returns:

ApiResponse<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	One of the requested campaigns doesn't belong to the API user's portfolio which prevents from accessing its data.	-
404	The requested campaign was not found.	-
429	Throttling failure. Maximum sending rate exceeded.	-
500	Unknown error.	-

getCategoriesAsync

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

Gets categories (asynchronously) Get the list of categories linked to the requested campaign.

Parameters:

campaignId - Mandatory. The id of the campaign the categories are linked to. (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	One of the requested campaigns doesn't belong to the API user's portfolio which prevents from accessing its data.	-
404	The requested campaign was not found.	-
429	Throttling failure. Maximum sending rate exceeded.	-
500	Unknown error.	-

getCategoryCall

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

Build call for getCategory

Parameters:

campaignId - Mandatory. The id of the campaign the categories are linked to. (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	One of the requested campaigns doesn't belong to the API user's portfolio which prevents from accessing its data.	-
404	The requested category was not found for the campaign.	-
429	Throttling failure. Maximum sending rate exceeded.	-
500	Unknown error.	-

getCategory

public CategoryMessage getCategory(java.lang.Integer campaignId,
                                   java.lang.Integer categoryHashCode)
                            throws ApiException

Gets a specific category Get a specific category linked to the requested campaign.

Parameters:

campaignId - Mandatory. The id of the campaign the categories are linked to. (required)

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

Returns:

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	One of the requested campaigns doesn't belong to the API user's portfolio which prevents from accessing its data.	-
404	The requested category was not found for the campaign.	-
429	Throttling failure. Maximum sending rate exceeded.	-
500	Unknown error.	-

getCategoryWithHttpInfo

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

Gets a specific category Get a specific category linked to the requested campaign.

Parameters:

campaignId - Mandatory. The id of the campaign the categories are linked to. (required)

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

Returns:

ApiResponse<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	One of the requested campaigns doesn't belong to the API user's portfolio which prevents from accessing its data.	-
404	The requested category was not found for the campaign.	-
429	Throttling failure. Maximum sending rate exceeded.	-
500	Unknown error.	-

getCategoryAsync

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

Gets a specific category (asynchronously) Get a specific category linked to the requested campaign.

Parameters:

campaignId - Mandatory. The id of the campaign the categories are linked to. (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	One of the requested campaigns doesn't belong to the API user's portfolio which prevents from accessing its data.	-
404	The requested category was not found for the campaign.	-
429	Throttling failure. Maximum sending rate exceeded.	-
500	Unknown error.	-

patchAdSetsCall

public okhttp3.Call patchAdSetsCall(RequestsPatchAdSet requestsPatchAdSet,
                                    ApiCallback _callback)
                             throws ApiException

Build call for patchAdSets

Parameters:

requestsPatchAdSet - List of adsets to patch. (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	List of patched adSets.	-
401	The API client is not properly authenticated.	-
403	The API client is not authorized to access this resource or the resource does not exist.	-

patchAdSets

public ResponseAdSetId patchAdSets(RequestsPatchAdSet requestsPatchAdSet)
                            throws ApiException

Patch a list of AdSets.

Parameters:

requestsPatchAdSet - List of adsets to patch. (optional)

Returns:

ResponseAdSetId

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	List of patched adSets.	-
401	The API client is not properly authenticated.	-
403	The API client is not authorized to access this resource or the resource does not exist.	-

patchAdSetsWithHttpInfo

public ApiResponse<ResponseAdSetId> patchAdSetsWithHttpInfo(RequestsPatchAdSet requestsPatchAdSet)
                                                     throws ApiException

Patch a list of AdSets.

Parameters:

requestsPatchAdSet - List of adsets to patch. (optional)

Returns:

ApiResponse<ResponseAdSetId>

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	List of patched adSets.	-
401	The API client is not properly authenticated.	-
403	The API client is not authorized to access this resource or the resource does not exist.	-

patchAdSetsAsync

public okhttp3.Call patchAdSetsAsync(RequestsPatchAdSet requestsPatchAdSet,
                                     ApiCallback<ResponseAdSetId> _callback)
                              throws ApiException

(asynchronously) Patch a list of AdSets.

Parameters:

requestsPatchAdSet - List of adsets to patch. (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	List of patched adSets.	-
401	The API client is not properly authenticated.	-
403	The API client is not authorized to access this resource or the resource does not exist.	-

searchAdSetsCall

public okhttp3.Call searchAdSetsCall(RequestAdSetSearch requestAdSetSearch,
                                     ApiCallback _callback)
                              throws ApiException

Build call for searchAdSets

Parameters:

requestAdSetSearch - (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	data for the ad sets	-
400	Bad Request	-
401	The API client is not properly authenticated.	-
403	Forbidden	-

searchAdSets

public ResponsesReadAdSet searchAdSets(RequestAdSetSearch requestAdSetSearch)
                                throws ApiException

Search for ad sets

Parameters:

requestAdSetSearch - (optional)

Returns:

ResponsesReadAdSet

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	data for the ad sets	-
400	Bad Request	-
401	The API client is not properly authenticated.	-
403	Forbidden	-

searchAdSetsWithHttpInfo

public ApiResponse<ResponsesReadAdSet> searchAdSetsWithHttpInfo(RequestAdSetSearch requestAdSetSearch)
                                                         throws ApiException

Search for ad sets

Parameters:

requestAdSetSearch - (optional)

Returns:

ApiResponse<ResponsesReadAdSet>

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	data for the ad sets	-
400	Bad Request	-
401	The API client is not properly authenticated.	-
403	Forbidden	-

searchAdSetsAsync

public okhttp3.Call searchAdSetsAsync(RequestAdSetSearch requestAdSetSearch,
                                      ApiCallback<ResponsesReadAdSet> _callback)
                               throws ApiException

(asynchronously) Search for ad sets

Parameters:

requestAdSetSearch - (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	data for the ad sets	-
400	Bad Request	-
401	The API client is not properly authenticated.	-
403	Forbidden	-

startAdSetsCall

public okhttp3.Call startAdSetsCall(RequestsAdSetId requestsAdSetId,
                                    ApiCallback _callback)
                             throws ApiException

Build call for startAdSets

Parameters:

requestsAdSetId - All the ad sets to start (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	List of ad sets that have been started and errors / warnings by ad set	-
400	Bad Request	-
401	The API client is not properly authenticated.	-

startAdSets

public ResponsesAdSetId startAdSets(RequestsAdSetId requestsAdSetId)
                             throws ApiException

Start the specified list of ad sets

Parameters:

requestsAdSetId - All the ad sets to start (optional)

Returns:

ResponsesAdSetId

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	List of ad sets that have been started and errors / warnings by ad set	-
400	Bad Request	-
401	The API client is not properly authenticated.	-

startAdSetsWithHttpInfo

public ApiResponse<ResponsesAdSetId> startAdSetsWithHttpInfo(RequestsAdSetId requestsAdSetId)
                                                      throws ApiException

Start the specified list of ad sets

Parameters:

requestsAdSetId - All the ad sets to start (optional)

Returns:

ApiResponse<ResponsesAdSetId>

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	List of ad sets that have been started and errors / warnings by ad set	-
400	Bad Request	-
401	The API client is not properly authenticated.	-

startAdSetsAsync

public okhttp3.Call startAdSetsAsync(RequestsAdSetId requestsAdSetId,
                                     ApiCallback<ResponsesAdSetId> _callback)
                              throws ApiException

(asynchronously) Start the specified list of ad sets

Parameters:

requestsAdSetId - All the ad sets to start (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	List of ad sets that have been started and errors / warnings by ad set	-
400	Bad Request	-
401	The API client is not properly authenticated.	-

stopAdSetsCall

public okhttp3.Call stopAdSetsCall(RequestsAdSetId requestsAdSetId,
                                   ApiCallback _callback)
                            throws ApiException

Build call for stopAdSets

Parameters:

requestsAdSetId - All the ad sets to stop (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	List of ad sets that have been stopped and errors / warnings by ad set	-
400	Bad Request	-
401	The API client is not properly authenticated.	-

stopAdSets

public ResponsesAdSetId stopAdSets(RequestsAdSetId requestsAdSetId)
                            throws ApiException

Stop the specified list of ad sets

Parameters:

requestsAdSetId - All the ad sets to stop (optional)

Returns:

ResponsesAdSetId

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	List of ad sets that have been stopped and errors / warnings by ad set	-
400	Bad Request	-
401	The API client is not properly authenticated.	-

stopAdSetsWithHttpInfo

public ApiResponse<ResponsesAdSetId> stopAdSetsWithHttpInfo(RequestsAdSetId requestsAdSetId)
                                                     throws ApiException

Stop the specified list of ad sets

Parameters:

requestsAdSetId - All the ad sets to stop (optional)

Returns:

ApiResponse<ResponsesAdSetId>

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	List of ad sets that have been stopped and errors / warnings by ad set	-
400	Bad Request	-
401	The API client is not properly authenticated.	-

stopAdSetsAsync

public okhttp3.Call stopAdSetsAsync(RequestsAdSetId requestsAdSetId,
                                    ApiCallback<ResponsesAdSetId> _callback)
                             throws ApiException

(asynchronously) Stop the specified list of ad sets

Parameters:

requestsAdSetId - All the ad sets to stop (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	List of ad sets that have been stopped and errors / warnings by ad set	-
400	Bad Request	-
401	The API client is not properly authenticated.	-

updateBidsCall

public okhttp3.Call updateBidsCall(java.util.List<CampaignBidChangeRequest> bidChanges,
                                   ApiCallback _callback)
                            throws ApiException

Build call for updateBids

Parameters:

bidChanges - Specifies the list of bid changes to be applied. (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	Campaign bids updated OK.	-
400	Invalid input. Please check returned message for details.	-
401	Authentication failed.	-
429	Throttling failure. Maximum sending rate exceeded.	-
500	Unknown error.	-

updateBids

public java.util.List<CampaignMessage> updateBids(java.util.List<CampaignBidChangeRequest> bidChanges)
                                           throws ApiException

Update bids for campaigns and their categories If a campaign bid is updated, all (if any) category bids for this campaign will be updated with the new value if they are initially equal to the campaign bid. If the category bid is not wanted to be cascaded to the categories with the same bid value, new change bids must be added in the request for the categories where the value should be kept (with the initial value).

Parameters:

bidChanges - Specifies the list of bid changes to be applied. (required)

Returns:

List<CampaignMessage>

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	Campaign bids updated OK.	-
400	Invalid input. Please check returned message for details.	-
401	Authentication failed.	-
429	Throttling failure. Maximum sending rate exceeded.	-
500	Unknown error.	-

updateBidsWithHttpInfo

public ApiResponse<java.util.List<CampaignMessage>> updateBidsWithHttpInfo(java.util.List<CampaignBidChangeRequest> bidChanges)
                                                                    throws ApiException

Update bids for campaigns and their categories If a campaign bid is updated, all (if any) category bids for this campaign will be updated with the new value if they are initially equal to the campaign bid. If the category bid is not wanted to be cascaded to the categories with the same bid value, new change bids must be added in the request for the categories where the value should be kept (with the initial value).

Parameters:

bidChanges - Specifies the list of bid changes to be applied. (required)

Returns:

ApiResponse<List<CampaignMessage>>

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	Campaign bids updated OK.	-
400	Invalid input. Please check returned message for details.	-
401	Authentication failed.	-
429	Throttling failure. Maximum sending rate exceeded.	-
500	Unknown error.	-

updateBidsAsync

public okhttp3.Call updateBidsAsync(java.util.List<CampaignBidChangeRequest> bidChanges,
                                    ApiCallback<java.util.List<CampaignMessage>> _callback)
                             throws ApiException

Update bids for campaigns and their categories (asynchronously) If a campaign bid is updated, all (if any) category bids for this campaign will be updated with the new value if they are initially equal to the campaign bid. If the category bid is not wanted to be cascaded to the categories with the same bid value, new change bids must be added in the request for the categories where the value should be kept (with the initial value).

Parameters:

bidChanges - Specifies the list of bid changes to be applied. (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	Campaign bids updated OK.	-
400	Invalid input. Please check returned message for details.	-
401	Authentication failed.	-
429	Throttling failure. Maximum sending rate exceeded.	-
500	Unknown error.	-