com.criteo.marketing.model

Class TransactionsReportQueryMessage

java.lang.Object

com.criteo.marketing.model.TransactionsReportQueryMessage

public class TransactionsReportQueryMessage
extends java.lang.Object

This is the message defining the query for Transaction report

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SERIALIZED_NAME_ADVERTISER_IDS
static java.lang.String	SERIALIZED_NAME_CURRENCY
static java.lang.String	SERIALIZED_NAME_END_DATE
static java.lang.String	SERIALIZED_NAME_EVENT_TYPE
static java.lang.String	SERIALIZED_NAME_FORMAT
static java.lang.String	SERIALIZED_NAME_START_DATE
static java.lang.String	SERIALIZED_NAME_TIMEZONE

Constructor Summary

Constructors

Constructor and Description
TransactionsReportQueryMessage()

Method Summary

Modifier and Type	Method and Description
TransactionsReportQueryMessage	advertiserIds(java.lang.String advertiserIds)
TransactionsReportQueryMessage	currency(java.lang.String currency)
TransactionsReportQueryMessage	endDate(java.time.OffsetDateTime endDate)
boolean	equals(java.lang.Object o)
TransactionsReportQueryMessage	eventType(java.lang.String eventType)
TransactionsReportQueryMessage	format(java.lang.String format)
java.lang.String	getAdvertiserIds() The comma-separated list of advertiser ids.
java.lang.String	getCurrency() The currency used for the report.
java.time.OffsetDateTime	getEndDate() End date of the report.
java.lang.String	getEventType() Apply a filter on Event type .
java.lang.String	getFormat() The file format of the generated report: csv, xml, excel or json.
java.time.OffsetDateTime	getStartDate() Start date of the report.
java.lang.String	getTimezone() The timezone used for the report.
int	hashCode()
void	setAdvertiserIds(java.lang.String advertiserIds)
void	setCurrency(java.lang.String currency)
void	setEndDate(java.time.OffsetDateTime endDate)
void	setEventType(java.lang.String eventType)
void	setFormat(java.lang.String format)
void	setStartDate(java.time.OffsetDateTime startDate)
void	setTimezone(java.lang.String timezone)
TransactionsReportQueryMessage	startDate(java.time.OffsetDateTime startDate)
TransactionsReportQueryMessage	timezone(java.lang.String timezone)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_ADVERTISER_IDS

public static final java.lang.String SERIALIZED_NAME_ADVERTISER_IDS

See Also:

Constant Field Values

SERIALIZED_NAME_EVENT_TYPE

public static final java.lang.String SERIALIZED_NAME_EVENT_TYPE

See Also:

Constant Field Values

SERIALIZED_NAME_CURRENCY

public static final java.lang.String SERIALIZED_NAME_CURRENCY

See Also:

Constant Field Values

SERIALIZED_NAME_FORMAT

public static final java.lang.String SERIALIZED_NAME_FORMAT

See Also:

Constant Field Values

SERIALIZED_NAME_TIMEZONE

public static final java.lang.String SERIALIZED_NAME_TIMEZONE

See Also:

Constant Field Values

SERIALIZED_NAME_START_DATE

public static final java.lang.String SERIALIZED_NAME_START_DATE

See Also:

Constant Field Values

SERIALIZED_NAME_END_DATE

public static final java.lang.String SERIALIZED_NAME_END_DATE

See Also:

Constant Field Values

Constructor Detail

TransactionsReportQueryMessage

public TransactionsReportQueryMessage()

Method Detail

advertiserIds

public TransactionsReportQueryMessage advertiserIds(java.lang.String advertiserIds)

getAdvertiserIds

@Nullable
public java.lang.String getAdvertiserIds()

The comma-separated list of advertiser ids. If empty, all the advertisers in the portfolio will be used

Returns:

advertiserIds

setAdvertiserIds

public void setAdvertiserIds(java.lang.String advertiserIds)

eventType

public TransactionsReportQueryMessage eventType(java.lang.String eventType)

getEventType

@Nullable
public java.lang.String getEventType()

Apply a filter on Event type .

Returns:

eventType

setEventType

public void setEventType(java.lang.String eventType)

currency

public TransactionsReportQueryMessage currency(java.lang.String currency)

getCurrency

public java.lang.String getCurrency()

The currency used for the report. ISO 4217 code (three-letter capitals).

Returns:

currency

setCurrency

public void setCurrency(java.lang.String currency)

format

public TransactionsReportQueryMessage format(java.lang.String format)

getFormat

public java.lang.String getFormat()

The file format of the generated report: csv, xml, excel or json.

Returns:

format

setFormat

public void setFormat(java.lang.String format)

timezone

public TransactionsReportQueryMessage timezone(java.lang.String timezone)

getTimezone

@Nullable
public java.lang.String getTimezone()

The timezone used for the report. Timezone Database format (Tz).

Returns:

timezone

setTimezone

public void setTimezone(java.lang.String timezone)

startDate

public TransactionsReportQueryMessage startDate(java.time.OffsetDateTime startDate)

getStartDate

public java.time.OffsetDateTime getStartDate()

Start date of the report. Date component of ISO 8061 format, any time or timezone component is ignored.

Returns:

startDate

setStartDate

public void setStartDate(java.time.OffsetDateTime startDate)

endDate

public TransactionsReportQueryMessage endDate(java.time.OffsetDateTime endDate)

getEndDate

public java.time.OffsetDateTime getEndDate()

End date of the report. Date component of ISO 8061 format, any time or timezone component is ignored.

Returns:

endDate

setEndDate

public void setEndDate(java.time.OffsetDateTime endDate)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object