com.criteo.marketing.api

Class AudienceApi

java.lang.Object

com.criteo.marketing.api.AudienceApi

public class AudienceApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
AudienceApi()
AudienceApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
NewAudienceResponse	createAudience(NewAudienceRequest newAudienceRequest) Create an Audience for an Advertiser
okhttp3.Call	createAudienceAsync(NewAudienceRequest newAudienceRequest, ApiCallback<NewAudienceResponse> _callback) (asynchronously) Create an Audience for an Advertiser
okhttp3.Call	createAudienceCall(NewAudienceRequest newAudienceRequest, ApiCallback _callback) Build call for createAudience
ApiResponse<NewAudienceResponse>	createAudienceWithHttpInfo(NewAudienceRequest newAudienceRequest) Create an Audience for an Advertiser
DeleteAudienceContactListResponse	deleteIdentifiers(java.lang.String audienceId) delete all identifiers from an Audience
okhttp3.Call	deleteIdentifiersAsync(java.lang.String audienceId, ApiCallback<DeleteAudienceContactListResponse> _callback) (asynchronously) delete all identifiers from an Audience
okhttp3.Call	deleteIdentifiersCall(java.lang.String audienceId, ApiCallback _callback) Build call for deleteIdentifiers
ApiResponse<DeleteAudienceContactListResponse>	deleteIdentifiersWithHttpInfo(java.lang.String audienceId) delete all identifiers from an Audience
ApiClient	getApiClient()
GetAudiencesResponse	getAudiences(java.lang.String advertiserId) Get a list of all the audiences for the user or for the given advertiser_id
okhttp3.Call	getAudiencesAsync(java.lang.String advertiserId, ApiCallback<GetAudiencesResponse> _callback) (asynchronously) Get a list of all the audiences for the user or for the given advertiser_id
okhttp3.Call	getAudiencesCall(java.lang.String advertiserId, ApiCallback _callback) Build call for getAudiences
ApiResponse<GetAudiencesResponse>	getAudiencesWithHttpInfo(java.lang.String advertiserId) Get a list of all the audiences for the user or for the given advertiser_id
ReplaceAudienceResponse	modifyAudience(java.lang.String audienceId, ReplaceAudienceRequest replaceAudienceRequest) Update user audience specified by the audience id
okhttp3.Call	modifyAudienceAsync(java.lang.String audienceId, ReplaceAudienceRequest replaceAudienceRequest, ApiCallback<ReplaceAudienceResponse> _callback) (asynchronously) Update user audience specified by the audience id
okhttp3.Call	modifyAudienceCall(java.lang.String audienceId, ReplaceAudienceRequest replaceAudienceRequest, ApiCallback _callback) Build call for modifyAudience
ModifyAudienceResponse	modifyAudienceUsers(java.lang.String audienceId, ContactlistAmendmentRequest contactlistAmendmentRequest) Add/remove users to or from an audience
okhttp3.Call	modifyAudienceUsersAsync(java.lang.String audienceId, ContactlistAmendmentRequest contactlistAmendmentRequest, ApiCallback<ModifyAudienceResponse> _callback) (asynchronously) Add/remove users to or from an audience
okhttp3.Call	modifyAudienceUsersCall(java.lang.String audienceId, ContactlistAmendmentRequest contactlistAmendmentRequest, ApiCallback _callback) Build call for modifyAudienceUsers
ApiResponse<ModifyAudienceResponse>	modifyAudienceUsersWithHttpInfo(java.lang.String audienceId, ContactlistAmendmentRequest contactlistAmendmentRequest) Add/remove users to or from an audience
ApiResponse<ReplaceAudienceResponse>	modifyAudienceWithHttpInfo(java.lang.String audienceId, ReplaceAudienceRequest replaceAudienceRequest) Update user audience specified by the audience id
DeleteAudienceResponse	removeAudience(java.lang.String audienceId) Delete an audience by id
okhttp3.Call	removeAudienceAsync(java.lang.String audienceId, ApiCallback<DeleteAudienceResponse> _callback) (asynchronously) Delete an audience by id
okhttp3.Call	removeAudienceCall(java.lang.String audienceId, ApiCallback _callback) Build call for removeAudience
ApiResponse<DeleteAudienceResponse>	removeAudienceWithHttpInfo(java.lang.String audienceId) Delete an audience by id
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

AudienceApi

public AudienceApi()

AudienceApi

public AudienceApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createAudienceCall

public okhttp3.Call createAudienceCall(NewAudienceRequest newAudienceRequest,
                                       ApiCallback _callback)
                                throws ApiException

Build call for createAudience

Parameters:

