com.criteo.marketing.model

Class StatisticsReportQueryMessage

java.lang.Object

com.criteo.marketing.model.StatisticsReportQueryMessage

public class StatisticsReportQueryMessage
extends java.lang.Object

This is the message defining the query for Adset report

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StatisticsReportQueryMessage.DimensionsEnum Gets or Sets dimensions

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_DIMENSIONS
static java.lang.String	SERIALIZED_NAME_END_DATE
static java.lang.String	SERIALIZED_NAME_FORMAT
static java.lang.String	SERIALIZED_NAME_METRICS
static java.lang.String	SERIALIZED_NAME_START_DATE
static java.lang.String	SERIALIZED_NAME_TIMEZONE

Constructor Summary

Constructors

Constructor and Description
StatisticsReportQueryMessage()

Method Summary

Modifier and Type	Method and Description
StatisticsReportQueryMessage	addDimensionsItem(StatisticsReportQueryMessage.DimensionsEnum dimensionsItem)
StatisticsReportQueryMessage	addMetricsItem(java.lang.String metricsItem)
StatisticsReportQueryMessage	advertiserIds(java.lang.String advertiserIds)
StatisticsReportQueryMessage	currency(java.lang.String currency)
StatisticsReportQueryMessage	dimensions(java.util.List<StatisticsReportQueryMessage.DimensionsEnum> dimensions)
StatisticsReportQueryMessage	endDate(java.time.OffsetDateTime endDate)
boolean	equals(java.lang.Object o)
StatisticsReportQueryMessage	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.util.List<StatisticsReportQueryMessage.DimensionsEnum>	getDimensions() The dimensions for the report.
java.time.OffsetDateTime	getEndDate() End date of the report.
java.lang.String	getFormat() The file format of the generated report: csv, xml, excel or json.
java.util.List<java.lang.String>	getMetrics() The list of metrics to report.
java.time.OffsetDateTime	getStartDate() Start date of the report.
java.lang.String	getTimezone() The timezone used for the report.
int	hashCode()
StatisticsReportQueryMessage	metrics(java.util.List<java.lang.String> metrics)
void	setAdvertiserIds(java.lang.String advertiserIds)
void	setCurrency(java.lang.String currency)
void	setDimensions(java.util.List<StatisticsReportQueryMessage.DimensionsEnum> dimensions)
void	setEndDate(java.time.OffsetDateTime endDate)
void	setFormat(java.lang.String format)
void	setMetrics(java.util.List<java.lang.String> metrics)
void	setStartDate(java.time.OffsetDateTime startDate)
void	setTimezone(java.lang.String timezone)
StatisticsReportQueryMessage	startDate(java.time.OffsetDateTime startDate)
StatisticsReportQueryMessage	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_DIMENSIONS

public static final java.lang.String SERIALIZED_NAME_DIMENSIONS

See Also:

Constant Field Values

SERIALIZED_NAME_METRICS

public static final java.lang.String SERIALIZED_NAME_METRICS

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

StatisticsReportQueryMessage

public StatisticsReportQueryMessage()

Method Detail

advertiserIds

public StatisticsReportQueryMessage 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)

dimensions

public StatisticsReportQueryMessage dimensions(java.util.List<StatisticsReportQueryMessage.DimensionsEnum> dimensions)

addDimensionsItem

public StatisticsReportQueryMessage addDimensionsItem(StatisticsReportQueryMessage.DimensionsEnum dimensionsItem)

getDimensions

public java.util.List<StatisticsReportQueryMessage.DimensionsEnum> getDimensions()

The dimensions for the report.

Returns:

dimensions

setDimensions

public void setDimensions(java.util.List<StatisticsReportQueryMessage.DimensionsEnum> dimensions)

metrics

public StatisticsReportQueryMessage metrics(java.util.List<java.lang.String> metrics)

addMetricsItem

public StatisticsReportQueryMessage addMetricsItem(java.lang.String metricsItem)

getMetrics

public java.util.List<java.lang.String> getMetrics()

The list of metrics to report.

Returns:

metrics

setMetrics

public void setMetrics(java.util.List<java.lang.String> metrics)

currency

public StatisticsReportQueryMessage 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 StatisticsReportQueryMessage 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 StatisticsReportQueryMessage 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 StatisticsReportQueryMessage 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 StatisticsReportQueryMessage 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