com.google.api.ads.dfp.jaxws.v201711

Interface CustomTargetingServiceInterface

public interface CustomTargetingServiceInterface

Provides operations for creating, updating and retrieving CustomTargetingKey and CustomTargetingValue objects. This class was generated by the JAX-WS RI. JAX-WS RI 2.2.9-b130926.1035 Generated source version: 2.1

Method Summary

Modifier and Type	Method and Description
List<CustomTargetingKey>	createCustomTargetingKeys(List<CustomTargetingKey> keys) Creates new CustomTargetingKey objects.
List<CustomTargetingValue>	createCustomTargetingValues(List<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.
List<CustomTargetingKey>	updateCustomTargetingKeys(List<CustomTargetingKey> keys) Updates the specified CustomTargetingKey objects.
List<CustomTargetingValue>	updateCustomTargetingValues(List<CustomTargetingValue> values) Updates the specified CustomTargetingValue objects.

Method Detail

createCustomTargetingKeys

@RequestWrapper(localName="createCustomTargetingKeys",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                className="com.google.api.ads.dfp.jaxws.v201711.CustomTargetingServiceInterfacecreateCustomTargetingKeys")
 @ResponseWrapper(localName="createCustomTargetingKeysResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                 className="com.google.api.ads.dfp.jaxws.v201711.CustomTargetingServiceInterfacecreateCustomTargetingKeysResponse")
List<CustomTargetingKey> createCustomTargetingKeys(List<CustomTargetingKey> keys)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              throws ApiException_Exception

Creates new CustomTargetingKey objects. The following fields are required:

• CustomTargetingKey.name
• CustomTargetingKey.type

Parameters:

keys - the custom targeting keys to update

keys -

Returns:

the updated custom targeting keys

Throws:

ApiException_Exception

createCustomTargetingValues

@RequestWrapper(localName="createCustomTargetingValues",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                className="com.google.api.ads.dfp.jaxws.v201711.CustomTargetingServiceInterfacecreateCustomTargetingValues")
 @ResponseWrapper(localName="createCustomTargetingValuesResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                 className="com.google.api.ads.dfp.jaxws.v201711.CustomTargetingServiceInterfacecreateCustomTargetingValuesResponse")
List<CustomTargetingValue> createCustomTargetingValues(List<CustomTargetingValue> values)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          throws ApiException_Exception

Creates new CustomTargetingValue objects. The following fields are required:

• CustomTargetingValue.customTargetingKeyId
• CustomTargetingValue.name

Parameters:

values - the custom targeting values to update

values -

Returns:

the updated custom targeting keys

Throws:

ApiException_Exception

getCustomTargetingKeysByStatement

@RequestWrapper(localName="getCustomTargetingKeysByStatement",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                className="com.google.api.ads.dfp.jaxws.v201711.CustomTargetingServiceInterfacegetCustomTargetingKeysByStatement")
 @ResponseWrapper(localName="getCustomTargetingKeysByStatementResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                 className="com.google.api.ads.dfp.jaxws.v201711.CustomTargetingServiceInterfacegetCustomTargetingKeysByStatementResponse")
CustomTargetingKeyPage getCustomTargetingKeysByStatement(Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    throws ApiException_Exception

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

filterStatement -

Returns:

the custom targeting keys that match the given filter

Throws:

ApiException_Exception

getCustomTargetingValuesByStatement

@RequestWrapper(localName="getCustomTargetingValuesByStatement",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                className="com.google.api.ads.dfp.jaxws.v201711.CustomTargetingServiceInterfacegetCustomTargetingValuesByStatement")
 @ResponseWrapper(localName="getCustomTargetingValuesByStatementResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                 className="com.google.api.ads.dfp.jaxws.v201711.CustomTargetingServiceInterfacegetCustomTargetingValuesByStatementResponse")
CustomTargetingValuePage getCustomTargetingValuesByStatement(Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                throws ApiException_Exception

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

filterStatement -

Returns:

the custom targeting values that match the given filter

Throws:

ApiException_Exception

performCustomTargetingKeyAction

@RequestWrapper(localName="performCustomTargetingKeyAction",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                className="com.google.api.ads.dfp.jaxws.v201711.CustomTargetingServiceInterfaceperformCustomTargetingKeyAction")
 @ResponseWrapper(localName="performCustomTargetingKeyActionResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                 className="com.google.api.ads.dfp.jaxws.v201711.CustomTargetingServiceInterfaceperformCustomTargetingKeyActionResponse")
UpdateResult performCustomTargetingKeyAction(CustomTargetingKeyAction customTargetingKeyAction,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                throws ApiException_Exception

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

filterStatement -

customTargetingKeyAction -

Returns:

the result of the action performed

Throws:

ApiException_Exception

performCustomTargetingValueAction

@RequestWrapper(localName="performCustomTargetingValueAction",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                className="com.google.api.ads.dfp.jaxws.v201711.CustomTargetingServiceInterfaceperformCustomTargetingValueAction")
 @ResponseWrapper(localName="performCustomTargetingValueActionResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                 className="com.google.api.ads.dfp.jaxws.v201711.CustomTargetingServiceInterfaceperformCustomTargetingValueActionResponse")
UpdateResult performCustomTargetingValueAction(CustomTargetingValueAction customTargetingValueAction,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 Statement filterStatement)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          throws ApiException_Exception

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

filterStatement -

customTargetingValueAction -

Returns:

the result of the action performed

Throws:

ApiException_Exception

updateCustomTargetingKeys

@RequestWrapper(localName="updateCustomTargetingKeys",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                className="com.google.api.ads.dfp.jaxws.v201711.CustomTargetingServiceInterfaceupdateCustomTargetingKeys")
 @ResponseWrapper(localName="updateCustomTargetingKeysResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                 className="com.google.api.ads.dfp.jaxws.v201711.CustomTargetingServiceInterfaceupdateCustomTargetingKeysResponse")
List<CustomTargetingKey> updateCustomTargetingKeys(List<CustomTargetingKey> keys)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              throws ApiException_Exception

Updates the specified CustomTargetingKey objects.

Parameters:

keys - the custom targeting keys to update

keys -

Returns:

the updated custom targeting keys

Throws:

ApiException_Exception

updateCustomTargetingValues

@RequestWrapper(localName="updateCustomTargetingValues",
                targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                className="com.google.api.ads.dfp.jaxws.v201711.CustomTargetingServiceInterfaceupdateCustomTargetingValues")
 @ResponseWrapper(localName="updateCustomTargetingValuesResponse",
                 targetNamespace="https://www.google.com/apis/ads/publisher/v201711",
                 className="com.google.api.ads.dfp.jaxws.v201711.CustomTargetingServiceInterfaceupdateCustomTargetingValuesResponse")
List<CustomTargetingValue> updateCustomTargetingValues(List<CustomTargetingValue> values)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          throws ApiException_Exception

Updates the specified CustomTargetingValue objects.

Parameters:

values - the custom targeting values to update

values -

Returns:

the updated custom targeting values

Throws:

ApiException_Exception