REST Resource: networks.forecastAdjustments

Resource: ForecastAdjustment

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

JSON representation 
{
  "name": string,
  "dateRange": {
    object (DateRange)
  },
  "calculatedDailyAdOpportunityCounts": [
    string
  ],

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "dailyVolumeSettings": {
    object (DailyVolumeSettings)
  },
  "totalVolumeSettings": {
    object (TotalVolumeSettings)
  },
  "historicalBasisVolumeSettings": {
    object (HistoricalBasisVolumeSettings)
  }
  // End of mutually exclusive fields.
  "trafficForecastSegment": string,
  "displayName": string,
  "status": enum (ForecastAdjustmentStatus),
  "volumeType": enum (ForecastAdjustmentVolumeType),
  "allowAdjustingForecastAboveRecommendedLimit": boolean
}
Fields
name

string

Identifier. The resource name of the ForecastAdjustment. Format: networks/{networkCode}/forecastAdjustments/{forecastAdjustmentId}
dateRange

object (DateRange)

Required. The date range of the adjustment.
calculatedDailyAdOpportunityCounts[]

string (int64 format)

Output only. 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.
Settings that specify the volume of ad opportunities. Only one of the following volume settings can be provided depending on the value of volume_type. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
dailyVolumeSettings

object (DailyVolumeSettings)

Optional. 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 otherwise.
totalVolumeSettings

object (TotalVolumeSettings)

Optional. The total number of ad opportunities for the entire adjustment date range. This field is required if volumeType is ForecastAdjustmentVolumeType.TOTAL_VOLUME and ignored otherwise.
historicalBasisVolumeSettings

object (HistoricalBasisVolumeSettings)

Optional. 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 otherwise.
End of mutually exclusive fields.
trafficForecastSegment

string

Required. Immutable. The resource name of the TrafficForecastSegment that this adjustment is associated with. Format: networks/{networkCode}/trafficForecastSegments/{trafficForecastSegmentId}
displayName

string

Required. Display name of the ForecastAdjustment.
status

enum (ForecastAdjustmentStatus)

Output only. The status of the adjustment.
volumeType

enum (ForecastAdjustmentVolumeType)

Required. The volume type of the adjustment.

DailyVolumeSettings

Settings to specify daily ad opportunity counts that will be used as the expected future traffic volume for a forecast adjustment. For example: [10000, 20000, 5000] indicates expected traffic for the targeting specified on the parent traffic forecast segment of 10,000 ad opportunities for the first day, 20,000 ad opportunities for the second, and 5,000 for the third.

JSON representation 
{
  "adOpportunityCounts": [
    string
  ]
}
Fields
adOpportunityCounts[]

string (int64 format)

Required. The list of ad opportunity counts. Each value in this list represents the expected number of ad opportunities on the corresponding day of the adjustment date range. The number of values provided must match the number of days in the adjustment date range, inclusive. For example, an adjustment date range of June 5-June 7 would need 3 values in this list, one for June 5, one for June 6, and one for June 7.

TotalVolumeSettings

Settings to specify a single total traffic volume that will be used as the expected total future volume for a forecast adjustment. For example, an adOpportunityCount of 3,000 indicates a forecast goal for the targeting specified on the parent traffic forecast segment of 3,000 ad opportunities over the entire duration of the adjustment.

JSON representation 
{
  "adOpportunityCount": string
}
Fields
adOpportunityCount

string (int64 format)

Required. The total ad opportunity count over the entire forecast adjustment date range.

HistoricalBasisVolumeSettings

Settings to specify the volume of ad opportunities per day over the ForecastAdjustment date range based on the traffic volume of a historical reference period. The daily historical traffic for the provided targeting and date range is fetched, multiplied by the provided multiplier, and used as the daily expected traffic for the adjustment. The number of days included in the historical date range does not need to be the same as the number of days included in the adjustment date range.

JSON representation 
{
  "targeting": {
    object (Targeting)
  },
  "historicalDateRange": {
    object (DateRange)
  },
  "useParentTrafficForecastSegmentTargeting": boolean,
  "multiplierMilliPercent": string
}
Fields
targeting

object (Targeting)

Optional. The targeting criteria to use as the source of the historical volume data. This field is required if useParentTrafficForecastSegmentTargeting is false and ignored otherwise.
historicalDateRange

object (DateRange)

Required. The date range to use for the historical ad opportunity volume.
useParentTrafficForecastSegmentTargeting

boolean

Whether the parent traffic forecast segment targeting's or the targeting's historical volume data should be used.
multiplierMilliPercent

string (int64 format)

Required. The multiplier to apply to the historical traffic volume, expressed in thousandths of a percent. For example, to set the forecasted traffic as 130% of the historical traffic, this value would be 130,000.

DateRange

A date range with fixed start and end dates (e.g. 2021-06-01 - 2021-06-30).

JSON representation 
{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
Fields
startDate

object (Date)

The start of the date range.
endDate

object (Date)

The end of the date range.

ForecastAdjustmentStatus

The status of a forecast adjustment. Inactive adjustments are not applied during forecasting.

Enums
FORECAST_ADJUSTMENT_STATUS_UNSPECIFIED Default value. This value is unused.
ACTIVE Indicates the current adjustment is active.
INACTIVE Indicates the current adjustment is inactive.

ForecastAdjustmentVolumeType

Options for how the volume settings of a ForecastAdjustment are defined.

Enums
FORECAST_ADJUSTMENT_VOLUME_TYPE_UNSPECIFIED Default value. This value is unused.
DAILY_VOLUME Volume is defined by a series of daily ad opportunity counts.
HISTORICAL_BASIS_VOLUME Volume is defined by historical volume data.
TOTAL_VOLUME Volume is defined by a single total ad opportunity count.

Methods

batchActivate

 Activates a list of ForecastAdjustment objects.

batchCreate

 Creates ForecastAdjustment objects.

batchDeactivate

 Deactivates a list of ForecastAdjustment objects.

batchUpdate

 Batch updates ForecastAdjustment objects.

calculateDailyAdOpportunityCounts

 Calculates daily ad opportunity counts for a prospective ForecastAdjustment object.

create

 Creates a ForecastAdjustment object.

get

 Retrieves a ForecastAdjustment object.

list

 Lists ForecastAdjustment objects.

patch

 Updates a ForecastAdjustment object.