public interface SuggestedAdUnitServiceInterface
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(com.google.api.ads.dfp.jaxws.v201805.Statement)
will always return an empty page.
This class was generated by the JAX-WS RI.
JAX-WS RI 2.2.9-b130926.1035
Generated source version: 2.1
| Modifier and Type | Method and Description |
|---|---|
SuggestedAdUnitPage |
getSuggestedAdUnitsByStatement(Statement filterStatement)
Gets a
SuggestedAdUnitPage of SuggestedAdUnit objects that
satisfy the filter query. |
SuggestedAdUnitUpdateResult |
performSuggestedAdUnitAction(SuggestedAdUnitAction suggestedAdUnitAction,
Statement filterStatement)
Performs actions on
SuggestedAdUnit objects that match the given
Statement.query. |
@RequestWrapper(localName="getSuggestedAdUnitsByStatement", targetNamespace="https://www.google.com/apis/ads/publisher/v201805", className="com.google.api.ads.dfp.jaxws.v201805.SuggestedAdUnitServiceInterfacegetSuggestedAdUnitsByStatement") @ResponseWrapper(localName="getSuggestedAdUnitsByStatementResponse", targetNamespace="https://www.google.com/apis/ads/publisher/v201805", className="com.google.api.ads.dfp.jaxws.v201805.SuggestedAdUnitServiceInterfacegetSuggestedAdUnitsByStatementResponse") SuggestedAdUnitPage getSuggestedAdUnitsByStatement(Statement filterStatement) throws ApiException_Exception
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.
filterStatement - a Publisher Query Language statement used to filter
a set of suggested ad unitsfilterStatement - ApiException_Exception@RequestWrapper(localName="performSuggestedAdUnitAction", targetNamespace="https://www.google.com/apis/ads/publisher/v201805", className="com.google.api.ads.dfp.jaxws.v201805.SuggestedAdUnitServiceInterfaceperformSuggestedAdUnitAction") @ResponseWrapper(localName="performSuggestedAdUnitActionResponse", targetNamespace="https://www.google.com/apis/ads/publisher/v201805", className="com.google.api.ads.dfp.jaxws.v201805.SuggestedAdUnitServiceInterfaceperformSuggestedAdUnitActionResponse") SuggestedAdUnitUpdateResult performSuggestedAdUnitAction(SuggestedAdUnitAction suggestedAdUnitAction, Statement filterStatement) throws ApiException_Exception
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 |
suggestedAdUnitAction - the action to performfilterStatement - a Publisher Query Language statement used to filter
a set of suggested ad unitssuggestedAdUnitAction - filterStatement - ApiException_ExceptionCopyright © 2018. All Rights Reserved.