// 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.
package com.google.api.ads.dfp.jaxws.v201608;
import java.util.List;
import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebResult;
import javax.jws.WebService;
import javax.xml.bind.annotation.XmlSeeAlso;
import javax.xml.ws.RequestWrapper;
import javax.xml.ws.ResponseWrapper;
/**
*
* Provides methods for updating and retrieving {@link ProductPackage} objects.
* <p>
* A {@link ProductPackage} represents a group of products which will be sold together.
*
* <p>
* To use this service, you need to have the new sales management solution
* enabled on your network. If you do not see a "Sales" tab in
* <a href="https://www.google.com/dfp">DoubleClick for Publishers (DFP)</a>,
* you will not be able to use this service.
*
*
* This class was generated by the JAX-WS RI.
* JAX-WS RI 2.2.9-b130926.1035
* Generated source version: 2.1
*
*/
@WebService(name = "ProductPackageServiceInterface", targetNamespace = "https://www.google.com/apis/ads/publisher/v201608")
@XmlSeeAlso({
ObjectFactory.class
})
public interface ProductPackageServiceInterface {
/**
*
* Creates new {@link ProductPackage} objects.
*
* @param productPackages the product packages to create
* @return the persisted product packages with their ID filled in
*
*
* @param productPackages
* @return
* returns java.util.List<com.google.api.ads.dfp.jaxws.v201608.ProductPackage>
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201608")
@RequestWrapper(localName = "createProductPackages", targetNamespace = "https://www.google.com/apis/ads/publisher/v201608", className = "com.google.api.ads.dfp.jaxws.v201608.ProductPackageServiceInterfacecreateProductPackages")
@ResponseWrapper(localName = "createProductPackagesResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201608", className = "com.google.api.ads.dfp.jaxws.v201608.ProductPackageServiceInterfacecreateProductPackagesResponse")
public List<ProductPackage> createProductPackages(
@WebParam(name = "productPackages", targetNamespace = "https://www.google.com/apis/ads/publisher/v201608")
List<ProductPackage> productPackages)
throws ApiException_Exception
;
/**
*
* Gets a {@link ProductPackagePage} of {@link ProductPackage} objects
* that satisfy the filtering criteria specified by 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 ProductPackage#id}</td>
* </tr>
* <tr>
* <td>{@code name}</td>
* <td>{@link ProductPackage#name}</td>
* </tr>
* <tr>
* <td>{@code notes}</td>
* <td>{@link ProductPackage#notes}</td>
* </tr>
* <tr>
* <td>{@code status}</td>
* <td>{@link ProductPackage#status}</td>
* </tr>
* <tr>
* <td>{@code isArchived}</td>
* <td>{@link ProductPackage#isArchived}</td>
* </tr>
* <tr>
* <td>{@code lastModifiedDateTime}</td>
* <td>{@link ProductPackage#lastModifiedDateTime}</td>
* </tr>
* </table>
*
* @param statement a Publisher Query Language statement which specifies the
* filtering criteria over product packages
* @return the product packages that match the given statement
*
*
* @param statement
* @return
* returns com.google.api.ads.dfp.jaxws.v201608.ProductPackagePage
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201608")
@RequestWrapper(localName = "getProductPackagesByStatement", targetNamespace = "https://www.google.com/apis/ads/publisher/v201608", className = "com.google.api.ads.dfp.jaxws.v201608.ProductPackageServiceInterfacegetProductPackagesByStatement")
@ResponseWrapper(localName = "getProductPackagesByStatementResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201608", className = "com.google.api.ads.dfp.jaxws.v201608.ProductPackageServiceInterfacegetProductPackagesByStatementResponse")
public ProductPackagePage getProductPackagesByStatement(
@WebParam(name = "statement", targetNamespace = "https://www.google.com/apis/ads/publisher/v201608")
Statement statement)
throws ApiException_Exception
;
/**
*
* Performs actions on {@link ProductPackage} objects that match the given {@link
* Statement#query}.
*
* @param action the action to perform
* @param statement a Publisher Query Language statement used to filter a set of product packages
* @return the result of the action performed
*
*
* @param statement
* @param action
* @return
* returns com.google.api.ads.dfp.jaxws.v201608.UpdateResult
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201608")
@RequestWrapper(localName = "performProductPackageAction", targetNamespace = "https://www.google.com/apis/ads/publisher/v201608", className = "com.google.api.ads.dfp.jaxws.v201608.ProductPackageServiceInterfaceperformProductPackageAction")
@ResponseWrapper(localName = "performProductPackageActionResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201608", className = "com.google.api.ads.dfp.jaxws.v201608.ProductPackageServiceInterfaceperformProductPackageActionResponse")
public UpdateResult performProductPackageAction(
@WebParam(name = "action", targetNamespace = "https://www.google.com/apis/ads/publisher/v201608")
ProductPackageAction action,
@WebParam(name = "statement", targetNamespace = "https://www.google.com/apis/ads/publisher/v201608")
Statement statement)
throws ApiException_Exception
;
/**
*
* Updates the specified {@link ProductPackage} objects.
*
* @param productPackages the product packages to update
* @return the updated product packages
*
*
* @param productPackages
* @return
* returns java.util.List<com.google.api.ads.dfp.jaxws.v201608.ProductPackage>
* @throws ApiException_Exception
*/
@WebMethod
@WebResult(name = "rval", targetNamespace = "https://www.google.com/apis/ads/publisher/v201608")
@RequestWrapper(localName = "updateProductPackages", targetNamespace = "https://www.google.com/apis/ads/publisher/v201608", className = "com.google.api.ads.dfp.jaxws.v201608.ProductPackageServiceInterfaceupdateProductPackages")
@ResponseWrapper(localName = "updateProductPackagesResponse", targetNamespace = "https://www.google.com/apis/ads/publisher/v201608", className = "com.google.api.ads.dfp.jaxws.v201608.ProductPackageServiceInterfaceupdateProductPackagesResponse")
public List<ProductPackage> updateProductPackages(
@WebParam(name = "productPackages", targetNamespace = "https://www.google.com/apis/ads/publisher/v201608")
List<ProductPackage> productPackages)
throws ApiException_Exception
;
}