Auction a Data Instance
POST/v1/auction/:dataSourceId
Auction a Data Instance
Request
Path Parameters
The Data Source identifier.
- application/json
Body
The request received from the client.
Array [
- addressValue
- longValue
- boolValue
- dateValue
- dateRangeValue
- decimalValue
- multiSelectValue
- nameValue
- singleSelectValue
- textValue
- timeOfDayValue
- intValue
]
The Data Source identifier.
dataInstance
object
required
An instance of data with properties and values that conform to a Data Specification.
The Data Specification identifier that this Data Instance conforms to.
properties
object[]
required
The Data Instance properties.
The name of the property.
value
object
required
A property value. Only one value must be specified.
oneOf
addressValue
object
required
An address.
(Optional) The first line of the address.
(Optional) The second line of the address.
(Optional) The town / city of the address.
(Optional) The region of the address.
(Optional) The postal code of the address.
(Optional) The two letter ISO 3166 country code of the address.
latLon
object
An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges.
The latitude in degrees. It must be in the range [-90.0, +90.0].
The longitude in degrees. It must be in the range [-180.0, +180.0].
A 64-bit integer value.
A boolean value.
A date time.
dateRangeValue
object
required
An inclusive date range.
From date, inclusive.
To date, inclusive.
decimalValue
object
required
A representation of a decimal value, such as 2.5
The decimal value, as a string. The string representation consists of an optional sign, +
(U+002B
) or -
(U+002D
), followed by a sequence of zero or more decimal digits ("the integer"), optionally followed by a fraction, optionally followed by an exponent. The fraction consists of a decimal point followed by zero or more decimal digits. The string must contain at least one digit in either the integer or the fraction. The number formed by the sign, the integer and the fraction is referred to as the significand. The exponent consists of the character e
(U+0065
) or E
(U+0045
) followed by one or more decimal digits.
multiSelectValue
object
required
The selection of values from multiple options.
The selected values.
nameValue
object
required
The name of an individual.
(Optional) The title of the individual.
(Optional) The first name of the individual.
(Optional) The last name of the individual.
A selection of a single value.
A text value.
timeOfDayValue
object
required
Represents a time of day. The date and time zone are not significant
Hours of day in 24 hour format. Must be from 0 to 23
Minutes of hour of day. Must be from 0 to 59.
Seconds of minutes of the time. Must be from 0 to 59
Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
A 32-bit integer value.
Responses
- 200
- default
OK
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
When the auction took place.
The Data Instance identifier.
results
object[]
required
The auction results.
The Campaign identifier.
Any metadata registered for this Campaign.
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.
Did the Data Instance sell?
{
"timestamp": "2024-07-29T15:51:28.071Z",
"dataInstanceId": "string",
"results": [
{
"campaignId": "string",
"metadata": "string",
"amount": {
"currencyCode": "string",
"units": "string",
"nanos": 0
}
}
],
"sold": true
}
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"
}
]
}