Create a Data Auction for a Data Specification
POST/v1/data-auction/:dataSpecificationId
Create a Data Auction for a Data Specification
Request
Path Parameters
- application/json
Body
Array [
]
Array [
Array [
]
]
auctionSettings
object
required
The settings for an Auction.
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?
Is it possible to create bid amounts with zero value?
If there are multiple Campaigns from the same buyer that match, do we use the highest bid?
Possible values: [FENCE_POST]
bidIncrements
object[]
required
A list of bid increments.
increment
object
required
Represents an amount of money with its currency type.
The whole units of the amount.
For example if currencyCode is "USD", then 1 unit is one US dollar.
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.
The whole units of the amount.
For example if currencyCode is "USD", then 1 unit is one US dollar.
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.
The Start Pricing model.
Possible values: [RAMPED, STEPPED]
startPrices
object[]
required
A list of start prices.
query
object
required
A query containing conditions that all need to match against a Data Instance.
conditions
object[]
required
The query conditions.
The name of the property on the Data Instance as defined in the Data Specification.
(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.
The whole units of the amount.
For example if currencyCode is "USD", then 1 unit is one US dollar.
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.
The Pricing model to use for an Auction.
Possible values: [FIXED, LOWEST, SECOND, SECOND_PLUS_INCREMENT]
Responses
- 200
- default
OK
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
Array [
]
]
auctionSettings
object
required
The settings for an Auction.
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?
Is it possible to create bid amounts with zero value?
If there are multiple Campaigns from the same buyer that match, do we use the highest bid?
Possible values: [FENCE_POST]
bidIncrements
object[]
required
A list of bid increments.
increment
object
required
Represents an amount of money with its currency type.
The whole units of the amount.
For example if currencyCode is "USD", then 1 unit is one US dollar.
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.
The whole units of the amount.
For example if currencyCode is "USD", then 1 unit is one US dollar.
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.
The Start Pricing model.
Possible values: [RAMPED, STEPPED]
startPrices
object[]
required
A list of start prices.
query
object
required
A query containing conditions that all need to match against a Data Instance.
conditions
object[]
required
The query conditions.
The name of the property on the Data Instance as defined in the Data Specification.
(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.
The whole units of the amount.
For example if currencyCode is "USD", then 1 unit is one US dollar.
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.
The Pricing model to use for an Auction.
Possible values: [FIXED, LOWEST, SECOND, SECOND_PLUS_INCREMENT]
{
"timestamp": "2024-07-29T15:51:28.071Z",
"dataSpecificationId": "string",
"auctionSettings": {
"adjustBidIfBalanceIsLow": true,
"allowZeroMoneyBids": true,
"chargeHighestBidFromSameBidder": true,
"bidIncrementType": "FENCE_POST",
"bidIncrements": [
{
"increment": {
"currencyCode": "string",
"units": "string",
"nanos": 0
},
"amount": {
"currencyCode": "string",
"units": "string",
"nanos": 0
}
}
],
"startPricing": "RAMPED",
"startPrices": [
{
"query": {
"conditions": [
{
"propertyName": "string",
"condition": "string",
"matchMissingValue": true
}
]
},
"amount": {
"currencyCode": "string",
"units": "string",
"nanos": 0
}
}
],
"pricing": "FIXED"
}
}
Error
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
An error status code describing the response.
| Enum Value | Description |
|---|---|
| 0 | OK |
| 1 | Cancelled |
| 2 | Unknown |
| 3 | InvalidArgument |
| 4 | DeadlineExceeded |
| 5 | NotFound |
| 6 | AlreadyExists |
| 7 | PermissionDenied |
| 8 | ResourceExhausted |
| 9 | FailedPrecondition |
| 10 | Aborted |
| 11 | OutOfRange |
| 12 | Unimplemented |
| 13 | Internal |
| 14 | Unavailable |
| 15 | DataLoss |
| 16 | Unauthenticated |
Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]
A developer-facing error message
details
object[]
A list of messages containing details about the errors
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}