Show / Hide Table of Contents

Class ForecastAdjustment

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

Inheritance
object
ForecastAdjustment
Implements
IMessage<ForecastAdjustment>
IEquatable<ForecastAdjustment>
IDeepCloneable<ForecastAdjustment>
IBufferMessage
IMessage
Inherited Members
object.GetHashCode()
object.GetType()
object.ToString()
Namespace: Google.Ads.AdManager.V1
Assembly: Google.Ads.AdManager.V1.dll
Syntax
public sealed class ForecastAdjustment : IMessage<ForecastAdjustment>, IEquatable<ForecastAdjustment>, IDeepCloneable<ForecastAdjustment>, IBufferMessage, IMessage

Constructors

ForecastAdjustment()

Declaration
public ForecastAdjustment()

ForecastAdjustment(ForecastAdjustment)

Declaration
public ForecastAdjustment(ForecastAdjustment other)
Parameters
Type Name Description
ForecastAdjustment other

Properties

AllowAdjustingForecastAboveRecommendedLimit

Input only. 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.

Declaration
public bool AllowAdjustingForecastAboveRecommendedLimit { get; set; }
Property Value
Type Description
bool

CalculatedDailyAdOpportunityCounts

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.

Declaration
public RepeatedField<long> CalculatedDailyAdOpportunityCounts { get; }
Property Value
Type Description
RepeatedField<long>

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][google.ads.admanager.v1.ForecastAdjustmentVolumeTypeEnum.ForecastAdjustmentVolumeType.DAILY_VOLUME] and ignored otherwise.

Declaration
public DailyVolumeSettings DailyVolumeSettings { get; set; }
Property Value
Type Description
DailyVolumeSettings

DateRange

Required. The date range of the adjustment.

Declaration
public DateRange DateRange { get; set; }
Property Value
Type Description
DateRange

DisplayName

Required. Display name of the ForecastAdjustment.

Declaration
public string DisplayName { get; set; }
Property Value
Type Description
string

ForecastAdjustmentName

ForecastAdjustmentName-typed view over the Name resource name property.

Declaration
public ForecastAdjustmentName ForecastAdjustmentName { get; set; }
Property Value
Type Description
ForecastAdjustmentName

HasAllowAdjustingForecastAboveRecommendedLimit

Gets whether the "allow_adjusting_forecast_above_recommended_limit" field is set

Declaration
public bool HasAllowAdjustingForecastAboveRecommendedLimit { get; }
Property Value
Type Description
bool

HasDisplayName

Gets whether the "display_name" field is set

Declaration
public bool HasDisplayName { get; }
Property Value
Type Description
bool

HasStatus

Gets whether the "status" field is set

Declaration
public bool HasStatus { get; }
Property Value
Type Description
bool

HasTrafficForecastSegment

Gets whether the "traffic_forecast_segment" field is set

Declaration
public bool HasTrafficForecastSegment { get; }
Property Value
Type Description
bool

HasVolumeType

Gets whether the "volume_type" field is set

Declaration
public bool HasVolumeType { get; }
Property Value
Type Description
bool

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][google.ads.admanager.v1.ForecastAdjustmentVolumeTypeEnum.ForecastAdjustmentVolumeType.HISTORICAL_BASIS_VOLUME] and ignored otherwise.

Declaration
public HistoricalBasisVolumeSettings HistoricalBasisVolumeSettings { get; set; }
Property Value
Type Description
HistoricalBasisVolumeSettings

Name

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

Declaration
public string Name { get; set; }
Property Value
Type Description
string

Status

Output only. The status of the adjustment.

Declaration
public ForecastAdjustmentStatusEnum.Types.ForecastAdjustmentStatus Status { get; set; }
Property Value
Type Description
ForecastAdjustmentStatusEnum.Types.ForecastAdjustmentStatus

TotalVolumeSettings

Optional. The total number of ad opportunities for the entire adjustment date range. This field is required if volumeType is [ForecastAdjustmentVolumeType.TOTAL_VOLUME][google.ads.admanager.v1.ForecastAdjustmentVolumeTypeEnum.ForecastAdjustmentVolumeType.TOTAL_VOLUME] and ignored otherwise.

Declaration
public TotalVolumeSettings TotalVolumeSettings { get; set; }
Property Value
Type Description
TotalVolumeSettings

TrafficForecastSegment

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

Declaration
public string TrafficForecastSegment { get; set; }
Property Value
Type Description
string

TrafficForecastSegmentAsTrafficForecastSegmentName

TrafficForecastSegmentName-typed view over the TrafficForecastSegment resource name property.

Declaration
public TrafficForecastSegmentName TrafficForecastSegmentAsTrafficForecastSegmentName { get; set; }
Property Value
Type Description
TrafficForecastSegmentName

VolumeSettingsCase

Declaration
public ForecastAdjustment.VolumeSettingsOneofCase VolumeSettingsCase { get; }
Property Value
Type Description
ForecastAdjustment.VolumeSettingsOneofCase

VolumeType

Required. The volume type of the adjustment.

Declaration
public ForecastAdjustmentVolumeTypeEnum.Types.ForecastAdjustmentVolumeType VolumeType { get; set; }
Property Value
Type Description
ForecastAdjustmentVolumeTypeEnum.Types.ForecastAdjustmentVolumeType
In this article
Back to top Generated by DocFX