RateCardService provides operations for managing rate cards.

activateRateCard

Activate a rate card.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
rateCardID	long	The ID of the rate card to activate.	Req

Response

RateCardResponse - The response, which indicates if the operation succeeded or failed, and the rate card.

activateRateCards

Activate a list of rate cards.

Quota is charged for each object in the request.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
rateCardIDs	long[]	The IDs of the rate cards to activate.	Req

Response

RateCardResponse[] - The list of responses, which indicate if the operations succeeded or failed, and the list of rate cards.

addBaseRate

Add a base rate.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
baseRate	BaseRate	The base rate to add.	Req

Response

BaseRateResponse - The response, which indicates if the operation succeeded or failed, and the base rate.

addBaseRates

Add a list of base rates.

Quota is charged for each object in the request.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
baseRates	BaseRate[]	The list of base rates to add.	Req

Response

BaseRateResponse[] - The list of responses, which indicate if the operations succeeded or failed, and the list of base rates.

addDefaultBaseRate

Add a default base rate.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
defaultBaseRate	DefaultBaseRate	The default base rate to add.	Req

Response

DefaultBaseRateResponse - The response, which indicates if the operation succeeded or failed, and the default base rate.

addDefaultBaseRates

Add default base rates to multiple rate cards.

Quota is charged for each object in the request.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
defaultBaseRates	DefaultBaseRate[]	The list of default base rates (only one default base rate per rate card) to add.	Req

Response

DefaultBaseRateResponse[] - The list of responses, which indicate if the operations succeeded or failed, and the list of default base rates.

addRateAdjustment

Add a rate adjustment.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
rateAdjustment	RateAdjustment	The rate adjustment to add.	Req

Response

RateAdjustmentResponse - The response, which indicates if the operation succeeded or failed, and the rate adjustment.

addRateAdjustments

Add a list of rate adjustments.

Quota is charged for each object in the request.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
rateAdjustments	RateAdjustment[]	The list of rate adjustments to add.	Req

Response

RateAdjustmentResponse[] - The list of responses, which indicate if the operations succeeded or failed, and the list of rate adjustments.

addRateCard

Add a rate card.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
rateCard	RateCard	The new rate card to add.	Req

Response

RateCardResponse - The response, which indicates if the operation succeeded or failed, and the rate card.

addRateCards

Add a list of rate cards.

Quota is charged for each object in the request.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
rateCards	RateCard[]	The list of rate cards to add.	Req

Response

RateCardResponse[] - The list of responses, which indicate if the operations succeeded or failed, and the list of rate cards.

copyRateCard

Copy an active rate card.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
rateCardID	long	The ID of the active rate card to copy.	Req

Response

RateCardResponse - The response, which indicates if the operation succeeded or failed, and a copy (that can be edited) of the active rate card.

deleteBaseRate

Delete a base rate.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
baseRateID	long	The ID of the base rate to delete.	Req

Response

BasicResponse - The response, which indicates if the operation succeeded or failed.

deleteBaseRates

Delete a list of base rates.

Quota is charged for each object in the request.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
baseRateIDs	long[]	The IDs of the base rates to delete.	Req

Response

BasicResponse[] - The list of responses, which indicate if the operations succeeded or failed.

deleteRateAdjustment

Delete a rate adjustment.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
rateAdjustmentID	long	The ID of the rate adjustment to delete.	Req

Response

BasicResponse - The response, which indicates if the operation succeeded or failed.

deleteRateAdjustments

Delete a list of rate adjustments.

Quota is charged for each object in the request.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
rateAdjustmentIDs	long[]	The IDs of the rate adjustments to delete.	Req

Response

BasicResponse[] - The list of responses, which indicate if the operations succeeded or failed.

deleteRateCard

Delete a rate card.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
rateCardID	long	The ID of the rate card to delete.	Req

Response

BasicResponse - The response, which indicates if the operation succeeded or failed.

deleteRateCards

Delete a list of rate cards.

Quota is charged for each object in the request.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
rateCardIDs	long[]	The IDs of the rate cards to delete.	Req

Response

