Create campaign
const url = 'https://gateway.staging.arago-tech.com/line-items/campaigns';const options = { method: 'PUT', headers: {'Content-Type': 'application/json'}, body: '{"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"}]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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
Request Body
Section titled “Request Body”The request to create a campaign with associated line items
The request to create a campaign with associated line items
object
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.
Example
Discount on productsThe description of the campaign
Example
Campaign to promote discount on products in the storeThe list of line items to be associated with the campaign
The line item to associate with the campaign
object
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.
Example
A/B Test, version with 3D creativeThe start date and time of the line item
Example
2021-01-01T00:00:00ZThe end date and time of the line item
Example
2021-01-31T00:00:00ZThe 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.
Example
[ "tag1", "tag2"]The spending cap of the line item
object
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.
Example
1000Currency 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.
Example
978Example
[ { "budget": { "amount": 1000, "currency": "EUR" }, "end_date": "2021-01-31T00:00:00Z", "name": "Discount on products", "start_date": "2021-01-01T00:00:00Z" }]Responses
Section titled “ Responses ”A successful response.
The unique resource identifier of the uploaded list
object
The campaign unique identifier
The stored campaign name, with surrounding whitespace trimmed.
The description of the campaign
List of line items
Line item information
object
The unique identifier of the line item in hexadecimal format
The campaign unique identifier
The name of the line item
The UTC start date of the line item
The UTC end date of the line item
The status of the line item
The unique identifiers of the creatives of the line item
The unique identifier of the targeting of the line item
The unique identifier of the dynamic content optimization of the line item
The unique identifier of the pricing policy of the line item
The unique identifier of the banker of the line item
The UTC creation date of the line item
The UTC last updated date of the line item
The tags associated with the line item
The unique identifier of the tracking of the line item
The spending cap of the line item
object
Total budget in the given currency, as entered
Currency ID based on ISO 4217 numeric codes
The budget converted to USD at the rate in force when its amount or currency last changed, net of the platform fee
The creation date and time of the line item
The last update date and time of the targeting
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
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
object
Example
{ "error": { "code": "UNAUTHORIZED", "message": "Unauthorized" }}Forbidden
object
Example
{ "error": { "code": "FORBIDDEN", "message": "Forbidden" }}Not found
object
Example
{ "error": { "code": "NOT_FOUND", "message": "Not found" }}Internal server error
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
object
Example
{ "error": { "code": "TIMEOUT", "details": [ { "code": "TIMEOUT", "field": "request", "message": "Request processing time exceeded deadline", "params": { "duration": "30s" } } ], "message": "Gateway timeout" }}default
Section titled “default”An unexpected error response.
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
Anywrapper around it. - An ‘unpack’ operation reads the content of an
Anymessage, either into an existing message or a new one. Unpack operations must check the type of the value they unpack against the declaredtype_url. - An ‘is’ operation decides whether an
Anycontains 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
Anyis the same as that of the message, with an additional@typefield 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
@typewhich contains the type URL and a keyvaluewhich 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
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.
Examplegenerated
{ "code": 1, "message": "example", "details": [ { "@type": "example" } ]}