Get summaries for running Campaigns
GET/v1/campaigns/running
Get summaries for running Campaigns
Responses
- 200
- default
OK
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
]
campaignSummaries
object[]
required
The list of Campaign summaries
balance
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.
bidAmount
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.
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.
{
"campaignSummaries": [
{
"balance": {
"currencyCode": "string",
"units": "string",
"nanos": 0
},
"bidAmount": {
"currencyCode": "string",
"units": "string",
"nanos": 0
},
"id": "string",
"name": "string",
"query": {
"conditions": [
{
"propertyName": "string",
"condition": "string",
"matchMissingValue": true
}
]
},
"buyerUserName": "string"
}
]
}
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"
}
]
}