BasicResponse[] - The list of responses, which indicate if the operations succeeded or failed.

getBaseRate

Get a base rate.

Capability required: YieldRead
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
baseRateID	long	The ID of the base rate to retrieve.	Req

Response

BaseRate - The base rate.

getBaseRates

Get a list of base rates.

Quota is charged for each object in the request.

Capability required: YieldRead
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
baseRateIDs	long[]	The IDs of the base rates to retrieve.	Req

Response

BaseRate[] - The list of base rates.

getBaseRatesByRateCardID

Get the base rates in a rate card.

Capability required: YieldRead
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
rateCardID	long	The ID of the rate card.	Req
startElement	int	The first element to retrieve (0-based; if a value <= 0 is entered, it will default to 0).	Req
numElements	int	The number of elements to retrieve (1000 maximum; if a value <=0 is entered, it will default to 1000).	Req

Response

BaseRate[] - The list of base rates in the specified rate card.

getBaseRatesCountByRateCardID

Get a count of the base rates in a rate card (specified by ID).

Capability required: YieldRead
License command group: Inventory
Method access types: Self-managed account with Publisher capability, Managed publisher

Parameters

Parameter	Data Type	Description	Restriction
rateCardID	long	The ID of the rate card.	Req

Response

int - The number of base rates in the specified rate card.

getDefaultBaseRate

Get a default base rate.

Capability required: YieldRead
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
defaultBaseRateID	long	The ID of the default base rate to retrieve.	Req

Response

DefaultBaseRate - The default base rate.

getDefaultBaseRateByRateCardID

Get the default base rate in a rate card.

Capability required: YieldRead
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
rateCardID	long	The ID of the rate card.	Req

Response

DefaultBaseRate - The default base rate in the specified rate card.

getDefaultBaseRates

Get a list of default base rates.

Quota is charged for each object in the request.

Capability required: YieldRead
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
defaultBaseRateIDs	long[]	The IDs of the default base rates to retrieve.	Req

Response

DefaultBaseRate[] - The list of default base rates.

getRateAdjustment

Get a rate adjustment.

Capability required: YieldRead
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
rateAdjustmentID	long	The ID of the rate adjustment to retrieve.	Req

Response

RateAdjustment - The rate adjustment.

getRateAdjustmentCountByRateCardID

Get a count of the rate adjustments in a rate card (specified by ID).

Capability required: YieldRead
License command group: Inventory
Method access types: Self-managed account with Publisher capability, Managed publisher

Parameters

Parameter	Data Type	Description	Restriction
rateCardID	long	The ID of the rate card.	Req

Response

int - The number of rate adjustments in the specified rate card.

getRateAdjustments

Get a list of rate adjustments.

Quota is charged for each object in the request.

Capability required: YieldRead
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
rateAdjustmentIDs	long[]	The IDs of the rate adjustments to retrieve.	Req

Response

RateAdjustment[] - The list of rate adjustments.

getRateAdjustmentsByRateCardID

Get the rate adjustments for a rate card.

Capability required: YieldRead
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
rateCardID	long	The ID of the rate card.	Req
startElement	int	The first element to retrieve (0-based; if a value <= 0 is entered, it will default to 0).	Req
numElements	int	The number of elements to retrieve (1000 maximum; if a value <=0 is entered, it will default to 1000).	Req

Response

RateAdjustment[] - The list of rate adjustments for the specified rate card.

getRateCard

Get a rate card.

Capability required: YieldRead
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
rateCardID	long	The ID of the rate card to retrieve.	Req

Response

RateCard - The rate card.

getRateCards

Get a list of rate cards.

Quota is charged for each object in the request.

Capability required: YieldRead
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
rateCardIDs	long[]	The IDs of the rate cards to retrieve.	Req

Response

RateCard[] - The list of rate cards.

getRateCardsByOwner

Get the list of rate cards in the specified statuses for a rate card owner.

Quota is charged for each object in the request.

Capability required: YieldRead
License command group: Inventory
Method access types: Self-managed account with managed publishers, Self-managed account with Publisher capability, Managed publisher

Parameters

