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

Provides methods for creating, updating, and retrieving ForecastAdjustments and TrafficForecastSegments. More...

Inheritance diagram for Google.Api.Ads.AdManager.v202208.AdjustmentService:
Google.Api.Ads.AdManager.v202208.IAdjustmentService Google.Api.Ads.AdManager.v202208.AdjustmentServiceInterface

Public Member Functions

 AdjustmentService ()
 Creates a new instance of the AdjustmentService class. More...
 
 AdjustmentService (string endpointConfigurationName)
 Creates a new instance of the AdjustmentService class. More...
 
 AdjustmentService (string endpointConfigurationName, string remoteAddress)
 Creates a new instance of the AdjustmentService class. More...
 
 AdjustmentService (string endpointConfigurationName, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the AdjustmentService class. More...
 
 AdjustmentService (System.ServiceModel.Channels.Binding binding, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the AdjustmentService class. More...
 
virtual
Google.Api.Ads.AdManager.v202208.ForecastAdjustment 
calculateDailyAdOpportunityCounts (Google.Api.Ads.AdManager.v202208.ForecastAdjustment forecastAdjustment)
 Takes a prospective forecast adjustment and calculates the daily ad opportunity counts corresponding to its provided volume settings. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.ForecastAdjustment
calculateDailyAdOpportunityCountsAsync (Google.Api.Ads.AdManager.v202208.ForecastAdjustment forecastAdjustment)
 
virtual
Google.Api.Ads.AdManager.v202208.ForecastAdjustment[] 
createForecastAdjustments (Google.Api.Ads.AdManager.v202208.ForecastAdjustment[] forecastAdjustments)
 Creates new ForecastAdjustment objects. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.ForecastAdjustment[]> 
createForecastAdjustmentsAsync (Google.Api.Ads.AdManager.v202208.ForecastAdjustment[] forecastAdjustments)
 
virtual
Google.Api.Ads.AdManager.v202208.TrafficForecastSegment[] 
createTrafficForecastSegments (Google.Api.Ads.AdManager.v202208.TrafficForecastSegment[] trafficForecastSegments)
 Creates new TrafficForecastSegment objects. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.TrafficForecastSegment[]> 
createTrafficForecastSegmentsAsync (Google.Api.Ads.AdManager.v202208.TrafficForecastSegment[] trafficForecastSegments)
 
virtual
Google.Api.Ads.AdManager.v202208.ForecastAdjustmentPage 
getForecastAdjustmentsByStatement (Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 Gets a ForecastAdjustmentPage of ForecastAdjustment objects that satisfy the given Statement::query. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.ForecastAdjustmentPage
getForecastAdjustmentsByStatementAsync (Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 
virtual
Google.Api.Ads.AdManager.v202208.TrafficForecastSegmentPage 
getTrafficForecastSegmentsByStatement (Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 Gets a TrafficForecastSegmentPage of TrafficForecastSegment objects that satisfy the given Statement::query. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.TrafficForecastSegmentPage
getTrafficForecastSegmentsByStatementAsync (Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 
virtual
Google.Api.Ads.AdManager.v202208.UpdateResult 
performForecastAdjustmentAction (Google.Api.Ads.AdManager.v202208.ForecastAdjustmentAction forecastAdjustmentAction, Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 Performs actions on ForecastAdjustment objects that match the given Statement::query. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.UpdateResult
performForecastAdjustmentActionAsync (Google.Api.Ads.AdManager.v202208.ForecastAdjustmentAction forecastAdjustmentAction, Google.Api.Ads.AdManager.v202208.Statement filterStatement)
 
virtual
Google.Api.Ads.AdManager.v202208.ForecastAdjustment[] 
updateForecastAdjustments (Google.Api.Ads.AdManager.v202208.ForecastAdjustment[] forecastAdjustments)
 Updates the specified ForecastAdjustment objects. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.ForecastAdjustment[]> 
updateForecastAdjustmentsAsync (Google.Api.Ads.AdManager.v202208.ForecastAdjustment[] forecastAdjustments)
 
virtual
Google.Api.Ads.AdManager.v202208.TrafficForecastSegment[] 
updateTrafficForecastSegments (Google.Api.Ads.AdManager.v202208.TrafficForecastSegment[] trafficForecastSegments)
 Updates the specified TrafficForecastSegment objects. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202208.TrafficForecastSegment[]> 
updateTrafficForecastSegmentsAsync (Google.Api.Ads.AdManager.v202208.TrafficForecastSegment[] trafficForecastSegments)
 

Detailed Description

Provides methods for creating, updating, and retrieving ForecastAdjustments and TrafficForecastSegments.

Forecast adjustments allow editing the volume and traffic composition of forecasted inventory. Traffic forecast segments divide forecasted inventory into segments to which forecast adjustments can be applied.

Constructor & Destructor Documentation

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

Creates a new instance of the AdjustmentService class.

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

Creates a new instance of the AdjustmentService class.

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

Creates a new instance of the AdjustmentService class.

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

Creates a new instance of the AdjustmentService class.

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

Creates a new instance of the AdjustmentService class.

Member Function Documentation

virtual Google.Api.Ads.AdManager.v202208.ForecastAdjustment Google.Api.Ads.AdManager.v202208.AdjustmentService.calculateDailyAdOpportunityCounts ( Google.Api.Ads.AdManager.v202208.ForecastAdjustment  forecastAdjustment)
inlinevirtual

Takes a prospective forecast adjustment and calculates the daily ad opportunity counts corresponding to its provided volume settings.

Parameters
forecastAdjustmentthe prospective forecast adjustment
Returns
a forecast adjustment matching the one passed in, but with its calculatedDailyAdOpportunityCounts field populated

Implements Google.Api.Ads.AdManager.v202208.AdjustmentServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.ForecastAdjustment> Google.Api.Ads.AdManager.v202208.AdjustmentService.calculateDailyAdOpportunityCountsAsync ( Google.Api.Ads.AdManager.v202208.ForecastAdjustment  forecastAdjustment)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.ForecastAdjustment [] Google.Api.Ads.AdManager.v202208.AdjustmentService.createForecastAdjustments ( Google.Api.Ads.AdManager.v202208.ForecastAdjustment[]  forecastAdjustments)
inlinevirtual

Creates new ForecastAdjustment objects.

Parameters
forecastAdjustmentsthe forecast adjustments to create
Returns
the persisted forecast adjustments with their IDs populated
Exceptions
ApiExceptionif there is an error creating the forecast adjustments

Implements Google.Api.Ads.AdManager.v202208.IAdjustmentService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.ForecastAdjustment[]> Google.Api.Ads.AdManager.v202208.AdjustmentService.createForecastAdjustmentsAsync ( Google.Api.Ads.AdManager.v202208.ForecastAdjustment[]  forecastAdjustments)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.TrafficForecastSegment [] Google.Api.Ads.AdManager.v202208.AdjustmentService.createTrafficForecastSegments ( Google.Api.Ads.AdManager.v202208.TrafficForecastSegment[]  trafficForecastSegments)
inlinevirtual

Creates new TrafficForecastSegment objects.

Parameters
trafficForecastSegmentsthe traffic forecast segments to create
Returns
the persisted traffic forecast segments with their IDs populated
Exceptions
ApiExceptionif there is an error creating the traffic forecast segments

Implements Google.Api.Ads.AdManager.v202208.IAdjustmentService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.TrafficForecastSegment[]> Google.Api.Ads.AdManager.v202208.AdjustmentService.createTrafficForecastSegmentsAsync ( Google.Api.Ads.AdManager.v202208.TrafficForecastSegment[]  trafficForecastSegments)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.ForecastAdjustmentPage Google.Api.Ads.AdManager.v202208.AdjustmentService.getForecastAdjustmentsByStatement ( Google.Api.Ads.AdManager.v202208.Statement  filterStatement)
inlinevirtual

Gets a ForecastAdjustmentPage of ForecastAdjustment objects that satisfy the given Statement::query.

The following fields are supported for filtering:

PQL Property Object Property
id ForecastAdjustment::id
trafficForecastSegmentId ForecastAdjustment::trafficForecastSegmentId
name ForecastAdjustment::name
startDate ForecastAdjustment::startDate
endDate ForecastAdjustment::endDate
status ForecastAdjustment::status
Parameters
filterStatementa Publisher Query Language statement to filter a list of traffic forecast segments
Returns
a page of forecast adjustments that match the filter

Implements Google.Api.Ads.AdManager.v202208.AdjustmentServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.ForecastAdjustmentPage> Google.Api.Ads.AdManager.v202208.AdjustmentService.getForecastAdjustmentsByStatementAsync ( Google.Api.Ads.AdManager.v202208.Statement  filterStatement)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.TrafficForecastSegmentPage Google.Api.Ads.AdManager.v202208.AdjustmentService.getTrafficForecastSegmentsByStatement ( Google.Api.Ads.AdManager.v202208.Statement  filterStatement)
inlinevirtual

Gets a TrafficForecastSegmentPage of TrafficForecastSegment objects that satisfy the given Statement::query.

The following fields are supported for filtering:

PQL Property Object Property
id TrafficForecastSegment::id
name TrafficForecastSegment::name
creationTime TrafficForecastSegment::creationTime
Parameters
filterStatementa Publisher Query Language statement to filter a list of traffic forecast segments
Returns
a page of traffic forecast segments that match the filter

Implements Google.Api.Ads.AdManager.v202208.AdjustmentServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.TrafficForecastSegmentPage> Google.Api.Ads.AdManager.v202208.AdjustmentService.getTrafficForecastSegmentsByStatementAsync ( Google.Api.Ads.AdManager.v202208.Statement  filterStatement)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.UpdateResult Google.Api.Ads.AdManager.v202208.AdjustmentService.performForecastAdjustmentAction ( Google.Api.Ads.AdManager.v202208.ForecastAdjustmentAction  forecastAdjustmentAction,
Google.Api.Ads.AdManager.v202208.Statement  filterStatement 
)
inlinevirtual

Performs actions on ForecastAdjustment objects that match the given Statement::query.

Parameters
forecastAdjustmentActionthe action to perform
filterStatementa Publisher Query Language statement used to filter a set of forecast adjustments
Returns
the result of the action performed

Implements Google.Api.Ads.AdManager.v202208.AdjustmentServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.UpdateResult> Google.Api.Ads.AdManager.v202208.AdjustmentService.performForecastAdjustmentActionAsync ( Google.Api.Ads.AdManager.v202208.ForecastAdjustmentAction  forecastAdjustmentAction,
Google.Api.Ads.AdManager.v202208.Statement  filterStatement 
)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.ForecastAdjustment [] Google.Api.Ads.AdManager.v202208.AdjustmentService.updateForecastAdjustments ( Google.Api.Ads.AdManager.v202208.ForecastAdjustment[]  forecastAdjustments)
inlinevirtual

Updates the specified ForecastAdjustment objects.

Parameters
forecastAdjustmentsthe forecast adjustments to update
Returns
the updated forecast adjustments
Exceptions
ApiExceptionif there is an error updating the forecast adjustments

Implements Google.Api.Ads.AdManager.v202208.IAdjustmentService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.ForecastAdjustment[]> Google.Api.Ads.AdManager.v202208.AdjustmentService.updateForecastAdjustmentsAsync ( Google.Api.Ads.AdManager.v202208.ForecastAdjustment[]  forecastAdjustments)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202208.TrafficForecastSegment [] Google.Api.Ads.AdManager.v202208.AdjustmentService.updateTrafficForecastSegments ( Google.Api.Ads.AdManager.v202208.TrafficForecastSegment[]  trafficForecastSegments)
inlinevirtual

Updates the specified TrafficForecastSegment objects.

Parameters
trafficForecastSegmentsthe traffic forecast segments to update
Returns
the updated traffic forecast segments
Exceptions
ApiExceptionif there is an error updating the traffic forecast segments

Implements Google.Api.Ads.AdManager.v202208.IAdjustmentService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202208.TrafficForecastSegment[]> Google.Api.Ads.AdManager.v202208.AdjustmentService.updateTrafficForecastSegmentsAsync ( Google.Api.Ads.AdManager.v202208.TrafficForecastSegment[]  trafficForecastSegments)
inlinevirtual

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