com.google.api.ads.admanager.axis.v202005

Class ForecastAdjustment

java.lang.Object

com.google.api.ads.admanager.axis.v202005.ForecastAdjustment

All Implemented Interfaces:

Serializable

public class ForecastAdjustment
extends Object
implements Serializable

Provides information about the expected traffic volume and ad requests over a date range for a traffic forecast segment.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ForecastAdjustment()
ForecastAdjustment(Long id, Long trafficForecastSegmentId, String name, DateRange dateRange, ForecastAdjustmentStatus status, ForecastAdjustmentVolumeType volumeType, Boolean allowAdjustingForecastAboveRecommendedLimit, DailyVolumeSettings dailyVolumeSettings, TotalVolumeSettings totalVolumeSettings, HistoricalBasisVolumeSettings historicalBasisVolumeSettings, long[] calculatedDailyAdOpportunityCounts)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Boolean	getAllowAdjustingForecastAboveRecommendedLimit() Gets the allowAdjustingForecastAboveRecommendedLimit value for this ForecastAdjustment.
long[]	getCalculatedDailyAdOpportunityCounts() Gets the calculatedDailyAdOpportunityCounts value for this ForecastAdjustment.
long	getCalculatedDailyAdOpportunityCounts(int i)
DailyVolumeSettings	getDailyVolumeSettings() Gets the dailyVolumeSettings value for this ForecastAdjustment.
DateRange	getDateRange() Gets the dateRange value for this ForecastAdjustment.
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
HistoricalBasisVolumeSettings	getHistoricalBasisVolumeSettings() Gets the historicalBasisVolumeSettings value for this ForecastAdjustment.
Long	getId() Gets the id value for this ForecastAdjustment.
String	getName() Gets the name value for this ForecastAdjustment.
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
ForecastAdjustmentStatus	getStatus() Gets the status value for this ForecastAdjustment.
TotalVolumeSettings	getTotalVolumeSettings() Gets the totalVolumeSettings value for this ForecastAdjustment.
Long	getTrafficForecastSegmentId() Gets the trafficForecastSegmentId value for this ForecastAdjustment.
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
ForecastAdjustmentVolumeType	getVolumeType() Gets the volumeType value for this ForecastAdjustment.
int	hashCode()
void	setAllowAdjustingForecastAboveRecommendedLimit(Boolean allowAdjustingForecastAboveRecommendedLimit) Sets the allowAdjustingForecastAboveRecommendedLimit value for this ForecastAdjustment.
void	setCalculatedDailyAdOpportunityCounts(int i, long _value)
void	setCalculatedDailyAdOpportunityCounts(long[] calculatedDailyAdOpportunityCounts) Sets the calculatedDailyAdOpportunityCounts value for this ForecastAdjustment.
void	setDailyVolumeSettings(DailyVolumeSettings dailyVolumeSettings) Sets the dailyVolumeSettings value for this ForecastAdjustment.
void	setDateRange(DateRange dateRange) Sets the dateRange value for this ForecastAdjustment.
void	setHistoricalBasisVolumeSettings(HistoricalBasisVolumeSettings historicalBasisVolumeSettings) Sets the historicalBasisVolumeSettings value for this ForecastAdjustment.
void	setId(Long id) Sets the id value for this ForecastAdjustment.
void	setName(String name) Sets the name value for this ForecastAdjustment.
void	setStatus(ForecastAdjustmentStatus status) Sets the status value for this ForecastAdjustment.
void	setTotalVolumeSettings(TotalVolumeSettings totalVolumeSettings) Sets the totalVolumeSettings value for this ForecastAdjustment.
void	setTrafficForecastSegmentId(Long trafficForecastSegmentId) Sets the trafficForecastSegmentId value for this ForecastAdjustment.
void	setVolumeType(ForecastAdjustmentVolumeType volumeType) Sets the volumeType value for this ForecastAdjustment.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ForecastAdjustment

public ForecastAdjustment()

ForecastAdjustment

