com.criteo.marketing.api

Class AnalyticsApi

java.lang.Object

com.criteo.marketing.api.AnalyticsApi

public class AnalyticsApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
AnalyticsApi()
AnalyticsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
byte[]	getAdsetReport(StatisticsReportQueryMessage statisticsReportQueryMessage) This Statistics endpoint provides adset related data.
okhttp3.Call	getAdsetReportAsync(StatisticsReportQueryMessage statisticsReportQueryMessage, ApiCallback<byte[]> _callback) (asynchronously) This Statistics endpoint provides adset related data.
okhttp3.Call	getAdsetReportCall(StatisticsReportQueryMessage statisticsReportQueryMessage, ApiCallback _callback) Build call for getAdsetReport
ApiResponse<byte[]>	getAdsetReportWithHttpInfo(StatisticsReportQueryMessage statisticsReportQueryMessage) This Statistics endpoint provides adset related data.
ApiClient	getApiClient()
byte[]	getTransactionsReport(TransactionsReportQueryDataMessage transactionsReportQueryDataMessage) This Transactions endpoint provides transactions id related data.
okhttp3.Call	getTransactionsReportAsync(TransactionsReportQueryDataMessage transactionsReportQueryDataMessage, ApiCallback<byte[]> _callback) (asynchronously) This Transactions endpoint provides transactions id related data.
okhttp3.Call	getTransactionsReportCall(TransactionsReportQueryDataMessage transactionsReportQueryDataMessage, ApiCallback _callback) Build call for getTransactionsReport
ApiResponse<byte[]>	getTransactionsReportWithHttpInfo(TransactionsReportQueryDataMessage transactionsReportQueryDataMessage) This Transactions endpoint provides transactions id related data.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

AnalyticsApi

public AnalyticsApi()

AnalyticsApi

public AnalyticsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getAdsetReportCall

public okhttp3.Call getAdsetReportCall(StatisticsReportQueryMessage statisticsReportQueryMessage,
                                       ApiCallback _callback)
                                throws ApiException

Build call for getAdsetReport

Parameters:

statisticsReportQueryMessage - (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	Success	-
400	Bad Request	-
403	Forbidden	-

getAdsetReport

public byte[] getAdsetReport(StatisticsReportQueryMessage statisticsReportQueryMessage)
                      throws ApiException

This Statistics endpoint provides adset related data. It is an upgrade of our previous Statistics endpoint, and includes new metrics and customization capabilities.

Parameters:

statisticsReportQueryMessage - (optional)

Returns:

byte[]

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Success	-
400	Bad Request	-
403	Forbidden	-

getAdsetReportWithHttpInfo

public ApiResponse<byte[]> getAdsetReportWithHttpInfo(StatisticsReportQueryMessage statisticsReportQueryMessage)
                                               throws ApiException

This Statistics endpoint provides adset related data. It is an upgrade of our previous Statistics endpoint, and includes new metrics and customization capabilities.

Parameters:

statisticsReportQueryMessage - (optional)

Returns:

ApiResponse<byte[]>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Success	-
400	Bad Request	-
403	Forbidden	-

getAdsetReportAsync

public okhttp3.Call getAdsetReportAsync(StatisticsReportQueryMessage statisticsReportQueryMessage,
                                        ApiCallback<byte[]> _callback)
                                 throws ApiException

(asynchronously) This Statistics endpoint provides adset related data. It is an upgrade of our previous Statistics endpoint, and includes new metrics and customization capabilities.

Parameters:

statisticsReportQueryMessage - (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	Success	-
400	Bad Request	-
403	Forbidden	-

getTransactionsReportCall

public okhttp3.Call getTransactionsReportCall(TransactionsReportQueryDataMessage transactionsReportQueryDataMessage,
                                              ApiCallback _callback)
                                       throws ApiException

Build call for getTransactionsReport

Parameters:

transactionsReportQueryDataMessage - (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	Success	-
400	Bad Request	-
403	Forbidden	-

getTransactionsReport

public byte[] getTransactionsReport(TransactionsReportQueryDataMessage transactionsReportQueryDataMessage)
                             throws ApiException

This Transactions endpoint provides transactions id related data.

Parameters:

transactionsReportQueryDataMessage - (optional)

Returns:

byte[]

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Success	-
400	Bad Request	-
403	Forbidden	-

getTransactionsReportWithHttpInfo

public ApiResponse<byte[]> getTransactionsReportWithHttpInfo(TransactionsReportQueryDataMessage transactionsReportQueryDataMessage)
                                                      throws ApiException

This Transactions endpoint provides transactions id related data.

Parameters:

transactionsReportQueryDataMessage - (optional)

Returns:

ApiResponse<byte[]>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Success	-
400	Bad Request	-
403	Forbidden	-

getTransactionsReportAsync

public okhttp3.Call getTransactionsReportAsync(TransactionsReportQueryDataMessage transactionsReportQueryDataMessage,
                                               ApiCallback<byte[]> _callback)
                                        throws ApiException

(asynchronously) This Transactions endpoint provides transactions id related data.

Parameters:

transactionsReportQueryDataMessage - (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	Success	-
400	Bad Request	-
403	Forbidden	-