newAudienceRequest - (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	The audience was created	-
403	Forbidden	-

createAudience

public NewAudienceResponse createAudience(NewAudienceRequest newAudienceRequest)
                                   throws ApiException

Create an Audience for an Advertiser

Parameters:

newAudienceRequest - (required)

Returns:

NewAudienceResponse

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	The audience was created	-
403	Forbidden	-

createAudienceWithHttpInfo

public ApiResponse<NewAudienceResponse> createAudienceWithHttpInfo(NewAudienceRequest newAudienceRequest)
                                                            throws ApiException

Create an Audience for an Advertiser

Parameters:

newAudienceRequest - (required)

Returns:

ApiResponse<NewAudienceResponse>

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	The audience was created	-
403	Forbidden	-

createAudienceAsync

public okhttp3.Call createAudienceAsync(NewAudienceRequest newAudienceRequest,
                                        ApiCallback<NewAudienceResponse> _callback)
                                 throws ApiException

(asynchronously) Create an Audience for an Advertiser

Parameters:

newAudienceRequest - (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	The audience was created	-
403	Forbidden	-

deleteIdentifiersCall

public okhttp3.Call deleteIdentifiersCall(java.lang.String audienceId,
                                          ApiCallback _callback)
                                   throws ApiException

Build call for deleteIdentifiers

Parameters:

audienceId - The id of the audience to amend (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	The contactlist was deleted	-
403	Forbidden	-

deleteIdentifiers

public DeleteAudienceContactListResponse deleteIdentifiers(java.lang.String audienceId)
                                                    throws ApiException

delete all identifiers from an Audience

Parameters:

audienceId - The id of the audience to amend (required)

Returns:

DeleteAudienceContactListResponse

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	The contactlist was deleted	-
403	Forbidden	-

deleteIdentifiersWithHttpInfo

public ApiResponse<DeleteAudienceContactListResponse> deleteIdentifiersWithHttpInfo(java.lang.String audienceId)
                                                                             throws ApiException

delete all identifiers from an Audience

Parameters:

audienceId - The id of the audience to amend (required)

Returns:

ApiResponse<DeleteAudienceContactListResponse>

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	The contactlist was deleted	-
403	Forbidden	-

deleteIdentifiersAsync

public okhttp3.Call deleteIdentifiersAsync(java.lang.String audienceId,
                                           ApiCallback<DeleteAudienceContactListResponse> _callback)
                                    throws ApiException

(asynchronously) delete all identifiers from an Audience

Parameters:

audienceId - The id of the audience to amend (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	The contactlist was deleted	-
403	Forbidden	-

getAudiencesCall

public okhttp3.Call getAudiencesCall(java.lang.String advertiserId,
                                     ApiCallback _callback)
                              throws ApiException

Build call for getAudiences

Parameters:

advertiserId - The advertiser id to get all the audiences for. Mandatory for internal users. For external users, if you don't provide it, we will take into account the advertisers from your portfolio (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	The list was retrieved.	-
403	Forbidden	-

getAudiences

public GetAudiencesResponse getAudiences(java.lang.String advertiserId)
                                  throws ApiException

Get a list of all the audiences for the user or for the given advertiser_id

Parameters:

advertiserId - The advertiser id to get all the audiences for. Mandatory for internal users. For external users, if you don't provide it, we will take into account the advertisers from your portfolio (optional)

Returns:

GetAudiencesResponse

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	The list was retrieved.	-
403	Forbidden	-

getAudiencesWithHttpInfo

public ApiResponse<GetAudiencesResponse> getAudiencesWithHttpInfo(java.lang.String advertiserId)
                                                           throws ApiException

Get a list of all the audiences for the user or for the given advertiser_id

Parameters:

advertiserId - The advertiser id to get all the audiences for. Mandatory for internal users. For external users, if you don't provide it, we will take into account the advertisers from your portfolio (optional)

Returns:

ApiResponse<GetAudiencesResponse>

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	The list was retrieved.	-
403	Forbidden	-

getAudiencesAsync

public okhttp3.Call getAudiencesAsync(java.lang.String advertiserId,
                                      ApiCallback<GetAudiencesResponse> _callback)
                               throws ApiException

(asynchronously) Get a list of all the audiences for the user or for the given advertiser_id

Parameters:

advertiserId - The advertiser id to get all the audiences for. Mandatory for internal users. For external users, if you don't provide it, we will take into account the advertisers from your portfolio (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	The list was retrieved.	-
403	Forbidden	-

modifyAudienceCall

public okhttp3.Call modifyAudienceCall(java.lang.String audienceId,
                                       ReplaceAudienceRequest replaceAudienceRequest,
                                       ApiCallback _callback)
                                throws ApiException

Build call for modifyAudience

Parameters:

audienceId - The id of the audience to amend (required)

replaceAudienceRequest - (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	The audience was updated	-
403	Forbidden	-

modifyAudience

public ReplaceAudienceResponse modifyAudience(java.lang.String audienceId,
                                              ReplaceAudienceRequest replaceAudienceRequest)
                                       throws ApiException

Update user audience specified by the audience id

Parameters:

audienceId - The id of the audience to amend (required)

replaceAudienceRequest - (required)

Returns:

ReplaceAudienceResponse

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	The audience was updated	-
403	Forbidden	-

modifyAudienceWithHttpInfo

public ApiResponse<ReplaceAudienceResponse> modifyAudienceWithHttpInfo(java.lang.String audienceId,
                                                                       ReplaceAudienceRequest replaceAudienceRequest)
                                                                throws ApiException

Update user audience specified by the audience id

Parameters:

audienceId - The id of the audience to amend (required)

replaceAudienceRequest - (required)

Returns:

ApiResponse<ReplaceAudienceResponse>

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	The audience was updated	-
403	Forbidden	-

modifyAudienceAsync

public okhttp3.Call modifyAudienceAsync(java.lang.String audienceId,
                                        ReplaceAudienceRequest replaceAudienceRequest,
                                        ApiCallback<ReplaceAudienceResponse> _callback)
                                 throws ApiException

(asynchronously) Update user audience specified by the audience id

Parameters:

audienceId - The id of the audience to amend (required)

replaceAudienceRequest - (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	The audience was updated	-
403	Forbidden	-

modifyAudienceUsersCall

public okhttp3.Call modifyAudienceUsersCall(java.lang.String audienceId,
                                            ContactlistAmendmentRequest contactlistAmendmentRequest,
                                            ApiCallback _callback)
                                     throws ApiException

Build call for modifyAudienceUsers

Parameters:

audienceId - The id of the audience to amend (required)

contactlistAmendmentRequest - (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	Summary of created request	-
403	Forbidden	-
404	Audience 123 not found	-

modifyAudienceUsers

public ModifyAudienceResponse modifyAudienceUsers(java.lang.String audienceId,
                                                  ContactlistAmendmentRequest contactlistAmendmentRequest)
                                           throws ApiException

Add/remove users to or from an audience

Parameters:

audienceId - The id of the audience to amend (required)

contactlistAmendmentRequest - (required)

Returns:

ModifyAudienceResponse

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	Summary of created request	-
403	Forbidden	-
404	Audience 123 not found	-

modifyAudienceUsersWithHttpInfo

public ApiResponse<ModifyAudienceResponse> modifyAudienceUsersWithHttpInfo(java.lang.String audienceId,
                                                                           ContactlistAmendmentRequest contactlistAmendmentRequest)
                                                                    throws ApiException

Add/remove users to or from an audience

Parameters:

audienceId - The id of the audience to amend (required)

contactlistAmendmentRequest - (required)

Returns:

ApiResponse<ModifyAudienceResponse>

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	Summary of created request	-
403	Forbidden	-
404	Audience 123 not found	-

modifyAudienceUsersAsync

public okhttp3.Call modifyAudienceUsersAsync(java.lang.String audienceId,
                                             ContactlistAmendmentRequest contactlistAmendmentRequest,
                                             ApiCallback<ModifyAudienceResponse> _callback)
                                      throws ApiException

(asynchronously) Add/remove users to or from an audience

Parameters:

audienceId - The id of the audience to amend (required)

contactlistAmendmentRequest - (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	Summary of created request	-
403	Forbidden	-
404	Audience 123 not found	-

removeAudienceCall

public okhttp3.Call removeAudienceCall(java.lang.String audienceId,
                                       ApiCallback _callback)
                                throws ApiException

Build call for removeAudience

Parameters:

audienceId - The id of the audience to amend (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	The audience was deleted	-
403	Forbidden	-

removeAudience

public DeleteAudienceResponse removeAudience(java.lang.String audienceId)
                                      throws ApiException

Delete an audience by id

Parameters:

audienceId - The id of the audience to amend (required)

Returns:

DeleteAudienceResponse

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	The audience was deleted	-
403	Forbidden	-

removeAudienceWithHttpInfo

public ApiResponse<DeleteAudienceResponse> removeAudienceWithHttpInfo(java.lang.String audienceId)
                                                               throws ApiException

Delete an audience by id

Parameters:

audienceId - The id of the audience to amend (required)

Returns:

ApiResponse<DeleteAudienceResponse>

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	The audience was deleted	-
403	Forbidden	-

removeAudienceAsync

public okhttp3.Call removeAudienceAsync(java.lang.String audienceId,
                                        ApiCallback<DeleteAudienceResponse> _callback)
                                 throws ApiException

(asynchronously) Delete an audience by id

Parameters:

audienceId - The id of the audience to amend (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	The audience was deleted	-
403	Forbidden	-