type ForecastAdjustment (v202411)

Service
AdjustmentService
Dependencies
ForecastAdjustmentPage calculateDailyAdOpportunity... createForecastAdjustments() updateForecastAdjustments()
▼
ForecastAdjustment

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

Namespace
https://www.google.com/apis/ads/publisher/v202411

Field

id

xsd:long

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

trafficForecastSegmentId

xsd:long

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

This attribute is required.

name

xsd:string

Name of the ForecastAdjustment.

This attribute is required.

dateRange

DateRange

The start and end date range of the adjustment.

This attribute is required.

status

ForecastAdjustmentStatus

The status of the adjustment. Changes to this field should be made via performForecastAdjustmentAction This attribute is read-only.

Enumerations
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
ACTIVE
Indicates the current adjustment is active.
INACTIVE
Indicates the current adjustment is inactive.

volumeType

ForecastAdjustmentVolumeType

The volume type of the adjustment.

Enumerations
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.
DAILY_VOLUME
Volume is defined by a series of daily ad opportunity counts.
TOTAL_VOLUME
Volume is defined by a single total ad opportunity count.
HISTORICAL_BASIS_VOLUME
Volume is defined by historical volume data.

This attribute is required.

allowAdjustingForecastAboveRecommendedLimit

xsd:boolean

Whether to allow provided volume settings to increase the current forecast 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.

dailyVolumeSettings

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.

totalVolumeSettings

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.

historicalBasisVolumeSettings

HistoricalBasisVolumeSettings

The daily number of ad opportunities for each day in the adjustment date range, determined by reference to the ad opportunity volume of a historical reference period. This field is required if volumeType is ForecastAdjustmentVolumeType#HISTORICAL_BASIS_VOLUME and ignored othewise.

calculatedDailyAdOpportunityCounts

xsd:long[]

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. For example: for a dateRange of 2001-8-15 to 2001-8-17, this field will contain one value for 2001-8-15, one value for 2001-8-16, and one value for 2001-8-17.

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