Assets are files that can be used in various advertising formats, such as expandable, floating, or video-streaming ads. Assets can include different types of files, like audio, fonts, images, video, generic, or HTML and XML files.
With the Assets API, you can manage assets. Each asset type has its own dedicated API endpoints within the Assets API, allowing you to manage each category separately. Here's a list of operations available for each asset type:
-
Create new assets.
-
Rename assets.
-
Delete assets.
-
Retrieve assets by UUID or using search.
-
Update asset files.
-
Batch update assets.
-
Update asset events and click tags (only for HtmlAssets endpoints of the Assets API).
In addition to managing assets by specific types, the Assets API provides sections for operations that apply to all assets, regardless of their type:
-
AssetFiles: Download asset files.
-
Assets: Get asset details by UUID, check if asset title is unique, get a unique asset title if the current title isn't unique, retrieve assets by filter.
-
Package: Create new assets from a package. Package is a batch of assets, usually in a .zip file.
|
Asset Type |
Supported Files |
|---|---|
|
Image |
.gif, .jpe, .jpeg (.jpg), .png, .bmp |
|
Video |
.mp4, .webm, .ogv, .wmv, .mov, .mpg, .mpeg, .3gp, .m4v, .mkv |
|
XML |
.xml |
|
Audio |
.mp3, .wav, .ogg, .flac, .wma, .gsm |
|
Fonts |
.tff, .eot, .woff, .woff2, .otf |
|
Generic |
.xls, .xlsx, .obj |
|
HTML |
.zip (for the compressed files) |
To start working with the Assets API, you need:
-
Adform DSP or Ad Server user account that has these permissions assigned:
-
Manage Assets & Banners
-
-
The following scopes assigned to your OAuth client by Adform Support (technical@adform.com):
-
https://api.adform.com/scope/eapi: Grants access to all endpoints of the Assets API.
-
-
The following IDs to use in your requests:
Note
Additional IDs might be used, but the listed ones are required to pass a request.
Note
If you don't have an OAuth client yet, follow the procedure in Get Authentication Credentials for Adform APIs to register one.