Skip to content

Create campaign

PUT
/line-items/campaigns
curl --request PUT \
--url https://gateway.staging.arago-tech.com/line-items/campaigns \
--header 'Content-Type: application/json' \
--data '{ "name": "Discount on products", "description": "Campaign to promote discount on products in the store", "line_items": [ { "budget": { "amount": 1000, "currency": "EUR" }, "end_date": "2021-01-31T00:00:00Z", "name": "Discount on products", "start_date": "2021-01-01T00:00:00Z" } ] }'

Creates a campaign with line items

The request to create a campaign with associated line items

Media typeapplication/json
Create a campaign with line items

The request to create a campaign with associated line items

object
name
required

The name of the campaign. Must not contain only whitespace (NOT_BLANK). Length is checked before surrounding whitespace is trimmed on write; the response returns the stored name.

string
>= 1 characters <= 255 characters
Example
Discount on products
description
Description

The description of the campaign

string
>= 1 characters <= 1024 characters
Example
Campaign to promote discount on products in the store
line_items
required
Line Items

The list of line items to be associated with the campaign

Array<object>
LineItem

The line item to associate with the campaign

object
name
Name

The name of the line item. Optional; omitted names default to Line item N. Supplied names must not contain only whitespace (NOT_BLANK). Length is checked before surrounding whitespace is trimmed on write.

string
>= 1 characters <= 255 characters
Example
A/B Test, version with 3D creative
start_date
required
Start date

The start date and time of the line item

string format: date-time
Example
2021-01-01T00:00:00Z
end_date
required
End date

The end date and time of the line item

string format: date-time
Example
2021-01-31T00:00:00Z
tags
Tags

The tags associated with the line item. Each tag must be 3 to 255 characters and must not contain only whitespace (NOT_BLANK). Tags are not trimmed.

Array<string>
Example
[
"tag1",
"tag2"
]
budget
required
Budget

The spending cap of the line item

object
amount
required
Amount

Total budget in the given currency. It must be at least 10 USD once converted; conversion is applied server-side after submission, so the smallest accepted value depends on the selected currency.

number format: double
Example
1000
currency
required
Currency codes as specified in ISO 4217 buf:lint:ignore ENUM_VALUE_PREFIX

Currency ID based on ISO 4217 numeric codes. The bond market units (XBA, XBB, XBC, XBD), the supranational units of account (XUA, XSU) and the fund codes (BOV, CHE, CHW, CLF, COU, USN, UYI) are rejected: no exchange rate is published for them, so a budget denominated in one could not be converted to USD.

string
default: CURRENCY_UNSPECIFIED
Allowed values: CURRENCY_UNSPECIFIED ALL DZD ARS AUD BSD BHD BDT AMD BBD BMD BTN BOB BWP BZD SBD BND MMK BIF KHR CAD CVE KYD LKR CLP CNY COP KMF CRC HRK CUP CZK DKK DOP SVC ETB ERN FKP FJD DJF GMD GIP GTQ GNF GYD HTG HNL HKD HUF ISK INR IDR IRR IQD ILS JMD JPY KZT JOD KES KPW KRW KWD KGS LAK LBP LSL LVL LRD LYD LTL MOP MWK MYR MVR MRO MUR MXN MNT MDL MAD OMR NAD NPR ANG AWG VUV NZD NIO NGN NOK PKR PAB PGK PYG PEN PHP QAR RUB RWF SHP STD SAR SCR SLL SGD VND SOS ZAR SSP SZL SEK CHF SYP THB TOP TTD AED TND UGX MKD EGP GBP TZS USD UYU UZS WST YER ZMK TWD SLE VES CUC ZWL BYN TMT GHS VEF SDG UYI RSD MZN AZN RON CHE CHW TRY XAF XCD XOF XPF XBA XBB XBC XBD XAU XDR XAG XPT XPD XUA ZMW SRD MGA COU AFN TJS AOA BYR BGN CDF BAM EUR MXV UAH GEL BOV PLN BRL CLF XSU USN JEP IMP GGP BTC
Example
978
Example
[
{
"budget": {
"amount": 1000,
"currency": "EUR"
},
"end_date": "2021-01-31T00:00:00Z",
"name": "Discount on products",
"start_date": "2021-01-01T00:00:00Z"
}
]

