Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Body Parameter

Type

Required

Supported

Validations

Description

dealCategory

Integer

No

Yes

One of the following values:

   1 = Single publisher deal

   2 = Package deal

Flags whether the deal is a single publisher deal or a package deal.

dealId

String

No

Yes
  • Characters not allowed are [+|!(){}[]<>#%^\"~*?:;@$]
  • Maximum length is 64 characters
  • In case the dealId is not specified, an auto-generated dealId is used while activating the Deal.
  • Once a deal is in Active / Scheduled state, Deal ID cannot be changed.
  • Deal ID must be passed while making any edit on a deal.

dealIdInRequestEnabled

Boolean

No

Yes

Default value = False

Set this flag to True to indicate that the Publisher will include the Deal ID in the OpenRTB Ad Request to PubMatic.

name

String

Yes

Yes
  • Maximum length is 256 characters.
  • Name should be unique for a combination of ownerType and ownerId.
  • Characters not allowed are [+|!(){}[]<>#%^\"~*?:;@$]

Name of the deal

additionalInfo

String

No

Yes

Any additional information to be linked with the deal. All the message-based interactions will be recorded here.

status

Integer

Yes

Yes

Buyers can create a deal directly in Active state if offer is a one-click buy.

Publisher can create a deal directly in Active state. InReview state deal creation is not applicable for a Publisher.

Status of the deal. Possible options are:

Excerpt Include
ex:PMP Deal API Status Table
ex:PMP Deal API Status Table
nopaneltrue


priority

Integer

No

Yes

Value must be in the following interval: 0<= priority <= 100.

Displayable to publishers only.

Priority of the deal.

The lower the number, the higher the priority.

This field is visible only to Publishers.

auctionType

Integer

Yes

Yes

Value must be between 1 to 3.

Possible Values:

1 = First Price

2 = Second Price

3 = Fixed Price

Auction type (First Price, Second Price, or Fixed Price) associated with the deal. 

Note: This field is negotiable in case of In-review deals.

channelTypeIntegerYesYes

Possible Values:

PMP = 1

PMP-G = 6

Value specifying the channel type of the deal.

offer

Integer

No

Yes
  • Value must be greater than 0.
  • Value must be a valid offer ID.
  • Either 'offer' or 'products' must be provided.

ID of the offer associated with the deal.

See Offer API details for more information.

productproductsIntegerNoYes
  • Value must be greater than 0.
  • Value must be a valid product ID.
  • Either 'offer' or 'products' must be provided.

ID of the product  from which this deal is originated.

See Product API details for more information.

targetingIntegerNoYes
  • Value must be greater than 0.
  • Value must be a valid targeting ID.
  • Can only be passed when 'products' must be provided.

ID of the targeting from which this deal is originated.

Create targeting using Targeting API    then use the ID returned in the response for this parameter.

Use "null" if the deal is not targeted to any specific criteria

startDate

ISO Date in GMT

NoYes

Yes

Value must not be earlier than the current date.

Start date of the deal. This field is optional, in case the start date from the selected offer need not be changed.

endDate

ISO Date in GMT

NoYes

Yes

Value must not be earlier than the start date.

End date of the deal. This field is optional, in case the end date from the selected offer need not be changed.

timeZone

Integer

No

Yes

Value must be between the allowed time zone IDs.

Timezone for start date and end date specified in the deal. Possible options are:

1 = PST

2 = JST

3 = AET

4 = GMT

5 = ACST

6 = AWST

flooreCPM

Float

Yes

Yes

Value must be between 0.01 to 999.99

Minimum eCPM expected for the deal.

minSpendFloatNoYes

Mandatory channelType = PMP-G

Minimum spend for this deal.
impressionAvailsLongNoYesMandatory for channelType = PMP-GAvailable impressions for this deal.

salesperson

String

No

Yes
  • Value must be a valid user e-mail ID.
  • Only publisher Admin can set this field
  • If user is logged in publisher user, user will be saved as sales person of the deal.

Sales representative associated with the deal.

It is a publisher-specific deal, therefore only a publisher can send this parameter.

advertiserWhiteListing

Boolean

No

Yes

Default Value = False

Indicates whether advertiser whitelisting is enabled for the deal or not.

advertisers

Array of Integers

No

Yes

Value must be valid advertiser IDs and should be mapped to selected advertiser categories id selected.

List of advertisers for which the deal should be whitelisted.

advertiserCategories

Array of Integers

No

Yes

Value must be valid advertiser category IDs (PubMatic or IAB)

List of advertiser categories for which the deal should be whitelisted.

advertiserIABCategories

Array of strings

No

Yes

Value must be valid IAB advertiser category IDs

List of IAB advertiser categories for which the deal should be whitelisted.

advertiserDomains

Array of Integers

No

Yes

Value must be valid advertiser domains and should mapped to the selected advertiser categories and advertisers if selected.

List of advertiser domains for which the deal should be whitelisted.

dealDspBuyerMappingsArray of JSON objectsYesYes

Must be valid DSP and Buyer Ids.

Publishers and DSPs can send these mappings.

List of DSP-Buyer map for this deal.

This is a mandatory field.

buyers

Array of Integers

No

Yes

Value must be valid buyer IDs.

Publishers and DSPs can send these.

List of ATDs associated with the deal.

This field is mandatory when the deal is created in the Active/Scheduled state.

buyerEmails

Array of Buyer Emails with mapped owner ID

No

Yes

Publishers and DSPs can send these.

List of buyer email addresses that should be notified  while  creating deal / deal In-review/ accepting deal In-review

dsps

Array of Integers

No

Yes

Value must be valid DSP IDs.

List of DSPs associated with the deal. This field is mandatory when the deal is created in the Active/Scheduled state.

dspEmails

Array of DSP Emails with mapped owner ID

No

Yes

Publishers and ATDs can send these.

List of DSP email addresses that should be notified while creating deal / deal In-review / Accepting deal In-review

additionalEmails

List of Strings

No

Yes


Any additional emails that should be notified  while creating deal / deal In-review / accepting deal In-review

decisionManagerEnabledBooleanNoYes

Default Value = False

Value can be set only if appropriate property is set for publisher.

Field to indicate if Unified Optimization is enabled.

lastLookUpEnabled

Boolean

No

Yes

Default Value = False

Value can be set only if appropriate property is set for publisher.

Indicates whether last look up has been enabled for the deal or not.

publisherCategoryIdIntegerNoYes
Used for PMRG consortium

revShare
DoubleNoYes
Used for PMRG consortium
loggedInOwnerIdLongYesYesA valid Publisher IDDSP ID, or Buyer IDIndicates account ID
loggedInOwnerTypeIdIntegerYesYes

One of the following integer values:


Type of AccountValue
Publisher1
Buyer5
ATD/Buyer7


Indicates the account type issuing the request. 

...