com.google.api.ads.dfp.axis.v201306

Interface RateCardCustomizationServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

RateCardCustomizationServiceSoapBindingStub

public interface RateCardCustomizationServiceInterface
extends Remote

Method Summary

Methods

Modifier and Type	Method and Description
RateCardCustomization	createRateCardCustomization(RateCardCustomization rateCardCustomization) Creates a new RateCardCustomization object.
RateCardCustomization[]	createRateCardCustomizations(RateCardCustomization[] rateCardCustomizations) Creates a list of new RateCardCustomization objects.
RateCardCustomization	getRateCardCustomization(Long rateCardCustomizationId) Returns the RateCardCustomization object uniquely identified by the given ID.
RateCardCustomizationPage	getRateCardCustomizationsByStatement(Statement filterStatement) Gets a RateCardCustomizationPage of RateCardCustomization objects that satisfy the given Statement.query.
UpdateResult	performRateCardCustomizationAction(RateCardCustomizationAction rateCardCustomizationAction, Statement filterStatement) Performs actions on RateCardCustomization objects that satisfy the given Statement.query.
RateCardCustomization	updateRateCardCustomization(RateCardCustomization rateCardCustomization) Updates the specified RateCardCustomization object.
RateCardCustomization[]	updateRateCardCustomizations(RateCardCustomization[] rateCardCustomizations) Updates the specified RateCardCustomization objects.

Method Detail

createRateCardCustomization

RateCardCustomization createRateCardCustomization(RateCardCustomization rateCardCustomization)
                                                  throws RemoteException,
                                                         ApiException

Creates a new RateCardCustomization object.

Parameters:

rateCardCustomization - the RateCardCustomization to be created

Returns:

the RateCardCustomization with its ID filled in

Throws:

RemoteException

ApiException

createRateCardCustomizations

RateCardCustomization[] createRateCardCustomizations(RateCardCustomization[] rateCardCustomizations)
                                                     throws RemoteException,
                                                            ApiException

Creates a list of new RateCardCustomization objects.

Parameters:

rateCardCustomizations - the rate card customizations to be created

Returns:

the rate card customizations with their IDs filled in

Throws:

RemoteException

ApiException

getRateCardCustomization

RateCardCustomization getRateCardCustomization(Long rateCardCustomizationId)
                                               throws RemoteException,
                                                      ApiException

Returns the RateCardCustomization object uniquely identified by the given ID.

Parameters:

rateCardCustomizationId - the ID of the rate card customization, which must already exist.

Throws:

RemoteException

ApiException

getRateCardCustomizationsByStatement

RateCardCustomizationPage getRateCardCustomizationsByStatement(Statement filterStatement)
                                                               throws RemoteException,
                                                                      ApiException

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

PQL Property	Object Property
rateCardId	RateCardCustomization.rateCardId
rateCardCustomizationGroupId	RateCardCustomization#rateCardCustomizationGroupId
id	RateCardCustomization.id
status	RateCardCustomization.status

Parameters:

filterStatement - a Publisher Query Language statement used to filter a set of rate card customizations.

Returns:

the rate card customizations that match the given filter

Throws:

RemoteException

ApiException

performRateCardCustomizationAction

UpdateResult performRateCardCustomizationAction(RateCardCustomizationAction rateCardCustomizationAction,
                                              Statement filterStatement)
                                                throws RemoteException,
                                                       ApiException

Performs actions on RateCardCustomization objects that satisfy the given Statement.query.

Parameters:

rateCardCustomizationAction - the action to perform

filterStatement - a Publisher Query Language statement used to filter a set of rate card customizations.

Returns:

the result of the action performed

Throws:

RemoteException

ApiException

updateRateCardCustomization

RateCardCustomization updateRateCardCustomization(RateCardCustomization rateCardCustomization)
                                                  throws RemoteException,
                                                         ApiException

Updates the specified RateCardCustomization object.

Parameters:

rateCardCustomization - the rate card customization to be updated

Returns:

the updated rate card customization

Throws:

RemoteException

ApiException

updateRateCardCustomizations

RateCardCustomization[] updateRateCardCustomizations(RateCardCustomization[] rateCardCustomizations)
                                                     throws RemoteException,
                                                            ApiException

Updates the specified RateCardCustomization objects.

Parameters:

rateCardCustomizations - the rate card customizations to be updated

Returns:

the updated rate card customizations

Throws:

RemoteException

ApiException