com.criteo.marketing.api

Class CategoryApi

java.lang.Object

com.criteo.marketing.api.CategoryApi

public class CategoryApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
CategoryApi()
CategoryApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
java.util.List<CategoryMessage>	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	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	getCategoriesCall(java.lang.String campaignIds, java.lang.String advertiserIds, java.lang.String categoryHashCodes, java.lang.Boolean enabledOnly, ApiCallback _callback) Build call for getCategories
ApiResponse<java.util.List<CategoryMessage>>	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.
void	setApiClient(ApiClient apiClient)
java.util.List<CategoryUpdatesPerCatalog>	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	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	updateCategoriesCall(java.util.List<CategoryUpdatesPerCatalog> categoriesPerCatalog, ApiCallback _callback) Build call for updateCategories
ApiResponse<java.util.List<CategoryUpdatesPerCatalog>>	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.

Methods inherited from class java.lang.Object

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

Constructor Detail

CategoryApi

public CategoryApi()

CategoryApi

public CategoryApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getCategoriesCall

public okhttp3.Call getCategoriesCall(java.lang.String campaignIds,
                                      java.lang.String advertiserIds,
                                      java.lang.String categoryHashCodes,
                                      java.lang.Boolean enabledOnly,
                                      ApiCallback _callback)
                               throws ApiException

Build call for getCategories

Parameters:

campaignIds - Optional. One or more campaign ids, E.g., 78, 12932, 45236. If the campaign ids requested are not liked to advertisers in the user's portfolio, they will be skipped. (optional)

advertiserIds - Optional. One or more advertiser ids, E.g., 78, 12932, 45236. If the advertiser ids requested are not part of the user's portfolio, they will be skipped. (optional)

categoryHashCodes - Optional. One or more category hash codes. (optional)

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

getCategories

public java.util.List<CategoryMessage> getCategories(java.lang.String campaignIds,
                                                     java.lang.String advertiserIds,
                                                     java.lang.String categoryHashCodes,
                                                     java.lang.Boolean enabledOnly)
                                              throws ApiException

Gets categories Get the list of categories with the specified filters. If a category is requested but is missing from current user's portfolio, it will not be included in the list. If neither campaign ids nor advertisers ids are provided, then the user's portfolio will be used.

Parameters:

campaignIds - Optional. One or more campaign ids, E.g., 78, 12932, 45236. If the campaign ids requested are not liked to advertisers in the user's portfolio, they will be skipped. (optional)

advertiserIds - Optional. One or more advertiser ids, E.g., 78, 12932, 45236. If the advertiser ids requested are not part of the user's portfolio, they will be skipped. (optional)

categoryHashCodes - Optional. One or more category hash codes. (optional)

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

getCategoriesWithHttpInfo

public ApiResponse<java.util.List<CategoryMessage>> getCategoriesWithHttpInfo(java.lang.String campaignIds,
                                                                              java.lang.String advertiserIds,
                                                                              java.lang.String categoryHashCodes,
                                                                              java.lang.Boolean enabledOnly)
                                                                       throws ApiException

Gets categories Get the list of categories with the specified filters. If a category is requested but is missing from current user's portfolio, it will not be included in the list. If neither campaign ids nor advertisers ids are provided, then the user's portfolio will be used.

Parameters:

campaignIds - Optional. One or more campaign ids, E.g., 78, 12932, 45236. If the campaign ids requested are not liked to advertisers in the user's portfolio, they will be skipped. (optional)

advertiserIds - Optional. One or more advertiser ids, E.g., 78, 12932, 45236. If the advertiser ids requested are not part of the user's portfolio, they will be skipped. (optional)

categoryHashCodes - Optional. One or more category hash codes. (optional)

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

getCategoriesAsync

public okhttp3.Call getCategoriesAsync(java.lang.String campaignIds,
                                       java.lang.String advertiserIds,
                                       java.lang.String categoryHashCodes,
                                       java.lang.Boolean enabledOnly,
                                       ApiCallback<java.util.List<CategoryMessage>> _callback)
                                throws ApiException

Gets categories (asynchronously) Get the list of categories with the specified filters. If a category is requested but is missing from current user's portfolio, it will not be included in the list. If neither campaign ids nor advertisers ids are provided, then the user's portfolio will be used.

Parameters:

campaignIds - Optional. One or more campaign ids, E.g., 78, 12932, 45236. If the campaign ids requested are not liked to advertisers in the user's portfolio, they will be skipped. (optional)

advertiserIds - Optional. One or more advertiser ids, E.g., 78, 12932, 45236. If the advertiser ids requested are not part of the user's portfolio, they will be skipped. (optional)

categoryHashCodes - Optional. One or more category hash codes. (optional)

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

updateCategoriesCall

public okhttp3.Call updateCategoriesCall(java.util.List<CategoryUpdatesPerCatalog> categoriesPerCatalog,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for updateCategories

Parameters:

categoriesPerCatalog - The list of categories to be enabled/disabled, grouped by catalog. (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	Categories updated OK.	-
400	Invalid input. Please check returned message for details.	-
401	Authentication failed.	-
429	Throttling failure. Maximum sending rate exceeded.	-
500	Unknown error.	-

updateCategories

public java.util.List<CategoryUpdatesPerCatalog> updateCategories(java.util.List<CategoryUpdatesPerCatalog> categoriesPerCatalog)
                                                           throws ApiException

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. If the call is successful, full details about the changed categories will be returned.

Parameters:

categoriesPerCatalog - The list of categories to be enabled/disabled, grouped by catalog. (required)

Returns:

List<CategoryUpdatesPerCatalog>

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

updateCategoriesWithHttpInfo

public ApiResponse<java.util.List<CategoryUpdatesPerCatalog>> updateCategoriesWithHttpInfo(java.util.List<CategoryUpdatesPerCatalog> categoriesPerCatalog)
                                                                                    throws ApiException

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. If the call is successful, full details about the changed categories will be returned.

Parameters:

categoriesPerCatalog - The list of categories to be enabled/disabled, grouped by catalog. (required)

Returns:

ApiResponse<List<CategoryUpdatesPerCatalog>>

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

updateCategoriesAsync

public okhttp3.Call updateCategoriesAsync(java.util.List<CategoryUpdatesPerCatalog> categoriesPerCatalog,
                                          ApiCallback<java.util.List<CategoryUpdatesPerCatalog>> _callback)
                                   throws ApiException

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. If the call is successful, full details about the changed categories will be returned.

Parameters:

categoriesPerCatalog - The list of categories to be enabled/disabled, grouped by catalog. (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	Categories updated OK.	-
400	Invalid input. Please check returned message for details.	-
401	Authentication failed.	-
429	Throttling failure. Maximum sending rate exceeded.	-
500	Unknown error.	-