type ForecastAdjustment (v202411)
Stay organized with collections
Save and categorize content based on your preferences.
Service
AdjustmentService
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.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-06 UTC.
[null,null,["Last updated 2025-08-06 UTC."],[[["\u003cp\u003eForecastAdjustment provides estimated traffic volume and composition for a specific traffic forecast segment over a defined date range.\u003c/p\u003e\n"],["\u003cp\u003eIt includes fields like ID, traffic forecast segment ID, name, date range, status, volume type, and settings for daily, total, or historical basis volume.\u003c/p\u003e\n"],["\u003cp\u003eAdjustments can be made to the forecast, including daily volume, total volume, and historical basis volume, but increasing the forecast by more than 300% may have unintended consequences.\u003c/p\u003e\n"],["\u003cp\u003eThe calculated daily ad opportunity counts are generated by Google and reflect the provided volume settings for the specified date range.\u003c/p\u003e\n"]]],["The `AdjustmentService` manages `ForecastAdjustment` data, which details expected traffic volume over a specified date range for a forecast segment. Key actions include creating and updating these adjustments. A `ForecastAdjustment` requires a `trafficForecastSegmentId`, `name`, `dateRange`, and `volumeType`. The `volumeType` determines if adjustments use `DAILY_VOLUME`, `TOTAL_VOLUME`, or `HISTORICAL_BASIS_VOLUME`. The system also calculates and provides read-only `calculatedDailyAdOpportunityCounts`. Adjustments can be active or inactive, which are tracked by their status.\n"],null,["# type ForecastAdjustment (v202411)\n\n**Service** \n**AdjustmentService** **Dependencies** \n[ForecastAdjustmentPage](/ad-manager/api/reference/v202411/AdjustmentService.ForecastAdjustmentPage) [calculateDailyAdOpportunity...](/ad-manager/api/reference/v202411/AdjustmentService#calculateDailyAdOpportunityCounts \"calculateDailyAdOpportunityCounts()\") [createForecastAdjustments()](/ad-manager/api/reference/v202411/AdjustmentService#createForecastAdjustments) [updateForecastAdjustments()](/ad-manager/api/reference/v202411/AdjustmentService#updateForecastAdjustments) \n▼\n**ForecastAdjustment**\n\nProvides information about the expected volume and composition of traffic over a date range for a\ntraffic forecast segment.\n\n*** ** * ** ***\n\nNamespace\n:\n `https://www.google.com/apis/ads/publisher/v202411`\n\n| Field ----- ||\n|---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### `id` | ` `xsd:`long` The unique ID of the ForecastAdjustment. This field is read-only. This attribute is read-only. |\n| ### `trafficForecastSegmentId` | ` `xsd:`long` The ID of the parent TrafficForecastSegment. This field is required and immutable after creation. This attribute is required. |\n| ### `name` | ` `xsd:`string` Name of the ForecastAdjustment. This attribute is required. |\n| ### `dateRange` | ` `[DateRange](/ad-manager/api/reference/v202411/AdjustmentService.DateRange)` ` The start and end date range of the adjustment. This attribute is required. |\n| ### `status` | ` `[ForecastAdjustmentStatus](/ad-manager/api/reference/v202411/AdjustmentService.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. \u003cbr /\u003e |\n| ### `volumeType` | ` `[ForecastAdjustmentVolumeType](/ad-manager/api/reference/v202411/AdjustmentService.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. \u003cbr /\u003e This attribute is required. |\n| ### `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. \u003cbr /\u003e |\n| ### `dailyVolumeSettings` | ` `[DailyVolumeSettings](/ad-manager/api/reference/v202411/AdjustmentService.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. |\n| ### `totalVolumeSettings` | ` `[TotalVolumeSettings](/ad-manager/api/reference/v202411/AdjustmentService.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. |\n| ### `historicalBasisVolumeSettings` | ` `[HistoricalBasisVolumeSettings](/ad-manager/api/reference/v202411/AdjustmentService.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. |\n| ### `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. \u003cbr /\u003e |"]]
