Upsert creatives
const url = 'https://gateway.staging.arago-tech.com/creatives';const options = { method: 'PUT', headers: {'Content-Type': 'application/json'}, body: '{"creatives":[{"format":"FORMAT_HTML","height":250,"language":"FR","name":"HTML creative","source_url":"https://example.com/banner.png","width":300},{"format":"FORMAT_JSON","height":627,"language":"FR","metadata":{"call_to_action":"Click here","description":"Description of the creative","icon_image_url":"https://example.com/icon.png","sponsored_by":"Sponsored by XYZ","title":"Title of the creative"},"name":"Native creative","source_url":"https://example.com/main.png","width":1200}]}'};
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/creatives \ --header 'Content-Type: application/json' \ --data '{ "creatives": [ { "format": "FORMAT_HTML", "height": 250, "language": "FR", "name": "HTML creative", "source_url": "https://example.com/banner.png", "width": 300 }, { "format": "FORMAT_JSON", "height": 627, "language": "FR", "metadata": { "call_to_action": "Click here", "description": "Description of the creative", "icon_image_url": "https://example.com/icon.png", "sponsored_by": "Sponsored by XYZ", "title": "Title of the creative" }, "name": "Native creative", "source_url": "https://example.com/main.png", "width": 1200 } ] }'Creates or updates multiple creatives.
Request Body
Section titled “Request Body”The request to creates or updates creatives
The request to creates or updates creatives
object
List of creatives to create or update. If the creative ID is provided, the existing creative will be updated. Otherwise, a new creative will be created. The format field is required: FORMAT_HTML for a standard HTML creative or FORMAT_JSON for a native (JSON) creative.
Creative details for upsert.
The creative format is set with the required format field: HTML (FORMAT_HTML) for a display creative or native (JSON) (FORMAT_JSON) for a native creative.
For a valid native creative, set format to FORMAT_JSON and provide source_url (used as the native main image), width and height (the main image dimensions, matched against the native impression’s main image within a 10% tolerance) and the native asset fields in metadata. The fields map to the OpenRTB Native 1.2 response assets as follows: source_url -> main image, metadata.icon_image_url -> icon image, metadata.title -> title, metadata.sponsored_by -> data (sponsored), metadata.description -> data (desc), metadata.call_to_action -> data (cta). Assets are omitted when their field is empty.
object
The creative unique identifier. If not provided, a new creative will be created.
Example
63e2d42a27ad5f2b345ca123Tags associated with the creative. Each tag must be 3 to 255 characters and must not contain only whitespace (NOT_BLANK). Tags are not trimmed.
Example
[ "tag1", "tag2", "tag3"]The name of the creative. Must not contain only whitespace (NOT_BLANK). Length is checked before surrounding whitespace is trimmed on write; the response returns the stored name.
Example
Creative nameThe original URL of the creative
Example
https://example.com/image.pngThe URL of the creative thumbnail. Must point to a jpeg, jpg, png or gif image.
Example
https://example.com/thumbnail.jpgThe dynamic content optimization unique identifier for the creative
Example
63e2d42a27ad5f2b345ca123The width of the creative. Width and height must both be zero or both be positive. Leaving width, height and aspect_ratio at zero makes the creative eligible for every slot size with usable dimensions.
Example
100The height of the creative. Width and height must both be zero or both be positive. Leaving width, height and aspect_ratio at zero makes the creative eligible for every slot size with usable dimensions.
Example
100Free-form metadata as key/value pairs. Any key may be set, and none is required. For a native (JSON) creative (format set to FORMAT_JSON), the well-known keys title, sponsored_by, description, call_to_action, icon_image_url, icon_width and icon_height are rendered into the OpenRTB Native response. When set, icon_image_url must be a valid URI and icon_width / icon_height must be positive integers. Any other key is stored and returned verbatim.
object
The language of the creative
Example
FRThe format of the creative. Required: set FORMAT_HTML for a display creative or FORMAT_JSON for a native creative.
Example
FORMAT_HTMLThe aspect ratio of the creative (width / height). Computed from non-zero width and height when omitted. An explicit ratio restricts matching even without dimensions. Leaving width, height and aspect_ratio at zero makes the creative eligible for every slot size with usable dimensions.
Example
1.7777777777777777Example
[ { "format": "FORMAT_HTML", "height": 250, "language": "FR", "name": "HTML creative", "source_url": "https://example.com/banner.png", "width": 300 }, { "format": "FORMAT_JSON", "height": 627, "language": "FR", "metadata": { "call_to_action": "Click here", "description": "Description of the creative", "icon_image_url": "https://example.com/icon.png", "sponsored_by": "Sponsored by XYZ", "title": "Title of the creative" }, "name": "Native creative", "source_url": "https://example.com/main.png", "width": 1200 }]Responses
Section titled “ Responses ”A successful response.
Response containing a list of upserted creatives.
object
List of upserted creatives
Creative details
object
The unique identifier of the creative in hexadecimal format
Tags associated with the creative
The name of the creative
The original URL of the creative
The URL of the creative thumbnail
The URL of the generated creative
The unique identifier of the dynamic content optimization of the creative
Indicates whether the creative is currently generating
The width of the creative
The height of the creative
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.
Free-form metadata of the creative as key/value pairs. Any key may be set, and none is required.
object
The UTC last updated date of the creative
The UTC created date of the creative
The format of the creative
The language of the creative
Example
{ "creatives": [ { "format": "FORMAT_HTML", "height": 100, "id": "63e2d42a27ad5f2b345ca123", "language": "FR", "metadata": { "brand_color": "#ff0000", "call_to_action": "Click here", "description": "Description of the creative", "icon_height": "50", "icon_image_url": "https://example.com/icon.png", "icon_width": "50", "sponsored_by": "Sponsored by XYZ", "title": "Title of the creative" }, "name": "Creative name", "width": 100 } ]}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" } ]}