com.google.api.ads.dfp.v201111
Interface CustomTargetingServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

CustomTargetingServiceSoapBindingStub

public interface CustomTargetingServiceInterface
extends Remote

Method Summary

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.

Method Detail

createCustomTargetingKeys

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

Creates new CustomTargetingKey objects. The following fields are required:

• CustomTargetingKey.name
• CustomTargetingKey.type

Parameters:

keys - the custom targeting keys to update

Returns:

the updated custom targeting keys

Throws:

RemoteException

ApiException

createCustomTargetingValues

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

Creates new CustomTargetingValue objects. The following fields are required:

• CustomTargetingValue.customTargetingKeyId
• CustomTargetingValue.name

Parameters:

values - the custom targeting values to update

Returns:

the updated custom targeting keys

Throws:

RemoteException

ApiException

getCustomTargetingKeysByStatement

CustomTargetingKeyPage getCustomTargetingKeysByStatement(Statement filterStatement)
                                                         throws RemoteException,
                                                                ApiException

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

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

CustomTargetingValuePage getCustomTargetingValuesByStatement(Statement filterStatement)
                                                             throws RemoteException,
                                                                    ApiException

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

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

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

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

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

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

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

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

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

Updates the specified CustomTargetingKey objects.

Parameters:

keys - the custom targeting keys to update

Returns:

the updated custom targeting keys

Throws:

RemoteException

ApiException

updateCustomTargetingValues

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

Updates the specified CustomTargetingValue objects.

Parameters:

values - the custom targeting values to update

Returns:

the updated custom targeting values

Throws:

RemoteException

ApiException