Assets API

The Assets API allows you to manage your assets (get and create).

Authentication

Authentication

Bearer API authentication

Get Assets

Get Assets

Description: Use this API to retrieve a list of your assets. The response will include the following: id, titleId, type, orientation, source, duration.

Required parameters: None

Method: GET

Endpoint: https://api.ironsrc.com/advertisers/v2/assets?

Parameters

Parameters

Request Example

Get https://api.ironsrc.com/advertisers/v2/assets?

Response example

{
	"assets": [{
		"id": 200305,
		"type": "video",
		"titleId": 501567,
		"orientation": "all",
		"source": "none",
		"duration": 30
	}, {
		"id": 200304,
		"type": "image",
		"titleId": 501567,
		"orientation": "all",
		"source": "none",
		"duration": null
	}, {
		"id": 200303,
		"type": "html_iec",
		"titleId": 501567,
		"orientation": "all",
		"source": "playworks",
		"duration": null
	}, {
		"id": 200302,
		"type": "video",
		"titleId": 501567,
		"orientation": "all",
		"source": "none",
		"duration": 17
	}, {
		"id": 200301,
		"type": "html",
		"titleId": 501567,
		"orientation": "portrait",
		"source": "none",
		"duration": null
	}, {
		"id": 200300,
		"type": "html_iec",
		"titleId": 501567,
		"orientation": "portrait",
		"source": "none",
		"duration": null
	}],
	"totalResultsCount": 6,
	"requestId": "MjA1MzUzLjIwMDMwMy40LjM1OTY="
}

The API returns by default the first 3000 assets.

For better performance - we strongly recommend to work with pagination requests in all cases,

To do so you should use resultsBulkSize parameter - This parameter will limit the amount of the results you get in the response.

In order to get the next bulk of results, use pageNumber parameter, combined with the requestId parameter - which is received in the first response.

Pagination request Example URL

Pagination request Example URL

In the first request you set the results number limitation: https://api.ironsrc.com/advertisers/v2/assets?resultsBulkSize=2

Pagination response example:

{
	"assets": [{
		"id": 200305,
		"type": "video",
		"titleId": 501567,
		"orientation": "all",
		"source": "none",
		"duration": 30
	}, {
		"id": 200304,
		"type": "image",
		"titleId": 501567,
		"orientation": "all",
		"source": "none",
		"duration": null
	}],
	"totalResultsCount": 6,
	"requestId": "MjA1MzUzLjIwMDMwMy40LjM1OTY="
}

For the next pages, use the requestId from the response and the required pageNumber.

For example: https://api.ironsrc.com/advertisers/v2/assets?requestId=MjE2MDkzLjUwMTEwMC4yLjE5&pageNumber=2

Keep increasing the pageNumber param to get the following pages.

Upload image & video Assets

Upload image & video Assets

Description: Use this API in order to upload and create a new asset for a specific title.

Method: POST

Content type: multipart/form-data

Endpoint: https://api.ironsrc.com/advertisers/v2/assets?

Body parameters

Body parameters

File requirements

File requirements

Supported image file formats

Supported image file formats

• png, jpg, jpeg, gif
• Maximum file size: 2MB
• Minimum dimension: 320px
• Max dimension: 3,840px
• Ratio: From 1:2 to 2:1

Supported video file format

Supported video file format

• Maximum file size: 100MB
• Maximum duration: 60sec
• Ratio: From 1:2 to 2:1

Response example

Response example

{
	"assets": [{
		"id": 200314,
		"type": "image",
		"titleId": 411675,
		"orientation": "all",
		"source": "none",
		"duration": null
	}]
}

Upload HTML creative asset

Upload HTML creative asset

Use this API to upload and create your HTML asset file following these instructions:

Step 1 - Upload HTML asset

Step 1 - Upload HTML asset

Description: On this step the asset will be automatically verification to make sure it works well with our ad player. You can use the polling endpoint (step 2) to get the test status.

Method: POST

Content type: multipart/form-data

Endpoint: https://api.ironsrc.com/advertisers/v2/assets/html/upload

Body parameters

Body parameters

Response

Response

{
	"submissionId":'your_submission_id'
}

Duplication is a particular case in which the error message will be:

> _Duplication found - This HTML file already exists - Asset ID: ${existing\_asset\_id}_

• Rate limit: 200 requests per hour
• submissionId is valid for 2 hours

Step 2 - HTML Asset Polling

Step 2 - HTML Asset Polling

Description: use this endpoint to check if the asset passed the automatic verification, if passed, proceed to submit the asset for review (step 3).

Content type: application/json

Method: GET

Endpoint: https://api.ironsrc.com/advertisers/v2/assets/html/polling

Parameters

Parameters

Response

Response

{
	"pollingStatus": "Success" / "Pending" / "Failed",
	"validations": {
		"isReadyCalled": {
			"status": "Success" / "Pending" / "Failed",
			"error": appears only
			if the status = "Failed"
		},
		"getAutoVolumeCalled": {
			"status": "Success" / "Pending" / "Failed",
			"error": appears only
			if the status = "Failed"
		},
		"audioVolumeChangeListened": {
			"status": "Success" / "Pending" / "Failed",
			"error": appears only
			if the status = "Failed"
		},
		"getScreenSizeCalled": {
			"status": "Success" / "Pending" / "Failed",
			"error": appears only
			if the status = "Failed"
		},
		"nativeCloseButton": {
			"status": "Success" / "Pending" / "Failed",
			"error": appears only
			if the status = "Failed"
		}
	}
}

Step 3 - Submit HTML assets for review

Step 3 - Submit HTML assets for review

Description: Use this endpoint to submit asset for our review process.

Content type: application/json

Method: POST

Endpoint: https://api.ironsrc.com/advertisers/v2/assets/html/submit

Body parameters

Body parameters

Response

Response

{
	"assets": [{
		"id": 200314
	}]
}

You can use the asset id provided with the get method to pull the asset approval status.