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

Provides methods for creating, updating and retrieving AdRule objects. More...

Inheritance diagram for Google.Api.Ads.AdManager.v202111.AdRuleService:
Google.Api.Ads.AdManager.v202111.IAdRuleService Google.Api.Ads.AdManager.v202111.AdRuleServiceInterface

Public Member Functions

 AdRuleService ()
 Creates a new instance of the AdRuleService class. More...
 
 AdRuleService (string endpointConfigurationName)
 Creates a new instance of the AdRuleService class. More...
 
 AdRuleService (string endpointConfigurationName, string remoteAddress)
 Creates a new instance of the AdRuleService class. More...
 
 AdRuleService (string endpointConfigurationName, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the AdRuleService class. More...
 
 AdRuleService (System.ServiceModel.Channels.Binding binding, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the AdRuleService class. More...
 
virtual
Google.Api.Ads.AdManager.v202111.AdRule[] 
createAdRules (Google.Api.Ads.AdManager.v202111.AdRule[] adRules)
 Creates new AdRule objects. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202111.AdRule[]> 
createAdRulesAsync (Google.Api.Ads.AdManager.v202111.AdRule[] adRules)
 
virtual
Google.Api.Ads.AdManager.v202111.AdSpot[] 
createAdSpots (Google.Api.Ads.AdManager.v202111.AdSpot[] adSpots)
 Creates new AdSpot objects. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202111.AdSpot[]> 
createAdSpotsAsync (Google.Api.Ads.AdManager.v202111.AdSpot[] adSpots)
 
virtual
Google.Api.Ads.AdManager.v202111.BreakTemplate[] 
createBreakTemplates (Google.Api.Ads.AdManager.v202111.BreakTemplate[] breakTemplate)
 Creates new breakTemplate objects. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202111.BreakTemplate[]> 
createBreakTemplatesAsync (Google.Api.Ads.AdManager.v202111.BreakTemplate[] breakTemplate)
 
virtual
Google.Api.Ads.AdManager.v202111.AdRulePage 
getAdRulesByStatement (Google.Api.Ads.AdManager.v202111.Statement statement)
 Gets an AdRulePage of AdRule objects that satisfy the given Statement::query. The following fields are supported for filtering: More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202111.AdRulePage
getAdRulesByStatementAsync (Google.Api.Ads.AdManager.v202111.Statement statement)
 
virtual
Google.Api.Ads.AdManager.v202111.AdSpotPage 
getAdSpotsByStatement (Google.Api.Ads.AdManager.v202111.Statement filterStatement)
 Gets a AdSpotPage of AdSpot objects that satisfy the given Statement::query. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202111.AdSpotPage
getAdSpotsByStatementAsync (Google.Api.Ads.AdManager.v202111.Statement filterStatement)
 
virtual
Google.Api.Ads.AdManager.v202111.BreakTemplatePage 
getBreakTemplatesByStatement (Google.Api.Ads.AdManager.v202111.Statement filterStatement)
 Gets a BreakTemplatePage of BreakTemplate objects that satisfy the given Statement::query. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202111.BreakTemplatePage
getBreakTemplatesByStatementAsync (Google.Api.Ads.AdManager.v202111.Statement filterStatement)
 
virtual
Google.Api.Ads.AdManager.v202111.UpdateResult 
performAdRuleAction (Google.Api.Ads.AdManager.v202111.AdRuleAction adRuleAction, Google.Api.Ads.AdManager.v202111.Statement filterStatement)
 Performs actions on AdRule objects that match the given Statement::query. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202111.UpdateResult
performAdRuleActionAsync (Google.Api.Ads.AdManager.v202111.AdRuleAction adRuleAction, Google.Api.Ads.AdManager.v202111.Statement filterStatement)
 
virtual
Google.Api.Ads.AdManager.v202111.AdRule[] 
updateAdRules (Google.Api.Ads.AdManager.v202111.AdRule[] adRules)
 Updates the specified AdRule objects. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202111.AdRule[]> 
updateAdRulesAsync (Google.Api.Ads.AdManager.v202111.AdRule[] adRules)
 
virtual
Google.Api.Ads.AdManager.v202111.AdSpot[] 
updateAdSpots (Google.Api.Ads.AdManager.v202111.AdSpot[] adSpots)
 Updates the specified AdSpot objects. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202111.AdSpot[]> 
updateAdSpotsAsync (Google.Api.Ads.AdManager.v202111.AdSpot[] adSpots)
 
virtual
Google.Api.Ads.AdManager.v202111.BreakTemplate[] 
updateBreakTemplates (Google.Api.Ads.AdManager.v202111.BreakTemplate[] breakTemplate)
 Updates the specified breakTemplate objects. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202111.BreakTemplate[]> 
updateBreakTemplatesAsync (Google.Api.Ads.AdManager.v202111.BreakTemplate[] breakTemplate)
 

Detailed Description

Provides methods for creating, updating and retrieving AdRule objects.

Ad rules contain data that the ad server uses to generate a playlist of video ads.

Constructor & Destructor Documentation

Google.Api.Ads.AdManager.v202111.AdRuleService.AdRuleService ( )
inline

Creates a new instance of the AdRuleService class.

Google.Api.Ads.AdManager.v202111.AdRuleService.AdRuleService ( string  endpointConfigurationName)
inline

Creates a new instance of the AdRuleService class.

Google.Api.Ads.AdManager.v202111.AdRuleService.AdRuleService ( string  endpointConfigurationName,
string  remoteAddress 
)
inline

Creates a new instance of the AdRuleService class.

Google.Api.Ads.AdManager.v202111.AdRuleService.AdRuleService ( string  endpointConfigurationName,
System.ServiceModel.EndpointAddress  remoteAddress 
)
inline

Creates a new instance of the AdRuleService class.

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

Creates a new instance of the AdRuleService class.

Member Function Documentation

virtual Google.Api.Ads.AdManager.v202111.AdRule [] Google.Api.Ads.AdManager.v202111.AdRuleService.createAdRules ( Google.Api.Ads.AdManager.v202111.AdRule[]  adRules)
inlinevirtual

Creates new AdRule objects.

Parameters
adRulesthe ad rules to create
Returns
the created ad rules with their IDs filled in

Implements Google.Api.Ads.AdManager.v202111.IAdRuleService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202111.AdRule[]> Google.Api.Ads.AdManager.v202111.AdRuleService.createAdRulesAsync ( Google.Api.Ads.AdManager.v202111.AdRule[]  adRules)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202111.AdSpot [] Google.Api.Ads.AdManager.v202111.AdRuleService.createAdSpots ( Google.Api.Ads.AdManager.v202111.AdSpot[]  adSpots)
inlinevirtual

Creates new AdSpot objects.

Parameters
adSpotsthe ad spots to create
Returns
the created ad spots with their IDs filled in

Implements Google.Api.Ads.AdManager.v202111.IAdRuleService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202111.AdSpot[]> Google.Api.Ads.AdManager.v202111.AdRuleService.createAdSpotsAsync ( Google.Api.Ads.AdManager.v202111.AdSpot[]  adSpots)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202111.BreakTemplate [] Google.Api.Ads.AdManager.v202111.AdRuleService.createBreakTemplates ( Google.Api.Ads.AdManager.v202111.BreakTemplate[]  breakTemplate)
inlinevirtual

Creates new breakTemplate objects.

Parameters
breakTemplatethe break template to create
Returns
the created break template with their IDs filled in

Implements Google.Api.Ads.AdManager.v202111.IAdRuleService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202111.BreakTemplate[]> Google.Api.Ads.AdManager.v202111.AdRuleService.createBreakTemplatesAsync ( Google.Api.Ads.AdManager.v202111.BreakTemplate[]  breakTemplate)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202111.AdRulePage Google.Api.Ads.AdManager.v202111.AdRuleService.getAdRulesByStatement ( Google.Api.Ads.AdManager.v202111.Statement  statement)
inlinevirtual

Gets an AdRulePage of AdRule objects that satisfy the given Statement::query. The following fields are supported for filtering:

PQL Property Object Property
id AdRule::id (AdRule::adRuleId beginning in v201702)
name AdRule::name
priority AdRule::priority
status AdRule::status
Parameters
statementa Publisher Query Language statement used to filter a set of ad rules
Returns
the ad rules that match the given filter
Exceptions
ApiExceptionif the ID of the active network does not exist or there is a backend error

Implements Google.Api.Ads.AdManager.v202111.AdRuleServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202111.AdRulePage> Google.Api.Ads.AdManager.v202111.AdRuleService.getAdRulesByStatementAsync ( Google.Api.Ads.AdManager.v202111.Statement  statement)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202111.AdSpotPage Google.Api.Ads.AdManager.v202111.AdRuleService.getAdSpotsByStatement ( Google.Api.Ads.AdManager.v202111.Statement  filterStatement)
inlinevirtual

Gets a AdSpotPage of AdSpot objects that satisfy the given Statement::query.

Parameters
filterStatementa Publisher Query Language statement to filter a list of ad spots
Returns
the ad spots that match the filter

Implements Google.Api.Ads.AdManager.v202111.AdRuleServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202111.AdSpotPage> Google.Api.Ads.AdManager.v202111.AdRuleService.getAdSpotsByStatementAsync ( Google.Api.Ads.AdManager.v202111.Statement  filterStatement)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202111.BreakTemplatePage Google.Api.Ads.AdManager.v202111.AdRuleService.getBreakTemplatesByStatement ( Google.Api.Ads.AdManager.v202111.Statement  filterStatement)
inlinevirtual

Gets a BreakTemplatePage of BreakTemplate objects that satisfy the given Statement::query.

Parameters
filterStatementa Publisher Query Language statement to filter a list of breakTemplate
Returns
the break template that match the filter

Implements Google.Api.Ads.AdManager.v202111.AdRuleServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202111.BreakTemplatePage> Google.Api.Ads.AdManager.v202111.AdRuleService.getBreakTemplatesByStatementAsync ( Google.Api.Ads.AdManager.v202111.Statement  filterStatement)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202111.UpdateResult Google.Api.Ads.AdManager.v202111.AdRuleService.performAdRuleAction ( Google.Api.Ads.AdManager.v202111.AdRuleAction  adRuleAction,
Google.Api.Ads.AdManager.v202111.Statement  filterStatement 
)
inlinevirtual

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

Parameters
adRuleActionthe action to perform
filterStatementa Publisher Query Language statement used to filter a set of ad rules
Returns
the result of the action performed

Implements Google.Api.Ads.AdManager.v202111.AdRuleServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202111.UpdateResult> Google.Api.Ads.AdManager.v202111.AdRuleService.performAdRuleActionAsync ( Google.Api.Ads.AdManager.v202111.AdRuleAction  adRuleAction,
Google.Api.Ads.AdManager.v202111.Statement  filterStatement 
)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202111.AdRule [] Google.Api.Ads.AdManager.v202111.AdRuleService.updateAdRules ( Google.Api.Ads.AdManager.v202111.AdRule[]  adRules)
inlinevirtual

Updates the specified AdRule objects.

Parameters
adRulesthe ad rules to update
Returns
the updated ad rules
Exceptions
ApiExceptionif there is an error updating the ad rules

Implements Google.Api.Ads.AdManager.v202111.IAdRuleService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202111.AdRule[]> Google.Api.Ads.AdManager.v202111.AdRuleService.updateAdRulesAsync ( Google.Api.Ads.AdManager.v202111.AdRule[]  adRules)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202111.AdSpot [] Google.Api.Ads.AdManager.v202111.AdRuleService.updateAdSpots ( Google.Api.Ads.AdManager.v202111.AdSpot[]  adSpots)
inlinevirtual

Updates the specified AdSpot objects.

Parameters
adSpotsthe ad spots to update
Returns
the updated ad spots
Exceptions
ApiExceptionif there is an error updating the ad spots

Implements Google.Api.Ads.AdManager.v202111.IAdRuleService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202111.AdSpot[]> Google.Api.Ads.AdManager.v202111.AdRuleService.updateAdSpotsAsync ( Google.Api.Ads.AdManager.v202111.AdSpot[]  adSpots)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202111.BreakTemplate [] Google.Api.Ads.AdManager.v202111.AdRuleService.updateBreakTemplates ( Google.Api.Ads.AdManager.v202111.BreakTemplate[]  breakTemplate)
inlinevirtual

Updates the specified breakTemplate objects.

Parameters
breakTemplatethe break template to update
Returns
the updated break template

Implements Google.Api.Ads.AdManager.v202111.IAdRuleService.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202111.BreakTemplate[]> Google.Api.Ads.AdManager.v202111.AdRuleService.updateBreakTemplatesAsync ( Google.Api.Ads.AdManager.v202111.BreakTemplate[]  breakTemplate)
inlinevirtual

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