Ads API .NET library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Google.Api.Ads.AdManager.v202208.ForecastService Class Reference

Provides methods for estimating traffic (clicks/impressions) for line items. Forecasts can be provided for LineItem objects that exist in the system or which have not had an ID set yet. More...

Inheritance diagram for Google.Api.Ads.AdManager.v202208.ForecastService:
Google.Api.Ads.AdManager.v202208.IForecastService Google.Api.Ads.AdManager.v202208.ForecastServiceInterface

Public Member Functions

 ForecastService ()
 Creates a new instance of the ForecastService class. More...
 
 ForecastService (string endpointConfigurationName)
 Creates a new instance of the ForecastService class. More...
 
 ForecastService (string endpointConfigurationName, string remoteAddress)
 Creates a new instance of the ForecastService class. More...
 
 ForecastService (string endpointConfigurationName, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the ForecastService class. More...
 
 ForecastService (System.ServiceModel.Channels.Binding binding, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the ForecastService class. More...
 
virtual
Google.Api.Ads.AdManager.v202208.AvailabilityForecast 
getAvailabilityForecast (Google.Api.Ads.AdManager.v202208.ProspectiveLineItem lineItem, Google.Api.Ads.AdManager.v202208.AvailabilityForecastOptions forecastOptions)
 Gets the availability forecast for a ProspectiveLineItem. An availability forecast reports the maximum number of available units that the line item can book, and the total number of units matching the line item's targeting. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.AvailabilityForecast
getAvailabilityForecastAsync (Google.Api.Ads.AdManager.v202208.ProspectiveLineItem lineItem, Google.Api.Ads.AdManager.v202208.AvailabilityForecastOptions forecastOptions)
 
virtual
Google.Api.Ads.AdManager.v202208.AvailabilityForecast 
getAvailabilityForecastById (long lineItemId, Google.Api.Ads.AdManager.v202208.AvailabilityForecastOptions forecastOptions)
 Gets an AvailabilityForecast for an existing LineItem object. An availability forecast reports the maximum number of available units that the line item can be booked with, and also the total number of units matching the line item's targeting. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.AvailabilityForecast
getAvailabilityForecastByIdAsync (long lineItemId, Google.Api.Ads.AdManager.v202208.AvailabilityForecastOptions forecastOptions)
 
virtual
Google.Api.Ads.AdManager.v202208.DeliveryForecast 
getDeliveryForecast (Google.Api.Ads.AdManager.v202208.ProspectiveLineItem[] lineItems, Google.Api.Ads.AdManager.v202208.DeliveryForecastOptions forecastOptions)
 Gets the delivery forecast for a list of ProspectiveLineItem objects in a single delivery simulation with line items potentially contending with each other. A delivery forecast reports the number of units that will be delivered to each line item given the line item goals and contentions from other line items. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.DeliveryForecast
getDeliveryForecastAsync (Google.Api.Ads.AdManager.v202208.ProspectiveLineItem[] lineItems, Google.Api.Ads.AdManager.v202208.DeliveryForecastOptions forecastOptions)
 
virtual
Google.Api.Ads.AdManager.v202208.DeliveryForecast 
getDeliveryForecastByIds (long[] lineItemIds, Google.Api.Ads.AdManager.v202208.DeliveryForecastOptions forecastOptions)
 Gets the delivery forecast for a list of existing LineItem objects in a single delivery simulation. A delivery forecast reports the number of units that will be delivered to each line item given the line item goals and contentions from other line items. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.DeliveryForecast
getDeliveryForecastByIdsAsync (long[] lineItemIds, Google.Api.Ads.AdManager.v202208.DeliveryForecastOptions forecastOptions)
 
virtual
Google.Api.Ads.AdManager.v202208.TrafficDataResponse 
getTrafficData (Google.Api.Ads.AdManager.v202208.TrafficDataRequest trafficDataRequest)
 Returns forecasted and historical traffic data for the segment of traffic specified by the provided request. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.TrafficDataResponse
getTrafficDataAsync (Google.Api.Ads.AdManager.v202208.TrafficDataRequest trafficDataRequest)
 

Detailed Description

Provides methods for estimating traffic (clicks/impressions) for line items. Forecasts can be provided for LineItem objects that exist in the system or which have not had an ID set yet.

Test network behavior

Test networks are unable to provide forecasts that would be comparable to the production environment because forecasts require traffic history. For test networks, a consistent behavior can be expected for forecast requests, according to the following rules:

Inputs
(LineItem Fields)
Outputs
(Forecast Fields)
lineItemType unitsBought availableUnits forecastUnits (matchedUnits) deliveredUnits Exception
Sponsorship 13 #x2013;#x2013; #x2013;#x2013; #x2013;#x2013; NO_FORECAST_YET
Sponsorship 20 #x2013;#x2013; #x2013;#x2013; #x2013;#x2013; SERVER_NOT_AVAILABLE
Sponsorship 50 1,200,000 6,000,000 600,000 #x2013;#x2013;
Sponsorship != 20 and
!= 50
1,200,000 1,200,000 600,000 #x2013;#x2013;
Not Sponsorship <= 500,000 3 * unitsBought / 2 unitsBought * 6 600,000 #x2013;#x2013;
Not Sponsorship > 500,000 and <= 1,000,000 unitsBought / 2 unitsBought * 6 600,000 #x2013;#x2013;
Not Sponsorship > 1,000,000 and <= 1,500,000 unitsBought / 2 3 * unitsBought / 2 600,000 #x2013;#x2013;
Not Sponsorship > 1,500,000 unitsBought / 4 3 * unitsBought / 2 600,000 #x2013;#x2013;

Constructor & Destructor Documentation

Google.Api.Ads.AdManager.v202208.ForecastService.ForecastService ( )
inline

Creates a new instance of the ForecastService class.

Google.Api.Ads.AdManager.v202208.ForecastService.ForecastService ( string  endpointConfigurationName)
inline

Creates a new instance of the ForecastService class.

Google.Api.Ads.AdManager.v202208.ForecastService.ForecastService ( string  endpointConfigurationName,
string  remoteAddress 
)
inline

Creates a new instance of the ForecastService class.

Google.Api.Ads.AdManager.v202208.ForecastService.ForecastService ( string  endpointConfigurationName,
System.ServiceModel.EndpointAddress  remoteAddress 
)
inline

Creates a new instance of the ForecastService class.

Google.Api.Ads.AdManager.v202208.ForecastService.ForecastService ( System.ServiceModel.Channels.Binding  binding,
System.ServiceModel.EndpointAddress  remoteAddress 
)
inline

Creates a new instance of the ForecastService class.

Member Function Documentation

virtual Google.Api.Ads.AdManager.v202208.AvailabilityForecast Google.Api.Ads.AdManager.v202208.ForecastService.getAvailabilityForecast ( Google.Api.Ads.AdManager.v202208.ProspectiveLineItem  lineItem,
Google.Api.Ads.AdManager.v202208.AvailabilityForecastOptions  forecastOptions 
)
inlinevirtual

Gets the availability forecast for a ProspectiveLineItem. An availability forecast reports the maximum number of available units that the line item can book, and the total number of units matching the line item's targeting.

Parameters
lineItemthe prospective line item (new or existing) to be forecasted for availability
forecastOptionsoptions controlling the forecast

Implements Google.Api.Ads.AdManager.v202208.ForecastServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.AvailabilityForecast> Google.Api.Ads.AdManager.v202208.ForecastService.getAvailabilityForecastAsync ( Google.Api.Ads.AdManager.v202208.ProspectiveLineItem  lineItem,
Google.Api.Ads.AdManager.v202208.AvailabilityForecastOptions  forecastOptions 
)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.AvailabilityForecast Google.Api.Ads.AdManager.v202208.ForecastService.getAvailabilityForecastById ( long  lineItemId,
Google.Api.Ads.AdManager.v202208.AvailabilityForecastOptions  forecastOptions 
)
inlinevirtual

Gets an AvailabilityForecast for an existing LineItem object. An availability forecast reports the maximum number of available units that the line item can be booked with, and also the total number of units matching the line item's targeting.

Only line items having type LineItemType::SPONSORSHIP or LineItemType::STANDARD are valid. Other types will result in ReservationDetailsError.Reason::LINE_ITEM_TYPE_NOT_ALLOWED.

Parameters
lineItemIdthe ID of a LineItem to run the forecast on.
forecastOptionsoptions controlling the forecast

Implements Google.Api.Ads.AdManager.v202208.ForecastServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.AvailabilityForecast> Google.Api.Ads.AdManager.v202208.ForecastService.getAvailabilityForecastByIdAsync ( long  lineItemId,
Google.Api.Ads.AdManager.v202208.AvailabilityForecastOptions  forecastOptions 
)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.DeliveryForecast Google.Api.Ads.AdManager.v202208.ForecastService.getDeliveryForecast ( Google.Api.Ads.AdManager.v202208.ProspectiveLineItem[]  lineItems,
Google.Api.Ads.AdManager.v202208.DeliveryForecastOptions  forecastOptions 
)
inlinevirtual

Gets the delivery forecast for a list of ProspectiveLineItem objects in a single delivery simulation with line items potentially contending with each other. A delivery forecast reports the number of units that will be delivered to each line item given the line item goals and contentions from other line items.

Parameters
lineItemsline items to be forecasted for delivery
forecastOptionsoptions controlling the forecast

Implements Google.Api.Ads.AdManager.v202208.IForecastService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.DeliveryForecast> Google.Api.Ads.AdManager.v202208.ForecastService.getDeliveryForecastAsync ( Google.Api.Ads.AdManager.v202208.ProspectiveLineItem[]  lineItems,
Google.Api.Ads.AdManager.v202208.DeliveryForecastOptions  forecastOptions 
)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.DeliveryForecast Google.Api.Ads.AdManager.v202208.ForecastService.getDeliveryForecastByIds ( long[]  lineItemIds,
Google.Api.Ads.AdManager.v202208.DeliveryForecastOptions  forecastOptions 
)
inlinevirtual

Gets the delivery forecast for a list of existing LineItem objects in a single delivery simulation. A delivery forecast reports the number of units that will be delivered to each line item given the line item goals and contentions from other line items.

Parameters
lineItemIdsthe IDs of line items to be forecasted for delivery
forecastOptionsoptions controlling the forecast

Implements Google.Api.Ads.AdManager.v202208.IForecastService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.DeliveryForecast> Google.Api.Ads.AdManager.v202208.ForecastService.getDeliveryForecastByIdsAsync ( long[]  lineItemIds,
Google.Api.Ads.AdManager.v202208.DeliveryForecastOptions  forecastOptions 
)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.TrafficDataResponse Google.Api.Ads.AdManager.v202208.ForecastService.getTrafficData ( Google.Api.Ads.AdManager.v202208.TrafficDataRequest  trafficDataRequest)
inlinevirtual

Returns forecasted and historical traffic data for the segment of traffic specified by the provided request.

Calling this endpoint programmatically is only available for Ad Manager 360 networks.

Parameters
trafficDataRequestthe request specifying the segment of traffic for which data should be returned
Returns
a dto containing forecasted and historical traffic data for the specified segment of traffic

Implements Google.Api.Ads.AdManager.v202208.ForecastServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.TrafficDataResponse> Google.Api.Ads.AdManager.v202208.ForecastService.getTrafficDataAsync ( Google.Api.Ads.AdManager.v202208.TrafficDataRequest  trafficDataRequest)
inlinevirtual

The documentation for this class was generated from the following file: