Skip to content

Get creative by ID

GET
/creatives/{id}
curl --request GET \
--url https://gateway.staging.arago-tech.com/creatives/example

Returns the creative details by ID

id
required
string

The unique identifier of the creative in hexadecimal format

creative_id
string

Creative ID

Deprecated: ignored. The creative ID is read from the id path parameter

A successful response.

Media typeapplication/json
Creative

Creative details

object
id
Creative ID

The unique identifier of the creative in hexadecimal format

string
tags
Tags

Tags associated with the creative

Array<string>
name
Name

The name of the creative

string
source_url
Source URL

The original URL of the creative

string
thumbnail_url
Thumbnail URL

The URL of the creative thumbnail

string
generated_url
Generated URL

The URL of the generated creative

string
dynamic_content_optimization_id
Dynamic Content Optimization ID

The unique identifier of the dynamic content optimization of the creative

string
is_generating
Is Generating

Indicates whether the creative is currently generating

boolean
width
Width

The width of the creative

integer format: int64
height
Height

The height of the creative

integer format: int64
aspect_ratio
Aspect Ratio

The aspect ratio of the creative (width / height). Explicitly set or computed from non-zero dimensions. Leaving width, height and aspect_ratio at zero makes the creative eligible for every slot size with usable dimensions.

number format: double
metadata
Metadata

Free-form metadata of the creative as key/value pairs. Any key may be set, and none is required.

object
key
additional properties
string
updated_at
Updated At

The UTC last updated date of the creative

string format: date-time
created_at
Created At

The UTC created date of the creative

string format: date-time
format
Format

The format of the creative

string
default: FORMAT_UNSPECIFIED
Allowed values: FORMAT_UNSPECIFIED FORMAT_HTML FORMAT_JSON FORMAT_VAST
language
Language

The language of the creative

string
default: LANGUAGE_UNSPECIFIED
Allowed values: LANGUAGE_UNSPECIFIED AA AB AE AF AK AM AN AR AS AV AY AZ BA BE BG BH BI BM BN BO BR BS CA CE CH CO CR CS CU CV CY DA DE DV DZ EE EL EN EO ES ET EU FA FF FI FJ FO FR FY GA GD GL GN GU GV HA HE HI HR HT HU HY HZ IA ID IE IG II IK IO IS IT IU JA JV KA KG KI KJ KK KL KM KN KO KR KS KU KV KW KY LA LB LG LI LN LO LT LU LV MG MH MI MK ML MN MR MS MT MY NA NB ND NE NG NL NN NO NR NV NY OC OJ OM OR OS PA PI PL PS PT QU RM RN RO RU RW SA SC SD SE SG SI SK SL SM SN SO SQ SR SS ST SU SV SW TA TE TG TH TI TK TL TN TO TR TS TT TW TY UG UK UR UZ VE VI VO WA WO XH YI YO ZA ZH ZU
Example
{
"id": "63e2d42a27ad5f2b345ca123",
"tags": [
"tag1",
"tag2",
"tag3"
],
"name": "Creative name",
"source_url": "https://example.com/image.png",
"thumbnail_url": "https://example.com/thumbnail.jpg",
"generated_url": "https://example.com/generated_image.png",
"dynamic_content_optimization_id": "63e2d42a27ad5f2b345ca123",
"width": 100,
"height": 100,
"aspect_ratio": 1.7777777777777777,
"updated_at": "2023-01-01T00:00:00Z",
"created_at": "2023-01-01T00:00:00Z",
"format": "FORMAT_UNSPECIFIED",
"language": "LANGUAGE_UNSPECIFIED"
}

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"
}
]
}