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

This service provides operations for retrieving and approving SuggestedAdUnit objects. More...

Inheritance diagram for Google.Api.Ads.AdManager.v202111.SuggestedAdUnitService:
Google.Api.Ads.AdManager.v202111.ISuggestedAdUnitService Google.Api.Ads.AdManager.v202111.SuggestedAdUnitServiceInterface

Public Member Functions

 SuggestedAdUnitService ()
 Creates a new instance of the SuggestedAdUnitService class. More...
 
 SuggestedAdUnitService (string endpointConfigurationName)
 Creates a new instance of the SuggestedAdUnitService class. More...
 
 SuggestedAdUnitService (string endpointConfigurationName, string remoteAddress)
 Creates a new instance of the SuggestedAdUnitService class. More...
 
 SuggestedAdUnitService (string endpointConfigurationName, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the SuggestedAdUnitService class. More...
 
 SuggestedAdUnitService (System.ServiceModel.Channels.Binding binding, System.ServiceModel.EndpointAddress remoteAddress)
 Creates a new instance of the SuggestedAdUnitService class. More...
 
virtual
Google.Api.Ads.AdManager.v202111.SuggestedAdUnitPage 
getSuggestedAdUnitsByStatement (Google.Api.Ads.AdManager.v202111.Statement filterStatement)
 Gets a SuggestedAdUnitPage of SuggestedAdUnit objects that satisfy the filter query. There is a system-enforced limit of 1000 on the number of suggested ad units that are suggested at any one time. More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202111.SuggestedAdUnitPage
getSuggestedAdUnitsByStatementAsync (Google.Api.Ads.AdManager.v202111.Statement filterStatement)
 
virtual
Google.Api.Ads.AdManager.v202111.SuggestedAdUnitUpdateResult 
performSuggestedAdUnitAction (Google.Api.Ads.AdManager.v202111.SuggestedAdUnitAction suggestedAdUnitAction, Google.Api.Ads.AdManager.v202111.Statement filterStatement)
 Performs actions on SuggestedAdUnit objects that match the given Statement::query. The following fields are supported for filtering: More...
 
virtual
System.Threading.Tasks.Task
< Google.Api.Ads.AdManager.v202111.SuggestedAdUnitUpdateResult
performSuggestedAdUnitActionAsync (Google.Api.Ads.AdManager.v202111.SuggestedAdUnitAction suggestedAdUnitAction, Google.Api.Ads.AdManager.v202111.Statement filterStatement)
 

Detailed Description

This service provides operations for retrieving and approving SuggestedAdUnit objects.

Publishers may create ad tags that lack a corresponding ad unit defined in DFP, in order to gather information about potential ads without needing to create dummy ad units and make them available for targeting in line items. Any undefined ad unit to receive more than ten serving requests in the past week is treated as a 'suggested ad unit'. These can be queried by the client and selectively approved. Approval causes a new ad unit to be created based on the suggested ad unit. Unapproved suggested ad units cease to exist whenever their corresponding ad tag has been served fewer than ten times in the past seven days.

This service is only available to Premium publishers. Before use, suggested ad units must be enabled for the client's network. This can be done in the UI: in the Inventory tab, click "Network settings" in the left-hand panel, then enable the checkbox "Get suggestions for new ad units." If suggested ad units are not enabled, then #getSuggestedAdUnitsByStatement will always return an empty page.

Constructor & Destructor Documentation

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

Creates a new instance of the SuggestedAdUnitService class.

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

Creates a new instance of the SuggestedAdUnitService class.

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

Creates a new instance of the SuggestedAdUnitService class.

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

Creates a new instance of the SuggestedAdUnitService class.

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

Creates a new instance of the SuggestedAdUnitService class.

Member Function Documentation

virtual Google.Api.Ads.AdManager.v202111.SuggestedAdUnitPage Google.Api.Ads.AdManager.v202111.SuggestedAdUnitService.getSuggestedAdUnitsByStatement ( Google.Api.Ads.AdManager.v202111.Statement  filterStatement)
inlinevirtual

Gets a SuggestedAdUnitPage of SuggestedAdUnit objects that satisfy the filter query. There is a system-enforced limit of 1000 on the number of suggested ad units that are suggested at any one time.

PQL Property Object Property
id SuggestedAdUnit::id
numRequests SuggestedAdUnit::numRequests

Note: After API version 201311, the id field will only be numerical.

Parameters
filterStatementa Publisher Query Language statement used to filter a set of suggested ad units
Returns
the suggested ad units that match the given filter

Implements Google.Api.Ads.AdManager.v202111.SuggestedAdUnitServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202111.SuggestedAdUnitPage> Google.Api.Ads.AdManager.v202111.SuggestedAdUnitService.getSuggestedAdUnitsByStatementAsync ( Google.Api.Ads.AdManager.v202111.Statement  filterStatement)
inlinevirtual
virtual Google.Api.Ads.AdManager.v202111.SuggestedAdUnitUpdateResult Google.Api.Ads.AdManager.v202111.SuggestedAdUnitService.performSuggestedAdUnitAction ( Google.Api.Ads.AdManager.v202111.SuggestedAdUnitAction  suggestedAdUnitAction,
Google.Api.Ads.AdManager.v202111.Statement  filterStatement 
)
inlinevirtual

Performs actions on SuggestedAdUnit objects that match the given Statement::query. The following fields are supported for filtering:

PQL Property Object Property
id SuggestedAdUnit::id
numRequests SuggestedAdUnit::numRequests
Parameters
suggestedAdUnitActionthe action to perform
filterStatementa Publisher Query Language statement used to filter a set of suggested ad units
Returns
the result of the action performed

Implements Google.Api.Ads.AdManager.v202111.SuggestedAdUnitServiceInterface.

virtual System.Threading.Tasks.Task<Google.Api.Ads.AdManager.v202111.SuggestedAdUnitUpdateResult> Google.Api.Ads.AdManager.v202111.SuggestedAdUnitService.performSuggestedAdUnitActionAsync ( Google.Api.Ads.AdManager.v202111.SuggestedAdUnitAction  suggestedAdUnitAction,
Google.Api.Ads.AdManager.v202111.Statement  filterStatement 
)
inlinevirtual

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