com.google.api.ads.dfp.axis.v201208

Class CustomTargetingServiceSoapBindingStub

java.lang.Object

org.apache.axis.client.Stub

com.google.api.ads.dfp.axis.v201208.CustomTargetingServiceSoapBindingStub

All Implemented Interfaces:

CustomTargetingServiceInterface, Remote, javax.xml.rpc.Stub

public class CustomTargetingServiceSoapBindingStub
extends org.apache.axis.client.Stub
implements CustomTargetingServiceInterface

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
CustomTargetingServiceSoapBindingStub()
CustomTargetingServiceSoapBindingStub(javax.xml.rpc.Service service)
CustomTargetingServiceSoapBindingStub(URL endpointURL, javax.xml.rpc.Service service)

Method Summary

Methods

Modifier and Type	Method and Description
protected org.apache.axis.client.Call	createCall()
CustomTargetingKey[]	createCustomTargetingKeys(CustomTargetingKey[] keys) Creates new CustomTargetingKey objects.
CustomTargetingValue[]	createCustomTargetingValues(CustomTargetingValue[] values) Creates new CustomTargetingValue objects.
CustomTargetingKeyPage	getCustomTargetingKeysByStatement(Statement filterStatement) Gets a CustomTargetingKeyPage of CustomTargetingKey objects that satisfy the given Statement.query.
CustomTargetingValuePage	getCustomTargetingValuesByStatement(Statement filterStatement) Gets a CustomTargetingValuePage of CustomTargetingValue objects that satisfy the given Statement.query.
UpdateResult	performCustomTargetingKeyAction(CustomTargetingKeyAction customTargetingKeyAction, Statement filterStatement) Performs actions on CustomTargetingKey objects that match the given Statement.query.
UpdateResult	performCustomTargetingValueAction(CustomTargetingValueAction customTargetingValueAction, Statement filterStatement) Performs actions on CustomTargetingValue objects that match the given Statement.query.
CustomTargetingKey[]	updateCustomTargetingKeys(CustomTargetingKey[] keys) Updates the specified CustomTargetingKey objects.
CustomTargetingValue[]	updateCustomTargetingValues(CustomTargetingValue[] values) Updates the specified CustomTargetingValue 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

CustomTargetingServiceSoapBindingStub

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

Throws:

org.apache.axis.AxisFault

CustomTargetingServiceSoapBindingStub

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

Throws:

org.apache.axis.AxisFault

CustomTargetingServiceSoapBindingStub