A successful response.

Media typeapplication/json
Create campaign response

The unique resource identifier of the uploaded list

object
id
Campaign ID

The campaign unique identifier

string
name

The stored campaign name, with surrounding whitespace trimmed.

string
>= 1 characters <= 255 characters
description
Description

The description of the campaign

string
>= 1 characters <= 1024 characters
line_items
Line Items

List of line items

Array<object>
LineItem

Line item information

object
id
Line Item ID

The unique identifier of the line item in hexadecimal format

string
campaign_id
Campaign ID

The campaign unique identifier

string
name
Name

The name of the line item

string
start_date
Start Date

The UTC start date of the line item

string format: date-time
end_date
End Date

The UTC end date of the line item

string format: date-time
status
Status

The status of the line item

string
default: STATUS_UNSPECIFIED
Allowed values: STATUS_UNSPECIFIED STATUS_PAUSED STATUS_PLAYING
creative_ids
Creative IDs

The unique identifiers of the creatives of the line item

Array<string>
targeting_id
Targeting ID

The unique identifier of the targeting of the line item

string
dynamic_content_optimization_id
Dynamic Content Optimization ID

The unique identifier of the dynamic content optimization of the line item

string
pricing_policy_id
Pricing Policy ID

The unique identifier of the pricing policy of the line item

string
banker_id
Banker ID

The unique identifier of the banker of the line item

string
created_at
Created At

The UTC creation date of the line item

string format: date-time
updated_at
Updated At

The UTC last updated date of the line item

string format: date-time
tags
Tags

The tags associated with the line item

Array<string>
tracking_id
Tracking ID

The unique identifier of the tracking of the line item

string
budget
Budget

The spending cap of the line item

object
amount
Amount

Total budget in the given currency, as entered

number format: double
currency
Currency codes as specified in ISO 4217 buf:lint:ignore ENUM_VALUE_PREFIX

Currency ID based on ISO 4217 numeric codes

string
default: CURRENCY_UNSPECIFIED
Allowed values: CURRENCY_UNSPECIFIED ALL DZD ARS AUD BSD BHD BDT AMD BBD BMD BTN BOB BWP BZD SBD BND MMK BIF KHR CAD CVE KYD LKR CLP CNY COP KMF CRC HRK CUP CZK DKK DOP SVC ETB ERN FKP FJD DJF GMD GIP GTQ GNF GYD HTG HNL HKD HUF ISK INR IDR IRR IQD ILS JMD JPY KZT JOD KES KPW KRW KWD KGS LAK LBP LSL LVL LRD LYD LTL MOP MWK MYR MVR MRO MUR MXN MNT MDL MAD OMR NAD NPR ANG AWG VUV NZD NIO NGN NOK PKR PAB PGK PYG PEN PHP QAR RUB RWF SHP STD SAR SCR SLL SGD VND SOS ZAR SSP SZL SEK CHF SYP THB TOP TTD AED TND UGX MKD EGP GBP TZS USD UYU UZS WST YER ZMK TWD SLE VES CUC ZWL BYN TMT GHS VEF SDG UYI RSD MZN AZN RON CHE CHW TRY XAF XCD XOF XPF XBA XBB XBC XBD XAU XDR XAG XPT XPD XUA ZMW SRD MGA COU AFN TJS AOA BYR BGN CDF BAM EUR MXV UAH GEL BOV PLN BRL CLF XSU USN JEP IMP GGP BTC
amount_in_usd
Amount in USD

The budget converted to USD at the rate in force when its amount or currency last changed, net of the platform fee

number format: double
created_at
Created At

The creation date and time of the line item

string format: date-time
updated_at
Updated At

The last update date and time of the targeting

string format: date-time
Example
{
"id": "63e2d42a27ad5f2b345ca123",
"name": "Discount on products",
"description": "Campaign to promote discount on products in the store",
"line_items": [
{
"id": "63e2d42a27ad5f2b345ca123",
"name": "Line Item 1"
},
{
"id": "63e2d42a27ad5f2b345ca124",
"name": "Line Item 2"
}
],
"created_at": "2021-01-01T00:00:00Z",
"updated_at": "2021-01-01T00:00:00Z"
}