public ForecastAdjustment(Long id,
                          Long trafficForecastSegmentId,
                          String name,
                          DateRange dateRange,
                          ForecastAdjustmentStatus status,
                          ForecastAdjustmentVolumeType volumeType,
                          Boolean allowAdjustingForecastAboveRecommendedLimit,
                          DailyVolumeSettings dailyVolumeSettings,
                          TotalVolumeSettings totalVolumeSettings,
                          HistoricalBasisVolumeSettings historicalBasisVolumeSettings,
                          long[] calculatedDailyAdOpportunityCounts)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getId

public Long getId()

Gets the id value for this ForecastAdjustment.

Returns:

id * The unique ID of the ForecastAdjustment. This field is read-only. This attribute is read-only.

setId

public void setId(Long id)

Sets the id value for this ForecastAdjustment.

Parameters:

id - * The unique ID of the ForecastAdjustment. This field is read-only. This attribute is read-only.

getTrafficForecastSegmentId

public Long getTrafficForecastSegmentId()

Gets the trafficForecastSegmentId value for this ForecastAdjustment.

Returns:

trafficForecastSegmentId * The ID of the parent TrafficForecastSegment. This field is required and immutable after creation. This attribute is required.

setTrafficForecastSegmentId

public void setTrafficForecastSegmentId(Long trafficForecastSegmentId)

Sets the trafficForecastSegmentId value for this ForecastAdjustment.

Parameters:

trafficForecastSegmentId - * The ID of the parent TrafficForecastSegment. This field is required and immutable after creation. This attribute is required.

getName

public String getName()

Gets the name value for this ForecastAdjustment.

Returns:

name * Name of the ForecastAdjustment. This field is optional.

setName

public void setName(String name)

Sets the name value for this ForecastAdjustment.

Parameters:

name - * Name of the ForecastAdjustment. This field is optional.

getDateRange

public DateRange getDateRange()

Gets the dateRange value for this ForecastAdjustment.

Returns:

dateRange * The start and end date range of the adjustment. This attribute is required.

setDateRange

public void setDateRange(DateRange dateRange)

Sets the dateRange value for this ForecastAdjustment.

Parameters:

dateRange - * The start and end date range of the adjustment. This attribute is required.

getStatus

public ForecastAdjustmentStatus getStatus()

Gets the status value for this ForecastAdjustment.

Returns:

status * The status of the adjustment. This field is required.

setStatus

public void setStatus(ForecastAdjustmentStatus status)

Sets the status value for this ForecastAdjustment.

Parameters:

status - * The status of the adjustment. This field is required.

getVolumeType

public ForecastAdjustmentVolumeType getVolumeType()

Gets the volumeType value for this ForecastAdjustment.

Returns:

volumeType * The volume type of the adjustment. This attribute is required.

setVolumeType

public void setVolumeType(ForecastAdjustmentVolumeType volumeType)

Sets the volumeType value for this ForecastAdjustment.

Parameters:

volumeType - * The volume type of the adjustment. This attribute is required.

getAllowAdjustingForecastAboveRecommendedLimit

public Boolean getAllowAdjustingForecastAboveRecommendedLimit()

Gets the allowAdjustingForecastAboveRecommendedLimit value for this ForecastAdjustment.

Returns:

allowAdjustingForecastAboveRecommendedLimit * Whether to allow provided volume settings to increase current forecasted traffic values by more than 300%. Due to system constraints, adjusting the forecast by more than 300% may have unintended consequences for other parts of the forecast.

Note that this field will not persist on the adjustment itself, and will only affect the current request.

setAllowAdjustingForecastAboveRecommendedLimit

public void setAllowAdjustingForecastAboveRecommendedLimit(Boolean allowAdjustingForecastAboveRecommendedLimit)

Sets the allowAdjustingForecastAboveRecommendedLimit value for this ForecastAdjustment.

Parameters:

allowAdjustingForecastAboveRecommendedLimit - * Whether to allow provided volume settings to increase current forecasted traffic values by more than 300%. Due to system constraints, adjusting the forecast by more than 300% may have unintended consequences for other parts of the forecast.

Note that this field will not persist on the adjustment itself, and will only affect the current request.

