com.google.api.ads.dfp.axis.v201708

Class ProductServiceSoapBindingStub

java.lang.Object

org.apache.axis.client.Stub

com.google.api.ads.dfp.axis.v201708.ProductServiceSoapBindingStub

All Implemented Interfaces:

ProductServiceInterface, Remote, javax.xml.rpc.Stub

public class ProductServiceSoapBindingStub
extends org.apache.axis.client.Stub
implements ProductServiceInterface

Field Summary

Fields inherited from class org.apache.axis.client.Stub

_call, cachedEndpoint, cachedPassword, cachedPortName, cachedProperties, cachedTimeout, cachedUsername, maintainSession, maintainSessionSet, service

Fields inherited from interface javax.xml.rpc.Stub

ENDPOINT_ADDRESS_PROPERTY, PASSWORD_PROPERTY, SESSION_MAINTAIN_PROPERTY, USERNAME_PROPERTY

Constructor Summary

Constructors

Constructor and Description
ProductServiceSoapBindingStub()
ProductServiceSoapBindingStub(javax.xml.rpc.Service service)
ProductServiceSoapBindingStub(URL endpointURL, javax.xml.rpc.Service service)

Method Summary

Modifier and Type	Method and Description
protected org.apache.axis.client.Call	createCall()
Product[]	createProducts(Product[] products) Creates new Product objects.
ProductPage	getProductsByStatement(Statement statement) Gets a ProductPage of Product objects that satisfy the criteria specified by given Statement.query.
UpdateResult	performProductAction(ProductAction productAction, Statement filterStatement) Performs action on Product objects that satisfy the given Statement.
Product[]	updateProducts(Product[] products) Updates the specified Product objects.

Methods inherited from class org.apache.axis.client.Stub

_createCall, _getCall, _getProperty, _getPropertyNames, _getService, _setProperty, addAttachment, clearAttachments, clearHeaders, extractAttachments, firstCall, getAttachments, getHeader, getHeaders, getPassword, getPortName, getResponseHeader, getResponseHeaders, getResponseHeaders, getTimeout, getUsername, removeProperty, setAttachments, setHeader, setHeader, setMaintainSession, setPassword, setPortName, setPortName, setRequestHeaders, setTimeout, setUsername

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProductServiceSoapBindingStub

public ProductServiceSoapBindingStub()
                              throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

ProductServiceSoapBindingStub

public ProductServiceSoapBindingStub(URL endpointURL,
                                     javax.xml.rpc.Service service)
                              throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

ProductServiceSoapBindingStub

public ProductServiceSoapBindingStub(javax.xml.rpc.Service service)
                              throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

Method Detail

createCall

protected org.apache.axis.client.Call createCall()
                                          throws RemoteException

Throws:

RemoteException

createProducts

public Product[] createProducts(Product[] products)
                         throws RemoteException,
                                ApiException

Description copied from interface: ProductServiceInterface

Creates new Product objects. This method is only available when creating programmatic guaranteed products when not using sales management.

Specified by:

createProducts in interface ProductServiceInterface

Parameters:

products - the products to create

Returns:

the created products with their IDs filled in

Throws:

RemoteException

ApiException

getProductsByStatement

public ProductPage getProductsByStatement(Statement statement)
                                   throws RemoteException,
                                          ApiException

Description copied from interface: ProductServiceInterface

Gets a ProductPage of Product objects that satisfy the criteria specified by given Statement.query.

When using sales management, the following fields are supported for filtering and/or sorting.

PQL Property	Object Property	Filterable	Sortable
rateCardId	Rate card ID which the product is associated with	Yes	No
status	Product.status	Yes	Yes
lineItemType	Product.lineItemType	Yes	Yes
productType	Product.productType	Yes	Yes
rateType	Product.rateType	Yes	Yes
productTemplateId	Product.productTemplateId	Yes	No
name	Product.name	Yes	Yes
description	Product#description	Yes	No
id	Product.id	Yes	Yes
lastModifiedDateTime	Product.lastModifiedDateTime	Yes	Yes

When using programmatic guaranteed and not sales management, the following fields are supported for filtering and/or sorting.

PQL Property	Object Property	Filterable	Sortable
status	Product.status	Yes	Yes
rateType	Product.rateType	Yes	Yes
name	Product.name	Yes	Yes
id	Product.id	Yes	Yes
lastModifiedDateTime	Product.lastModifiedDateTime	Yes	Yes

Specified by:

getProductsByStatement in interface ProductServiceInterface

Parameters:

statement - a Publisher Query Language statement which specifies the filtering criteria over products

Returns:

the products that match the given statement

Throws:

RemoteException

ApiException

performProductAction

public UpdateResult performProductAction(ProductAction productAction,
                                         Statement filterStatement)
                                  throws RemoteException,
                                         ApiException

Description copied from interface: ProductServiceInterface

Performs action on Product objects that satisfy the given Statement.

Specified by:

performProductAction in interface ProductServiceInterface

Parameters:

productAction - the action to perform

filterStatement - a Publisher Query Language statement used to filter a set of products.

Returns:

the result of the action performed

Throws:

RemoteException

ApiException

updateProducts

public Product[] updateProducts(Product[] products)
                         throws RemoteException,
                                ApiException

Description copied from interface: ProductServiceInterface

Updates the specified Product objects. Note non-updatable fields will not be backfilled.

Specified by:

updateProducts in interface ProductServiceInterface

Parameters:

products - the products to update

Returns:

the updated products

Throws:

RemoteException

ApiException