additionalAsset Objects – API Help Center

Related Entities

Endpoints Using the additionalAsset Object

Ad Resource

Parent Objects

Child Objects

additionalAsset Object Definition

Note

Note: The Required column includes the following values:

Required: The field must be included in the POST call.
Read-only: The field is received in the GET call and required in the PUT call. It is not required in the POST call. You cannot edit this field.
Optional: If the field was received in the GET call, include it in the PUT call. This field is editable.
Internal: (For Amazon Ad Server (AAS) internal use) If the field was received in the GET call, include it in the PUT call.

Parameter	Description	Type	Required	Notes
type	Type of entity.	String	Required	AdditionalAsset
name	Name of the ad.	String	Required
variants	List of variants of the given assets. Generated via auto-transcoding.	adAsset Object	Read-only
transcodeJobID	Internal.	Long	Internal
assetId	ID of the asset to be used.	Long	Read-only
assetStatus	Status of the asset to be used.	String	Read-only	View values PENDING_INGEST PENDING_TRANSCODING FAILED_INGEST FAILED_TRANSCODING READY
source	Internal.	Boolean	Internal
width	Width of the asset.	Integer	Read-only
height	Height of the asset.	Integer	Read-only
assetName	Name of the asset to be used.	String	Read-only
folderId	ID of the folder in which the asset resides.	Long	Read-only
workspaceFolderId	ID of the Workspace folder in which the asset is located.	Long	Read-only
size	Size (in KB) of the asset.	Long	Read-only
duration	Length of the asset (If applicable).	Long	Read-only
bitRate	Bit rate of the asset (If applicable).	Long	Read-only
mimeType	Label used to identify the type of data.	String	Read-only
mediaType	Media type for the asset.	String	Read-only	View values Image Video JSON Archive Flash HTML/HTML Folder Audio HLS_M308
format	Format of the asset, depending on the mediaType.	String	Read-only	Examples include jpg and mp4.
external	Determines if the asset is external.	Boolean	Internal
thumbnailUrl	Path to where the image is stored.	String	Required
id	ID of the ad.	Long	Read-only
relationsBag	Internal.	relationsBag Object	Read-only

Object JSON Example

  "additionalAssets": [{
        "type": "AdditionalAsset",
        "id": 123456789012345,
        "relationsBag": null,
        "assetId": 2134567890,
        "assetName": "oldAsset-15adaad4-5914-4dc6-bdf4-76d9f89bdb3e",
        "source": true,
        "assetStatus": null,
        "folderId": 1234567891,
        "workspaceFolderId": 0,
        "size": 14040,
        "duration": null,
        "bitRate": null,
        "width": 300,
        "height": 250,
        "mimeType": "application/x-shockwave-flash",
        "mediaType": "FLASH",
        "format": null,
        "thumbnailUrl": null,
        "external": false,
        "variants": null,
        "transcodeJobID": null,
        "name": "1"
    }, {
        "type": "AdditionalAsset",
        "id": 12345678912345,
        "relationsBag": null,
        "assetId": 1234567890,
        "assetName": "CRT_QAPositiveImage2.jpg",
        "source": true,
        "assetStatus": null,
        "folderId": 1234567890,
        "workspaceFolderId": 0,
        "size": 36347,
        "duration": null,
        "bitRate": null,
        "width": 300,
        "height": 250,
        "mimeType": "image/jpeg",
        "mediaType": "IMAGE",
        "format": null,
        "thumbnailUrl": "http://resources-dev-sizmdx.s3.amazonaws.com/CI/asset/1234567890/IMAGE/20181010/CRT_QAPositiveImage2_12328906326523958.jpg",
        "external": false,
        "variants": null,
        "transcodeJobID": null,
        "name": "2"
    }],

adAsset Object

Related Entities

Endpoints Using the adAsset Object

Ad Resource

Parent Objects

adAsset Object Definition

Note

Note: The Required column includes the following values:

Required: The field must be included in the POST call.
Read-only: The field is received in the GET call and required in the PUT call. It is not required in the POST call. You cannot edit this field.
Optional: If the field was received in the GET call, include it in the PUT call. This field is editable.
Internal: (For Amazon Ad Server (AAS) internal use) If the field was received in the GET call, include it in the PUT call.

Name	Description	Type	Required	Notes
type	Type of entity.	String	Required	AdAsset
id	ID of the ad.	Long	Read-only
relationsBag	Internal.	relationsBag Object	Read-only
version	Internal.	Long	Read-only
assetId	ID of the asset to be used.	Long	Read-only
assetStatus	Status of the asset to be used.	String	Read-only	View values PENDING_INGEST PENDING_TRANSCODING FAILED_INGEST FAILED_TRANSCODING READY
width	Width of the asset.	Integer	Read-only	Width is in pixels.
height	Height of the asset.	Integer	Read-only	Height is in pixels.
assetName	Name of the asset to be used.	String	Read-only
source	Internal.	Boolean	Internal
folderId	ID of the folder in which the asset resides.	Long	Read-only
workspaceFolderId	ID of the Workspace folder in which the asset is located.	Long	Read-only
size	Size of the asset.	Long	Read-only	Size is in bytes.
duration	Length of the asset (If applicable).	Long	Read-only	Duration is in milliseconds.
bitRate	Bit rate of the asset (If applicable).	Long	Read-only	bitRate is bits per second.
mimeType	Label used to identify the type of data.	String	Read-only
mediaType	Media type for the asset.	String	Read-only	View values Image Video JSON Archive Flash HTML/HTML Folder Audio HLS_M308
format	Format of the asset, depending on the mediaType.	String	Read-only	Examples include jpg and mp4.
external	Determines if the asset is external.	Boolean	Internal
thumbnailUrl	URL of the asset thumbnail image.	String	Read-only

Object JSON Example

  "...,
    "defaultImage": {
        "type": "AdAsset",
        "id": 12345665789,
        "relationsBag": null,
        "version": null,
        "assetId": 1234566789,
        "assetName": "CRT_CreativeQApositiveImage.jpg",
        "source": true,
        "assetStatus": null,
        "folderId": 1234355678,
        "workspaceFolderId": 0,
        "size": 36347,
        "duration": null,
        "bitRate": null,
        "width": 300,
        "height": 250,
        "mimeType": "image/jpeg",
        "mediaType": "IMAGE",
        "format": null,
        "thumbnailUrl": "http://resources-dev-sizmdx.s3.amazonaws.com/DEV1/asset/12345667899/IMAGE/23423444/CRT_CreativeQApositiveImage_29856856971149325.jpg",
        "external": false
    },
    ...,

Related Entities

Endpoints Using the additionalAsset Object

Parent Objects

Child Objects

additionalAsset Object Definition

Note

Object JSON Example

adAsset Object

Related Entities

Endpoints Using the adAsset Object

Parent Objects

adAsset Object Definition

Note

Object JSON Example

Comments