getDailyVolumeSettings

public DailyVolumeSettings getDailyVolumeSettings()

Gets the dailyVolumeSettings value for this ForecastAdjustment.

Returns:

dailyVolumeSettings * The daily number of ad opportunities for each day in the adjustment date range. This field is required if volumeType is ForecastAdjustmentVolumeType#DAILY_VOLUME and ignored othewise.

setDailyVolumeSettings

public void setDailyVolumeSettings(DailyVolumeSettings dailyVolumeSettings)

Sets the dailyVolumeSettings value for this ForecastAdjustment.

Parameters:

dailyVolumeSettings - * The daily number of ad opportunities for each day in the adjustment date range. This field is required if volumeType is ForecastAdjustmentVolumeType#DAILY_VOLUME and ignored othewise.

getTotalVolumeSettings

public TotalVolumeSettings getTotalVolumeSettings()

Gets the totalVolumeSettings value for this ForecastAdjustment.

Returns:

totalVolumeSettings * The total number of ad opportunities for the entire adjustment date range. This field is required if volumeType is ForecastAdjustmentVolumeType#TOTAL_VOLUME and ignored othewise.

setTotalVolumeSettings

public void setTotalVolumeSettings(TotalVolumeSettings totalVolumeSettings)

Sets the totalVolumeSettings value for this ForecastAdjustment.

Parameters:

totalVolumeSettings - * The total number of ad opportunities for the entire adjustment date range. This field is required if volumeType is ForecastAdjustmentVolumeType#TOTAL_VOLUME and ignored othewise.

getHistoricalBasisVolumeSettings

public HistoricalBasisVolumeSettings getHistoricalBasisVolumeSettings()

Gets the historicalBasisVolumeSettings value for this ForecastAdjustment.

Returns:

historicalBasisVolumeSettings * The total number of ad opportunities for the entire adjustment date range, determined by reference to historical volume data. This field is required if volumeType is ForecastAdjustmentVolumeType#HISTORICAL_BASIS_VOLUME and ignored othewise.

setHistoricalBasisVolumeSettings

public void setHistoricalBasisVolumeSettings(HistoricalBasisVolumeSettings historicalBasisVolumeSettings)

Sets the historicalBasisVolumeSettings value for this ForecastAdjustment.

Parameters:

historicalBasisVolumeSettings - * The total number of ad opportunities for the entire adjustment date range, determined by reference to historical volume data. This field is required if volumeType is ForecastAdjustmentVolumeType#HISTORICAL_BASIS_VOLUME and ignored othewise.

getCalculatedDailyAdOpportunityCounts

public long[] getCalculatedDailyAdOpportunityCounts()

Gets the calculatedDailyAdOpportunityCounts value for this ForecastAdjustment.

Returns:

calculatedDailyAdOpportunityCounts * The daily number of ad opportunities calculated to satisfy the provided volume settings. Each value in this list represents the calculated ad opportunities on the corresponding day of the adjustment date range.

This field is read-only and is populated by Google after forecast adjustment creation.

setCalculatedDailyAdOpportunityCounts

public void setCalculatedDailyAdOpportunityCounts(long[] calculatedDailyAdOpportunityCounts)

Sets the calculatedDailyAdOpportunityCounts value for this ForecastAdjustment.

Parameters:

calculatedDailyAdOpportunityCounts - * The daily number of ad opportunities calculated to satisfy the provided volume settings. Each value in this list represents the calculated ad opportunities on the corresponding day of the adjustment date range.

This field is read-only and is populated by Google after forecast adjustment creation.

getCalculatedDailyAdOpportunityCounts

public long getCalculatedDailyAdOpportunityCounts(int i)

setCalculatedDailyAdOpportunityCounts

public void setCalculatedDailyAdOpportunityCounts(int i,
                                                  long _value)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()

Return type metadata object

getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(String mechType,
                                                                Class _javaType,
                                                                QName _xmlType)

Get Custom Serializer

getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(String mechType,
                                                                    Class _javaType,
                                                                    QName _xmlType)

Get Custom Deserializer