---
title: "Create a player bidding configuration"
method: POST
path: "/v2/sites/{site_id}/advertising/player_bidding_configs/"
tags: ["advertising"]
---

# Create a player bidding configuration

`POST /v2/sites/{site_id}/advertising/player_bidding_configs/`

Create a player bidding configuration resource. Currently only one configuration is allowed.

## Path parameters

- `site_id` string, required — Unique identifier for a resource

## Request body

- object
  - `metadata` PbConfigResourceMetadata
    - `bids` BidsResourceMetadata
      - `settings` BidSettingsResourceMetadata
        - `bidTimeout` integer — Timeout for bid response from when the bid request occurs, in milliseconds
        - `floorPriceCents` integer — Price in cents (CPM) that a bid has to beat in order to win This property must be set when mediationLayerAdServer is set to jwp or jwpdfp. NOTE: Determining the best floor price depends upon various factors. If you need assistance determining the best floor price, please consult with your JWX representative or SSP partner.
        - `mediationLayerAdServer` 'dfp' | 'jwp' | 'jwpdfp' | 'jwpspotx' — Mediation layer that decides which ad runs Possible values: - `dfp`: (IMA) No auction is conducted by the player. All bids are sent to Google Ad Manager (GAM, formerly known as DFP) and rendered as line items that compete against other line items. GAM serves the winning line item. We recommend setting `buckets` to minimize the number of line items that you must set up in GAM. - `jwp`: (VAST/IMA) An auction is conducted by the player. If a winner is selected, the winner's ad is called. If no winner is selected, the fallback tag is called. **You must specify a floor price.** - `jwpdfp`: (IMA) An initial auction is conducted by the player. If a winner is selected, the winner's ad will is called. If no winner is selected, the fallback tag is called to serve. If no winner is selected for any reason, all valid bids are sent to Google Ad Manager (GAM, formerly known as DFP) where the bid values are rendered as line items to compete against other line items. The winning line item is served by GAM. **You must set `floorPriceCents`. We recommend setting `buckets` to minimize the number of line items that you must set up in GAM**. - `jwpspotx`: (VAST) No auction is conducted by the player. The player asks SpotX for a bid and calls the returned ad response regardless of price. This option is equivalent to using JWX mediation with a $.01 floor price. **You must set up [SpotX line items](https://developer.spotxchange.com/content/local/docs/HeaderBidding/lisa.md).**
        - `buckets` object[] — Ranges of bid prices When using buckets, bid prices sent to GAM are rounded down to the closest specified increment. Price buckets are helpful to reduce the number of line items in GAM. Without price buckets, one line item per one-cent increment is required. This property only applies when `dfp` or `jwpdfp` (only for the GAM portion of the mediation) is selected as the `mediationLayerAdServer`.
          - `min` number — Minimum value of a price bucket, in bidding currency
          - `max` number — Maximum value of a price bucket, in bidding currency
          - `increment` number — Nearest increment to which a bid is rounded down, in bidding currency
        - `consentManagement` object — Consent management for EU General Data Protection Regulation (GDPR) and California Consumer Privacy Act (CCPA)
          - `gdpr` object — Consent management module designed to support GDPR More information can be found [here](https://docs.prebid.org/dev-docs/modules/gdprEnforcement.html).
            - `cmpApi` 'iab' | 'static' — CMP interface that is in use
            - `timeout` integer — Length of time (in milliseconds) to allow the CMP to obtain the GDPR consent string
            - `defaultGdprScope` boolean — Defines what the `gdprApplies` flag should be when the CMP doesn’t respond in time or the static data doesn’t supply
            - `rules` object[] — GDPR Enforcement Module which allows the page to define which activities should be enforced at the Prebid.js level and actively enforces those activities based on user consent data Only used with TCF v2.0 More information can be found [here](https://docs.prebid.org/dev-docs/modules/gdprEnforcement.html)
              - …
            - `allowAuctionWithoutConsent` boolean — Determines what will happen if obtaining consent information from the CMP fails; either allow the auction to proceed (`true`) or cancel the auction (`false`). Only used with TCF v1.1
          - `usp` object — Consent management module designed to support the CCPA, referred to as “US Privacy” (USP) More information can be found [here](https://docs.prebid.org/dev-docs/modules/consentManagementUsp.html).
            - `cmpApi` 'iab' | 'static' — CMP interface that is in use
            - `timeout` integer — Length of time (in milliseconds) to allow the USP-API to obtain the CCPA string
      - `bidders` BiddersResourceMetadata, required
        - `name` 'jwdemand' | 'Adtelligent' | 'AppNexus' | 'Axonix' | 'criteo' | 'EMX' | 'improvedigital' | 'IndexExchange' | 'kargo' | 'MediaGrid' | 'MediaNet' | 'OpenX' | 'PubMatic' | 'Rubicon' | 'SmartAdServer' | 'Sonobi' | 'Sovrn' | 'SpotX' | 'SynacorMedia' | 'TheTradeDesk' | 'Unruly' | 'VideoByte' | 'YahooSSP', required — Ad partner from which the bid is received
        - `id` string — Identifier issued by the bidding partner that represents a segment of a publisher's inventory
        - `pubid` string — Identifier issued by an ad partner that represents the publisher
        - `custom_params` CustomParamSchema — User-generated key-value pairs When defining `custom_params`, include all custom parameters that should be associated with the target resource. When updating existing `custom_params`, include all `custom_params` keys with their updated values. Any `custom_params` key-value pair not included within the updated `custom_params` in the request body is [deleted](https://docs.jwplayer.com/platform/docs/stream-faq-how-can-i-delete-a-custom-parameter).

## Response `201`

Resource successfully created

- PbConfigResourceRead — Resource for managing the individual PB configurations of a site
  - `schema` string
  - `id` string — Unique identifier for a resource
  - `created` string — Date and time at which the resource was created
  - `last_modified` string — Date and time at which the resource was most recently modified
  - `type` string — Name of the type of resource.
  - `relationships` object — Ancilliary resources associated to the primary resource being read
  - `metadata` PbConfigResourceMetadata
    - `bids` BidsResourceMetadata
      - `settings` BidSettingsResourceMetadata
        - `bidTimeout` integer — Timeout for bid response from when the bid request occurs, in milliseconds
        - `floorPriceCents` integer — Price in cents (CPM) that a bid has to beat in order to win This property must be set when mediationLayerAdServer is set to jwp or jwpdfp. NOTE: Determining the best floor price depends upon various factors. If you need assistance determining the best floor price, please consult with your JWX representative or SSP partner.
        - `mediationLayerAdServer` 'dfp' | 'jwp' | 'jwpdfp' | 'jwpspotx' — Mediation layer that decides which ad runs Possible values: - `dfp`: (IMA) No auction is conducted by the player. All bids are sent to Google Ad Manager (GAM, formerly known as DFP) and rendered as line items that compete against other line items. GAM serves the winning line item. We recommend setting `buckets` to minimize the number of line items that you must set up in GAM. - `jwp`: (VAST/IMA) An auction is conducted by the player. If a winner is selected, the winner's ad is called. If no winner is selected, the fallback tag is called. **You must specify a floor price.** - `jwpdfp`: (IMA) An initial auction is conducted by the player. If a winner is selected, the winner's ad will is called. If no winner is selected, the fallback tag is called to serve. If no winner is selected for any reason, all valid bids are sent to Google Ad Manager (GAM, formerly known as DFP) where the bid values are rendered as line items to compete against other line items. The winning line item is served by GAM. **You must set `floorPriceCents`. We recommend setting `buckets` to minimize the number of line items that you must set up in GAM**. - `jwpspotx`: (VAST) No auction is conducted by the player. The player asks SpotX for a bid and calls the returned ad response regardless of price. This option is equivalent to using JWX mediation with a $.01 floor price. **You must set up [SpotX line items](https://developer.spotxchange.com/content/local/docs/HeaderBidding/lisa.md).**
        - `buckets` object[] — Ranges of bid prices When using buckets, bid prices sent to GAM are rounded down to the closest specified increment. Price buckets are helpful to reduce the number of line items in GAM. Without price buckets, one line item per one-cent increment is required. This property only applies when `dfp` or `jwpdfp` (only for the GAM portion of the mediation) is selected as the `mediationLayerAdServer`.
          - `min` number — Minimum value of a price bucket, in bidding currency
          - `max` number — Maximum value of a price bucket, in bidding currency
          - `increment` number — Nearest increment to which a bid is rounded down, in bidding currency
        - `consentManagement` object — Consent management for EU General Data Protection Regulation (GDPR) and California Consumer Privacy Act (CCPA)
          - `gdpr` object — Consent management module designed to support GDPR More information can be found [here](https://docs.prebid.org/dev-docs/modules/gdprEnforcement.html).
            - `cmpApi` 'iab' | 'static' — CMP interface that is in use
            - `timeout` integer — Length of time (in milliseconds) to allow the CMP to obtain the GDPR consent string
            - `defaultGdprScope` boolean — Defines what the `gdprApplies` flag should be when the CMP doesn’t respond in time or the static data doesn’t supply
            - `rules` object[] — GDPR Enforcement Module which allows the page to define which activities should be enforced at the Prebid.js level and actively enforces those activities based on user consent data Only used with TCF v2.0 More information can be found [here](https://docs.prebid.org/dev-docs/modules/gdprEnforcement.html)
              - …
            - `allowAuctionWithoutConsent` boolean — Determines what will happen if obtaining consent information from the CMP fails; either allow the auction to proceed (`true`) or cancel the auction (`false`). Only used with TCF v1.1
          - `usp` object — Consent management module designed to support the CCPA, referred to as “US Privacy” (USP) More information can be found [here](https://docs.prebid.org/dev-docs/modules/consentManagementUsp.html).
            - `cmpApi` 'iab' | 'static' — CMP interface that is in use
            - `timeout` integer — Length of time (in milliseconds) to allow the USP-API to obtain the CCPA string
      - `bidders` BiddersResourceMetadata, required
        - `name` 'jwdemand' | 'Adtelligent' | 'AppNexus' | 'Axonix' | 'criteo' | 'EMX' | 'improvedigital' | 'IndexExchange' | 'kargo' | 'MediaGrid' | 'MediaNet' | 'OpenX' | 'PubMatic' | 'Rubicon' | 'SmartAdServer' | 'Sonobi' | 'Sovrn' | 'SpotX' | 'SynacorMedia' | 'TheTradeDesk' | 'Unruly' | 'VideoByte' | 'YahooSSP', required — Ad partner from which the bid is received
        - `id` string — Identifier issued by the bidding partner that represents a segment of a publisher's inventory
        - `pubid` string — Identifier issued by an ad partner that represents the publisher
        - `custom_params` CustomParamSchema — User-generated key-value pairs When defining `custom_params`, include all custom parameters that should be associated with the target resource. When updating existing `custom_params`, include all `custom_params` keys with their updated values. Any `custom_params` key-value pair not included within the updated `custom_params` in the request body is [deleted](https://docs.jwplayer.com/platform/docs/stream-faq-how-can-i-delete-a-custom-parameter).

## Other responses

- `400` — Bad Request The request either lacks certain attributes or contains malformed/invalid attributes.
- `422` — Unprocessable Content The requested extension could not be processed.

---

[API](https://skmtc.net/jwplayer/apis/management-api-v2.md) · [All operations](https://skmtc.net/jwplayer/apis/management-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/jwplayer/management-api-v2/revisions/180db7cada27/schema)