Parameter	Data Type	Description	Restriction
owner	RateCardOwner	The owner of the rate card.	Req
rateCardStatuses	RateCardStatus[]	The list of rate card statuses for filtering.	Req

Response

RateCard[] - The list of rate cards in the specified statuses for the specified owner.

getRateCardsByOwnerTypeAndStatuses

Get the list of rate cards in the specified statuses for a type of owner.

Quota is charged for each object in the request.

Capability required: YieldRead
License command group: Inventory
Method access types: Self-managed account with managed publishers, Self-managed account with Publisher capability, Managed publisher

Parameters

Parameter	Data Type	Description	Restriction
ownerType	RateCardOwnerType	The type of owner.	Req
rateCardStatuses	RateCardStatus[]	The list of rate card statuses for filtering.	Req
startElement	int	The first element to retrieve (0-based; if a value <= 0 is entered, it will default to 0).	Req
numElements	int	The number of elements to retrieve (1000 maximum; if a value <=0 is entered, it will default to 1000).	Req

Response

RateCard[] - The list of rate cards in the specified statuses for the specified type of owner.

getRateCardsCountByOwnerTypeAndStatuses

Get a count of the rate cards in the specified statuses for a type of owner.

Quota is charged for each object in the request.

Capability required: YieldRead
License command group: Inventory
Method access types: Self-managed account with managed publishers, Self-managed account with Publisher capability, Managed publisher

Parameters

Parameter	Data Type	Description	Restriction
ownerType	RateCardOwnerType	The type of owner.	Req
rateCardStatuses	RateCardStatus[]	The list of rate card statuses for filtering.	Req

Response

RateCard[] - The number of rate cards in the specified statuses for the specified type of owner.

getSupportedTargetingAttributeTypesByOwnerType

Get the targeting attribute types that are supported by this service.

Capability required: YieldRead
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
ownerType	RateCardOwnerType	The type of owner.	Req

Response

TargetingAttributeType[] - The list of targeting attribute types that are supported by this service for the specified type of rate card owner.

updateBaseRate

Update a base rate.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
baseRate	BaseRate	The base rate to update.	Req

Response

BaseRateResponse - The response, which indicates if the operation succeeded or failed, and the base rate.

updateBaseRates

Update a list of base rates.

Quota is charged for each object in the request.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
baseRates	BaseRate[]	The list of base rates to update.	Req

Response

BaseRateResponse[] - The response, which indicates if the operation succeeded or failed, and the list of base rates.

updateDefaultBaseRate

Update a default base rate.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
defaultBaseRate	DefaultBaseRate	The default base rate to update.	Req

Response

DefaultBaseRateResponse - The response, which indicates if the operation succeeded or failed, and the default base rate.

updateDefaultBaseRates

Update a list of default base rates. There can be only one default base rate per rate card, so these assume multiple rate cards.

Quota is charged for each object in the request.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
defaultBaseRates	DefaultBaseRate[]	The list of default base rates to update.	Req

Response

DefaultBaseRateResponse[] - The response, which indicates if the operation succeeded or failed, and the list of default base rates.

updateRateAdjustment

Update a rate adjustment.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
rateAdjustment	RateAdjustment	The rate adjustment to update.	Req

Response

RateAdjustmentResponse - The response, which indicates if the operation succeeded or failed, and the rate adjustment.

updateRateAdjustments

Update a list of rate adjustments.

Quota is charged for each object in the request.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
rateAdjustments	RateAdjustment[]	The rate adjustments to update.	Req

Response

RateAdjustmentResponse[] - The list of responses, which indicate if the operations succeeded or failed, and the list of rate adjustments.

updateRateCard

Update a rate card.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
rateCard	RateCard	The rate card to update.	Req

Response

RateCardResponse - The response, which indicates if the operation succeeded or failed, and the rate card.

updateRateCards

Update a list of rate cards.

Quota is charged for each object in the request.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
rateCards	RateCard[]	The list of rate cards to update.	Req

Response

RateCardResponse[] - The list of responses, which indicate if the operations succeeded or failed, and the list of rate cards.