Bad request

Media typeapplication/json
object
Example
{
"error": {
"code": "BAD_REQUEST",
"details": [
{
"code": "PATTERN",
"field": "username",
"message": "does not match regex pattern `^[a-zA-Z]*$`"
},
{
"code": "MIN_LEN",
"field": "username",
"message": "must be at least 3 characters",
"params": {
"min": "3"
}
}
],
"message": "Bad request"
}
}

Unauthorized

Media typeapplication/json
object
Example
{
"error": {
"code": "UNAUTHORIZED",
"message": "Unauthorized"
}
}

Forbidden

Media typeapplication/json
object
Example
{
"error": {
"code": "FORBIDDEN",
"message": "Forbidden"
}
}

Not found

Media typeapplication/json
object
Example
{
"error": {
"code": "NOT_FOUND",
"message": "Not found"
}
}

Internal server error

Media typeapplication/json
object
Example
{
"error": {
"code": "INTERNAL",
"details": [
{
"code": "INTERNAL",
"field": "line_items[0]",
"message": "Couldn't upsert line item"
},
{
"code": "INTERNAL",
"field": "line_items[380]",
"message": "Couldn't upsert line item"
}
],
"message": "Internal server error"
}
}

Gateway timeout

Media typeapplication/json
object
Example
{
"error": {
"code": "TIMEOUT",
"details": [
{
"code": "TIMEOUT",
"field": "request",
"message": "Request processing time exceeded deadline",
"params": {
"duration": "30s"
}
}
],
"message": "Gateway timeout"
}
}

An unexpected error response.

Media typeapplication/json
object
code
integer format: int32
message
string
details
Array<object>

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

In its binary encoding, an Any is an ordinary message; but in other wire forms like JSON, it has a special encoding. The format of the type URL is described on the type_url field.

Protobuf APIs provide utilities to interact with Any values:

  • A ‘pack’ operation accepts a message and constructs a generic Any wrapper around it.
  • An ‘unpack’ operation reads the content of an Any message, either into an existing message or a new one. Unpack operations must check the type of the value they unpack against the declared type_url.
  • An ‘is’ operation decides whether an Any contains a message of the given type, i.e. whether it can ‘unpack’ that type.

The JSON format representation of an Any follows one of these cases:

  • For types without special-cased JSON encodings, the JSON format representation of the Any is the same as that of the message, with an additional @type field which contains the type URL.
  • For types with special-cased JSON encodings (typically called ‘well-known’ types, listed in https://protobuf.dev/programming-guides/json/#any), the JSON format representation has a key @type which contains the type URL and a key value which contains the JSON-serialized value.

The text format representation of an Any is like a message with one field whose name is the type URL in brackets. For example, an Any containing a foo.Bar message may be written [type.googleapis.com/foo.Bar] { a: 2 }.

object
@type

Identifies the type of the serialized Protobuf message with a URI reference consisting of a prefix ending in a slash and the fully-qualified type name.

Example: type.googleapis.com/google.protobuf.StringValue

This string must contain at least one / character, and the content after the last / must be the fully-qualified name of the type in canonical form, without a leading dot. Do not write a scheme on these URI references so that clients do not attempt to contact them.

The prefix is arbitrary and Protobuf implementations are expected to simply strip off everything up to and including the last / to identify the type. type.googleapis.com/ is a common default prefix that some legacy implementations require. This prefix does not indicate the origin of the type, and URIs containing it are not expected to respond to any requests.

All type URL strings must be legal URI references with the additional restriction (for the text format) that the content of the reference must consist only of alphanumeric characters, percent-encoded escapes, and characters in the following set (not including the outer backticks): /-.~_!$&()*+,;=. Despite our allowing percent encodings, implementations should not unescape them to prevent confusion with existing parsers. For example, type.googleapis.com%2FFoo should be rejected.

In the original design of Any, the possibility of launching a type resolution service at these type URLs was considered but Protobuf never implemented one and considers contacting these URLs to be problematic and a potential security issue. Do not attempt to contact type URLs.

string
key
additional properties
any
Examplegenerated
{
"code": 1,
"message": "example",
"details": [
{
"@type": "example"
}
]
}