public CustomTargetingServiceSoapBindingStub(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

createCustomTargetingKeys

public CustomTargetingKey[] createCustomTargetingKeys(CustomTargetingKey[] keys)
                                               throws RemoteException,
                                                      ApiException

Description copied from interface: CustomTargetingServiceInterface

Creates new CustomTargetingKey objects. The following fields are required:

• CustomTargetingKey.name
• CustomTargetingKey.type

Specified by:

createCustomTargetingKeys in interface CustomTargetingServiceInterface

Parameters:

keys - the custom targeting keys to update

Returns:

the updated custom targeting keys

Throws:

RemoteException

ApiException

createCustomTargetingValues

public CustomTargetingValue[] createCustomTargetingValues(CustomTargetingValue[] values)
                                                   throws RemoteException,
                                                          ApiException

Description copied from interface: CustomTargetingServiceInterface

Creates new CustomTargetingValue objects. The following fields are required:

• CustomTargetingValue.customTargetingKeyId
• CustomTargetingValue.name

Specified by:

createCustomTargetingValues in interface CustomTargetingServiceInterface

Parameters:

values - the custom targeting values to update

Returns:

the updated custom targeting keys

Throws:

RemoteException

ApiException

getCustomTargetingKeysByStatement

public CustomTargetingKeyPage getCustomTargetingKeysByStatement(Statement filterStatement)
                                                         throws RemoteException,
                                                                ApiException

Description copied from interface: CustomTargetingServiceInterface

Gets a CustomTargetingKeyPage of CustomTargetingKey objects that satisfy the given Statement.query. The following fields are supported for filtering:

PQL Property	Object Property
id	CustomTargetingKey.id
name	CustomTargetingKey.name
displayName	CustomTargetingKey.displayName
type	CustomTargetingKey.type

Specified by:

getCustomTargetingKeysByStatement in interface CustomTargetingServiceInterface

Parameters:

filterStatement - a Publisher Query Language statement used to filter a set of custom targeting keys

Returns:

the custom targeting keys that match the given filter

Throws:

RemoteException

ApiException

getCustomTargetingValuesByStatement

public CustomTargetingValuePage getCustomTargetingValuesByStatement(Statement filterStatement)
                                                             throws RemoteException,
                                                                    ApiException

Description copied from interface: CustomTargetingServiceInterface

Gets a CustomTargetingValuePage of CustomTargetingValue objects that satisfy the given Statement.query.

The WHERE clause in the Statement.query must always contain CustomTargetingValue.customTargetingKeyId as one of its columns in a way that it is AND'ed with the rest of the query. So, if you want to retrieve values for a known set of key ids, valid Statement.query would look like:

1. "WHERE customTargetingKeyId IN ('17','18','19')" retrieves all values that are associated with keys having ids 17, 18, 19.
2. "WHERE customTargetingKeyId = '17' AND name = 'red'" retrieves values that are associated with keys having id 17 and value name is 'red'.

The following fields are supported for filtering:

PQL Property	Object Property
id	CustomTargetingValue.id
customTargetingKeyId	CustomTargetingValue.customTargetingKeyId
name	CustomTargetingValue.name
displayName	CustomTargetingValue.displayName
matchType	CustomTargetingValue.matchType

Specified by:

getCustomTargetingValuesByStatement in interface CustomTargetingServiceInterface

Parameters:

filterStatement - a Publisher Query Language statement used to filter a set of custom targeting values

Returns:

the custom targeting values that match the given filter

Throws:

RemoteException

ApiException

performCustomTargetingKeyAction

public UpdateResult performCustomTargetingKeyAction(CustomTargetingKeyAction customTargetingKeyAction,
                                           Statement filterStatement)
                                             throws RemoteException,
                                                    ApiException

Description copied from interface: CustomTargetingServiceInterface

Performs actions on CustomTargetingKey objects that match the given Statement.query.

Specified by:

performCustomTargetingKeyAction in interface CustomTargetingServiceInterface

Parameters:

customTargetingKeyAction - the action to perform

filterStatement - a Publisher Query Language statement used to filter a set of custom targeting keys

Returns:

the result of the action performed

Throws:

RemoteException

ApiException

performCustomTargetingValueAction

public UpdateResult performCustomTargetingValueAction(CustomTargetingValueAction customTargetingValueAction,
                                             Statement filterStatement)
                                               throws RemoteException,
                                                      ApiException

Description copied from interface: CustomTargetingServiceInterface

Performs actions on CustomTargetingValue objects that match the given Statement.query.

Specified by:

performCustomTargetingValueAction in interface CustomTargetingServiceInterface

Parameters:

customTargetingValueAction - the action to perform

filterStatement - a Publisher Query Language statement used to filter a set of ad units

Returns:

the result of the action performed

Throws:

RemoteException

ApiException

updateCustomTargetingKeys

public CustomTargetingKey[] updateCustomTargetingKeys(CustomTargetingKey[] keys)
                                               throws RemoteException,
                                                      ApiException

Description copied from interface: CustomTargetingServiceInterface

Updates the specified CustomTargetingKey objects.

Specified by:

updateCustomTargetingKeys in interface CustomTargetingServiceInterface

Parameters:

keys - the custom targeting keys to update

Returns:

the updated custom targeting keys

Throws:

RemoteException

ApiException

updateCustomTargetingValues

public CustomTargetingValue[] updateCustomTargetingValues(CustomTargetingValue[] values)
                                                   throws RemoteException,
                                                          ApiException

Description copied from interface: CustomTargetingServiceInterface

Updates the specified CustomTargetingValue objects.

Specified by:

updateCustomTargetingValues in interface CustomTargetingServiceInterface

Parameters:

values - the custom targeting values to update

Returns:

the updated custom targeting values

Throws:

RemoteException

ApiException