| Package | Description |
|---|---|
| com.criteo.marketing | |
| com.criteo.marketing.api |
| Modifier and Type | Method and Description |
|---|---|
void |
ApiCallback.onFailure(ApiException e,
int statusCode,
java.util.Map<java.lang.String,java.util.List<java.lang.String>> responseHeaders)
This is called when the API call fails.
|
| Modifier and Type | Method and Description |
|---|---|
okhttp3.Call |
ApiClient.buildCall(java.lang.String path,
java.lang.String method,
java.util.List<Pair> queryParams,
java.util.List<Pair> collectionQueryParams,
java.lang.Object body,
java.util.Map<java.lang.String,java.lang.String> headerParams,
java.util.Map<java.lang.String,java.lang.Object> formParams,
java.lang.String[] authNames,
ApiCallback callback)
Build HTTP call with the given options.
|
okhttp3.Request |
ApiClient.buildRequest(java.lang.String path,
java.lang.String method,
java.util.List<Pair> queryParams,
java.util.List<Pair> collectionQueryParams,
java.lang.Object body,
java.util.Map<java.lang.String,java.lang.String> headerParams,
java.util.Map<java.lang.String,java.lang.Object> formParams,
java.lang.String[] authNames,
ApiCallback callback)
Build an HTTP request with the given options.
|
<T> T |
ApiClient.deserialize(okhttp3.Response response,
java.lang.reflect.Type returnType)
Deserialize response body to Java object, according to the return type and
the Content-Type response header.
|
java.io.File |
ApiClient.downloadFileFromResponse(okhttp3.Response response)
Download file from the given response.
|
<T> ApiResponse<T> |
ApiClient.execute(okhttp3.Call call)
|
<T> ApiResponse<T> |
ApiClient.execute(okhttp3.Call call,
java.lang.reflect.Type returnType)
Execute HTTP call and deserialize the HTTP response body into the given return type.
|
<T> T |
ApiClient.handleResponse(okhttp3.Response response,
java.lang.reflect.Type returnType)
Handle the given response, return the deserialized object when the response is successful.
|
okhttp3.RequestBody |
ApiClient.serialize(java.lang.Object obj,
java.lang.String contentType)
Serialize the given Java object into request body according to the object's
class and the request Content-Type.
|
| Modifier and Type | Method and Description |
|---|---|
GetPortfolioResponse |
AdvertiserApi.apiPortfolioGet()
Use this call to fetch a list of all advertisers in your account.
|
okhttp3.Call |
AdvertiserApi.apiPortfolioGetAsync(ApiCallback<GetPortfolioResponse> _callback)
(asynchronously)
Use this call to fetch a list of all advertisers in your account.
|
okhttp3.Call |
AdvertiserApi.apiPortfolioGetCall(ApiCallback _callback)
Build call for apiPortfolioGet
|
ApiResponse<GetPortfolioResponse> |
AdvertiserApi.apiPortfolioGetWithHttpInfo()
Use this call to fetch a list of all advertisers in your account.
|
NewAudienceResponse |
AudienceApi.createAudience(NewAudienceRequest newAudienceRequest)
Create an Audience for an Advertiser
|
okhttp3.Call |
AudienceApi.createAudienceAsync(NewAudienceRequest newAudienceRequest,
ApiCallback<NewAudienceResponse> _callback)
(asynchronously)
Create an Audience for an Advertiser
|
okhttp3.Call |
AudienceApi.createAudienceCall(NewAudienceRequest newAudienceRequest,
ApiCallback _callback)
Build call for createAudience
|
ApiResponse<NewAudienceResponse> |
AudienceApi.createAudienceWithHttpInfo(NewAudienceRequest newAudienceRequest)
Create an Audience for an Advertiser
|
JwtModel |
OAuthApi.createToken(java.lang.String clientId,
java.lang.String clientSecret,
java.lang.String grantType)
Creates a token when the supplied client credentials are valid
|
okhttp3.Call |
OAuthApi.createTokenAsync(java.lang.String clientId,
java.lang.String clientSecret,
java.lang.String grantType,
ApiCallback<JwtModel> _callback)
(asynchronously)
Creates a token when the supplied client credentials are valid
|
okhttp3.Call |
OAuthApi.createTokenCall(java.lang.String clientId,
java.lang.String clientSecret,
java.lang.String grantType,
ApiCallback _callback)
Build call for createToken
|
ApiResponse<JwtModel> |
OAuthApi.createTokenWithHttpInfo(java.lang.String clientId,
java.lang.String clientSecret,
java.lang.String grantType)
Creates a token when the supplied client credentials are valid
|
DeleteAudienceContactListResponse |
AudienceApi.deleteIdentifiers(java.lang.String audienceId)
delete all identifiers from an Audience
|
okhttp3.Call |
AudienceApi.deleteIdentifiersAsync(java.lang.String audienceId,
ApiCallback<DeleteAudienceContactListResponse> _callback)
(asynchronously)
delete all identifiers from an Audience
|
okhttp3.Call |
AudienceApi.deleteIdentifiersCall(java.lang.String audienceId,
ApiCallback _callback)
Build call for deleteIdentifiers
|
ApiResponse<DeleteAudienceContactListResponse> |
AudienceApi.deleteIdentifiersWithHttpInfo(java.lang.String audienceId)
delete all identifiers from an Audience
|
ResponseReadAdSet |
CampaignApi.getAdSet(java.lang.String adSetId)
Get the data for the specified ad set
|
okhttp3.Call |
CampaignApi.getAdSetAsync(java.lang.String adSetId,
ApiCallback<ResponseReadAdSet> _callback)
(asynchronously)
Get the data for the specified ad set
|
okhttp3.Call |
CampaignApi.getAdSetCall(java.lang.String adSetId,
ApiCallback _callback)
Build call for getAdSet
|
byte[] |
AnalyticsApi.getAdsetReport(StatisticsReportQueryMessage statisticsReportQueryMessage)
This Statistics endpoint provides adset related data.
|
okhttp3.Call |
AnalyticsApi.getAdsetReportAsync(StatisticsReportQueryMessage statisticsReportQueryMessage,
ApiCallback<byte[]> _callback)
(asynchronously)
This Statistics endpoint provides adset related data.
|
okhttp3.Call |
AnalyticsApi.getAdsetReportCall(StatisticsReportQueryMessage statisticsReportQueryMessage,
ApiCallback _callback)
Build call for getAdsetReport
|
ApiResponse<byte[]> |
AnalyticsApi.getAdsetReportWithHttpInfo(StatisticsReportQueryMessage statisticsReportQueryMessage)
This Statistics endpoint provides adset related data.
|
ApiResponse<ResponseReadAdSet> |
CampaignApi.getAdSetWithHttpInfo(java.lang.String adSetId)
Get the data for the specified ad set
|
GetAudiencesResponse |
AudienceApi.getAudiences(java.lang.String advertiserId)
Get a list of all the audiences for the user or for the given advertiser_id
|
okhttp3.Call |
AudienceApi.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 |
AudienceApi.getAudiencesCall(java.lang.String advertiserId,
ApiCallback _callback)
Build call for getAudiences
|
ApiResponse<GetAudiencesResponse> |
AudienceApi.getAudiencesWithHttpInfo(java.lang.String advertiserId)
Get a list of all the audiences for the user or for the given advertiser_id
|
java.util.List<CampaignBidMessage> |
CampaignApi.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 |
CampaignApi.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 |
CampaignApi.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>> |
CampaignApi.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 |
CampaignApi.getCategories(java.lang.Integer campaignId,
java.lang.Boolean enabledOnly)
Gets categories
Get the list of categories linked to the requested campaign.
|
java.util.List<CategoryMessage> |
AdvertiserApi.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.
|
java.util.List<CategoryMessage> |
CategoryApi.getCategories(java.lang.String campaignIds,
java.lang.String advertiserIds,
java.lang.String categoryHashCodes,
java.lang.Boolean enabledOnly)
Gets categories
Get the list of categories with the specified filters.
|
okhttp3.Call |
CampaignApi.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 |
AdvertiserApi.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 |
CategoryApi.getCategoriesAsync(java.lang.String campaignIds,
java.lang.String advertiserIds,
java.lang.String categoryHashCodes,
java.lang.Boolean enabledOnly,
ApiCallback<java.util.List<CategoryMessage>> _callback)
Gets categories (asynchronously)
Get the list of categories with the specified filters.
|
okhttp3.Call |
CampaignApi.getCategoriesCall(java.lang.Integer campaignId,
java.lang.Boolean enabledOnly,
ApiCallback _callback)
Build call for getCategories
|
okhttp3.Call |
AdvertiserApi.getCategoriesCall(java.lang.Integer advertiserId,
java.lang.Boolean enabledOnly,
ApiCallback _callback)
Build call for getCategories
|
okhttp3.Call |
CategoryApi.getCategoriesCall(java.lang.String campaignIds,
java.lang.String advertiserIds,
java.lang.String categoryHashCodes,
java.lang.Boolean enabledOnly,
ApiCallback _callback)
Build call for getCategories
|
ApiResponse<CategoryMessage> |
CampaignApi.getCategoriesWithHttpInfo(java.lang.Integer campaignId,
java.lang.Boolean enabledOnly)
Gets categories
Get the list of categories linked to the requested campaign.
|
ApiResponse<java.util.List<CategoryMessage>> |
AdvertiserApi.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.
|
ApiResponse<java.util.List<CategoryMessage>> |
CategoryApi.getCategoriesWithHttpInfo(java.lang.String campaignIds,
java.lang.String advertiserIds,
java.lang.String categoryHashCodes,
java.lang.Boolean enabledOnly)
Gets categories
Get the list of categories with the specified filters.
|
CategoryMessage |
CampaignApi.getCategory(java.lang.Integer campaignId,
java.lang.Integer categoryHashCode)
Gets a specific category
Get a specific category linked to the requested campaign.
|
java.util.List<CategoryMessage> |
AdvertiserApi.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 |
CampaignApi.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 |
AdvertiserApi.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 |
CampaignApi.getCategoryCall(java.lang.Integer campaignId,
java.lang.Integer categoryHashCode,
ApiCallback _callback)
Build call for getCategory
|
okhttp3.Call |
AdvertiserApi.getCategoryCall(java.lang.Integer advertiserId,
java.lang.Integer categoryHashCode,
ApiCallback _callback)
Build call for getCategory
|
ApiResponse<CategoryMessage> |
CampaignApi.getCategoryWithHttpInfo(java.lang.Integer campaignId,
java.lang.Integer categoryHashCode)
Gets a specific category
Get a specific category linked to the requested campaign.
|
ApiResponse<java.util.List<CategoryMessage>> |
AdvertiserApi.getCategoryWithHttpInfo(java.lang.Integer advertiserId,
java.lang.Integer categoryHashCode)
Gets a specific advertiser's category
Get a specific category linked to the requested advertiser.
|
byte[] |
AnalyticsApi.getTransactionsReport(TransactionsReportQueryDataMessage transactionsReportQueryDataMessage)
This Transactions endpoint provides transactions id related data.
|
okhttp3.Call |
AnalyticsApi.getTransactionsReportAsync(TransactionsReportQueryDataMessage transactionsReportQueryDataMessage,
ApiCallback<byte[]> _callback)
(asynchronously)
This Transactions endpoint provides transactions id related data.
|
okhttp3.Call |
AnalyticsApi.getTransactionsReportCall(TransactionsReportQueryDataMessage transactionsReportQueryDataMessage,
ApiCallback _callback)
Build call for getTransactionsReport
|
ApiResponse<byte[]> |
AnalyticsApi.getTransactionsReportWithHttpInfo(TransactionsReportQueryDataMessage transactionsReportQueryDataMessage)
This Transactions endpoint provides transactions id related data.
|
ReplaceAudienceResponse |
AudienceApi.modifyAudience(java.lang.String audienceId,
ReplaceAudienceRequest replaceAudienceRequest)
Update user audience specified by the audience id
|
okhttp3.Call |
AudienceApi.modifyAudienceAsync(java.lang.String audienceId,
ReplaceAudienceRequest replaceAudienceRequest,
ApiCallback<ReplaceAudienceResponse> _callback)
(asynchronously)
Update user audience specified by the audience id
|
okhttp3.Call |
AudienceApi.modifyAudienceCall(java.lang.String audienceId,
ReplaceAudienceRequest replaceAudienceRequest,
ApiCallback _callback)
Build call for modifyAudience
|
ModifyAudienceResponse |
AudienceApi.modifyAudienceUsers(java.lang.String audienceId,
ContactlistAmendmentRequest contactlistAmendmentRequest)
Add/remove users to or from an audience
|
okhttp3.Call |
AudienceApi.modifyAudienceUsersAsync(java.lang.String audienceId,
ContactlistAmendmentRequest contactlistAmendmentRequest,
ApiCallback<ModifyAudienceResponse> _callback)
(asynchronously)
Add/remove users to or from an audience
|
okhttp3.Call |
AudienceApi.modifyAudienceUsersCall(java.lang.String audienceId,
ContactlistAmendmentRequest contactlistAmendmentRequest,
ApiCallback _callback)
Build call for modifyAudienceUsers
|
ApiResponse<ModifyAudienceResponse> |
AudienceApi.modifyAudienceUsersWithHttpInfo(java.lang.String audienceId,
ContactlistAmendmentRequest contactlistAmendmentRequest)
Add/remove users to or from an audience
|
ApiResponse<ReplaceAudienceResponse> |
AudienceApi.modifyAudienceWithHttpInfo(java.lang.String audienceId,
ReplaceAudienceRequest replaceAudienceRequest)
Update user audience specified by the audience id
|
ResponseAdSetId |
CampaignApi.patchAdSets(RequestsPatchAdSet requestsPatchAdSet)
Patch a list of AdSets.
|
okhttp3.Call |
CampaignApi.patchAdSetsAsync(RequestsPatchAdSet requestsPatchAdSet,
ApiCallback<ResponseAdSetId> _callback)
(asynchronously)
Patch a list of AdSets.
|
okhttp3.Call |
CampaignApi.patchAdSetsCall(RequestsPatchAdSet requestsPatchAdSet,
ApiCallback _callback)
Build call for patchAdSets
|
ApiResponse<ResponseAdSetId> |
CampaignApi.patchAdSetsWithHttpInfo(RequestsPatchAdSet requestsPatchAdSet)
Patch a list of AdSets.
|
DeleteAudienceResponse |
AudienceApi.removeAudience(java.lang.String audienceId)
Delete an audience by id
|
okhttp3.Call |
AudienceApi.removeAudienceAsync(java.lang.String audienceId,
ApiCallback<DeleteAudienceResponse> _callback)
(asynchronously)
Delete an audience by id
|
okhttp3.Call |
AudienceApi.removeAudienceCall(java.lang.String audienceId,
ApiCallback _callback)
Build call for removeAudience
|
ApiResponse<DeleteAudienceResponse> |
AudienceApi.removeAudienceWithHttpInfo(java.lang.String audienceId)
Delete an audience by id
|
ResponsesReadAdSet |
CampaignApi.searchAdSets(RequestAdSetSearch requestAdSetSearch)
Search for ad sets
|
okhttp3.Call |
CampaignApi.searchAdSetsAsync(RequestAdSetSearch requestAdSetSearch,
ApiCallback<ResponsesReadAdSet> _callback)
(asynchronously)
Search for ad sets
|
okhttp3.Call |
CampaignApi.searchAdSetsCall(RequestAdSetSearch requestAdSetSearch,
ApiCallback _callback)
Build call for searchAdSets
|
ApiResponse<ResponsesReadAdSet> |
CampaignApi.searchAdSetsWithHttpInfo(RequestAdSetSearch requestAdSetSearch)
Search for ad sets
|
ResponsesAdSetId |
CampaignApi.startAdSets(RequestsAdSetId requestsAdSetId)
Start the specified list of ad sets
|
okhttp3.Call |
CampaignApi.startAdSetsAsync(RequestsAdSetId requestsAdSetId,
ApiCallback<ResponsesAdSetId> _callback)
(asynchronously)
Start the specified list of ad sets
|
okhttp3.Call |
CampaignApi.startAdSetsCall(RequestsAdSetId requestsAdSetId,
ApiCallback _callback)
Build call for startAdSets
|
ApiResponse<ResponsesAdSetId> |
CampaignApi.startAdSetsWithHttpInfo(RequestsAdSetId requestsAdSetId)
Start the specified list of ad sets
|
ResponsesAdSetId |
CampaignApi.stopAdSets(RequestsAdSetId requestsAdSetId)
Stop the specified list of ad sets
|
okhttp3.Call |
CampaignApi.stopAdSetsAsync(RequestsAdSetId requestsAdSetId,
ApiCallback<ResponsesAdSetId> _callback)
(asynchronously)
Stop the specified list of ad sets
|
okhttp3.Call |
CampaignApi.stopAdSetsCall(RequestsAdSetId requestsAdSetId,
ApiCallback _callback)
Build call for stopAdSets
|
ApiResponse<ResponsesAdSetId> |
CampaignApi.stopAdSetsWithHttpInfo(RequestsAdSetId requestsAdSetId)
Stop the specified list of ad sets
|
java.util.List<CampaignMessage> |
CampaignApi.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 |
CampaignApi.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 |
CampaignApi.updateBidsCall(java.util.List<CampaignBidChangeRequest> bidChanges,
ApiCallback _callback)
Build call for updateBids
|
ApiResponse<java.util.List<CampaignMessage>> |
CampaignApi.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.
|
java.util.List<CategoryUpdatesPerCatalog> |
CategoryApi.updateCategories(java.util.List<CategoryUpdatesPerCatalog> categoriesPerCatalog)
Enables/disables categories
Update categories for multiple catalogs.<br /> Please note that all validations need to pass before applying the requested changes; the subsequent validation error messages will be returned in the response.<br /> Please note that bidding will still happen for disabled categories, but using the Camapign's bid.
|
okhttp3.Call |
CategoryApi.updateCategoriesAsync(java.util.List<CategoryUpdatesPerCatalog> categoriesPerCatalog,
ApiCallback<java.util.List<CategoryUpdatesPerCatalog>> _callback)
Enables/disables categories (asynchronously)
Update categories for multiple catalogs.<br /> Please note that all validations need to pass before applying the requested changes; the subsequent validation error messages will be returned in the response.<br /> Please note that bidding will still happen for disabled categories, but using the Camapign's bid.
|
okhttp3.Call |
CategoryApi.updateCategoriesCall(java.util.List<CategoryUpdatesPerCatalog> categoriesPerCatalog,
ApiCallback _callback)
Build call for updateCategories
|
ApiResponse<java.util.List<CategoryUpdatesPerCatalog>> |
CategoryApi.updateCategoriesWithHttpInfo(java.util.List<CategoryUpdatesPerCatalog> categoriesPerCatalog)
Enables/disables categories
Update categories for multiple catalogs.<br /> Please note that all validations need to pass before applying the requested changes; the subsequent validation error messages will be returned in the response.<br /> Please note that bidding will still happen for disabled categories, but using the Camapign's bid.
|
Copyright © 2021. All rights reserved.