Skip to main content

Gets the Data Auction settings

GET 
/v1/data-auction/:dataSpecificationId

Gets the Data Auction settings

Request​

Path Parameters

    dataSpecificationId stringrequired

Responses​

OK

Schema

    auctionSettings

    object

    required

    The settings for an Auction.

    adjustBidIfBalanceIsLow booleanrequired

    If the bid amount is greater than the available balance in the Account, should the bid amount be adjusted to become the remainder of the balance?

    allowZeroMoneyBids booleanrequired

    Is it possible to create bid amounts with zero value?

    chargeHighestBidFromSameBidder booleanrequired

    If there are multiple Campaigns from the same buyer that match, do we use the highest bid?

    bidIncrementType BidIncrementType (string)required

    Possible values: [FENCE_POST]

    bidIncrements

    object[]

    required

    A list of bid increments.

  • Array [

    • increment

    object

    required

    Represents an amount of money with its currency type.

    currencyCode stringrequired
    units int64required

    The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

    nanos int32required

    Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

    amount

    object

    required

    Represents an amount of money with its currency type.

    currencyCode stringrequired
    units int64required

    The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

    nanos int32required

    Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

  • ]

    • startPricing StartPricing (string)required

    The Start Pricing model.

    Possible values: [RAMPED, STEPPED]

    startPrices

    object[]

    required

    A list of start prices.

  • Array [

    • query

    object

    required

    A query containing conditions that all need to match against a Data Instance.

    conditions

    object[]

    required

    The query conditions.

  • Array [

    • propertyName stringrequired

    The name of the property on the Data Instance as defined in the Data Specification.

    condition stringrequired
    matchMissingValue boolean

    (Optional) If a given Data Instance is missing a value for the property that this condition targets, should this condition be considered a match. This value can only be specified for properties that are not required on the Data Specification.

  • ]

    • amount

    object

    required

    Represents an amount of money with its currency type.

    currencyCode stringrequired
    units int64required

    The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

    nanos int32required

    Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

  • ]

    • pricing Pricing (string)required

    The Pricing model to use for an Auction.

    Possible values: [FIXED, LOWEST, SECOND, SECOND_PLUS_INCREMENT]

Loading...