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

Interface RateCardServiceInterface

All Superinterfaces:

Remote

All Known Implementing Classes:

RateCardServiceSoapBindingStub

public interface RateCardServiceInterface
extends Remote

Method Summary

Methods

Modifier and Type	Method and Description
RateCard	createRateCard(RateCard rateCard) Creates a new RateCard.
RateCard[]	createRateCards(RateCard[] rateCards) Creates a list of RateCard objects.
RateCard	getRateCard(Long rateCardId) Returns the RateCard uniquely identified by the given ID.
RateCardPage	getRateCardsByStatement(Statement filterStatement) Gets a RateCardPage of RateCard objects that satisfy the given Statement.query.
UpdateResult	performRateCardAction(RateCardAction rateCardAction, Statement filterStatement) Performs action on RateCard objects that satisfy the given Statement.query.
RateCard	updateRateCard(RateCard rateCard) Updates the specified RateCard.
RateCard[]	updateRateCards(RateCard[] rateCards) Updates a list of RateCard objects.

Method Detail

createRateCard

RateCard createRateCard(RateCard rateCard)
                        throws RemoteException,
                               ApiException

Creates a new RateCard. Rate cards must be activated before being associated with proposal line items and products.

Parameters:

rateCard - the rate card to be created

Returns:

the rate card with corresponding fields set by Google.

Throws:

RemoteException

ApiException

createRateCards

RateCard[] createRateCards(RateCard[] rateCards)
                           throws RemoteException,
                                  ApiException

Creates a list of RateCard objects. Rate cards must be activated before being associated with proposal line items and products.

Parameters:

rateCards - the rate cards to be created

Returns:

the created rate cards.

Throws:

RemoteException

ApiException

getRateCard

RateCard getRateCard(Long rateCardId)
                     throws RemoteException,
                            ApiException

Returns the RateCard uniquely identified by the given ID.

Parameters:

rateCardId - the ID of the rate card, which must already exist

Throws:

RemoteException

ApiException

getRateCardsByStatement

RateCardPage getRateCardsByStatement(Statement filterStatement)
                                     throws RemoteException,
                                            ApiException

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

PQL Property	Object Property
id	RateCard.id
name	RateCard.name
status	RateCard.status

Parameters:

filterStatement - a Publisher Query Language statement to filter a list of rate cards.

Returns:

the rate cards that match the filter

Throws:

RemoteException

ApiException

performRateCardAction

UpdateResult performRateCardAction(RateCardAction rateCardAction,
                                 Statement filterStatement)
                                   throws RemoteException,
                                          ApiException

Performs action on RateCard objects that satisfy the given Statement.query.

Parameters:

rateCardAction - the action to perform

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

Returns:

the result of the action performed

Throws:

RemoteException

ApiException

updateRateCard

RateCard updateRateCard(RateCard rateCard)
                        throws RemoteException,
                               ApiException

Updates the specified RateCard.

Parameters:

rateCard - the rate card to be updated

Returns:

the updated rate card

Throws:

RemoteException

ApiException

updateRateCards

RateCard[] updateRateCards(RateCard[] rateCards)
                           throws RemoteException,
                                  ApiException

Updates a list of RateCard objects.

Parameters:

rateCards - the rate cards to be updated

Returns:

the updated rate cards

Throws:

RemoteException

ApiException