// Copyright 2016 Google Inc. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
/**
* SuggestedAdUnitServiceInterface.java
*
* This file was auto-generated from WSDL
* by the Apache Axis 1.4 Mar 02, 2009 (07:08:06 PST) WSDL2Java emitter.
*/
package com.google.api.ads.dfp.axis.v201608;
public interface SuggestedAdUnitServiceInterface extends java.rmi.Remote {
/**
* Gets a {@link SuggestedAdUnitPage} of {@link 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.
*
* <table>
* <tr>
* <th scope="col">PQL Property</th> <th scope="col">Object Property</th>
* </tr>
* <tr>
* <td>{@code id}</td>
* <td>{@link SuggestedAdUnit#id}</td>
* </tr>
* <tr>
* <td>{@code numRequests}</td>
* <td>{@link SuggestedAdUnit#numRequests}</td>
* </tr>
* </table>
*
* <p><strong>Note:</strong> After API version 201311, the {@code
* id} field will only be
* numerical.
*
*
* @param filterStatement a Publisher Query Language statement used to
* filter
* a set of suggested ad units
*
* @return the suggested ad units that match the given filter
*/
public com.google.api.ads.dfp.axis.v201608.SuggestedAdUnitPage getSuggestedAdUnitsByStatement(com.google.api.ads.dfp.axis.v201608.Statement filterStatement) throws java.rmi.RemoteException, com.google.api.ads.dfp.axis.v201608.ApiException;
/**
* Performs actions on {@link SuggestedAdUnit} objects that match
* the given
* {@link Statement#query}. The following fields are supported
* for filtering:
*
* <table>
* <tr>
* <th scope="col">PQL Property</th> <th scope="col">Object Property</th>
* </tr>
* <tr>
* <td>{@code id}</td>
* <td>{@link SuggestedAdUnit#id}</td>
* </tr>
* <tr>
* <td>{@code numRequests}</td>
* <td>{@link SuggestedAdUnit#numRequests}</td>
* </tr>
* </table>
*
*
* @param suggestedAdUnitAction the action to perform
*
* @param filterStatement a Publisher Query Language statement used to
* filter
* a set of suggested ad units
*
* @return the result of the action performed
*/
public com.google.api.ads.dfp.axis.v201608.SuggestedAdUnitUpdateResult performSuggestedAdUnitAction(com.google.api.ads.dfp.axis.v201608.SuggestedAdUnitAction suggestedAdUnitAction, com.google.api.ads.dfp.axis.v201608.Statement filterStatement) throws java.rmi.RemoteException, com.google.api.ads.dfp.axis.v201608.ApiException;
}