Product placement & replacement

The various methods for Product placement & replacement Settings are listed below:

Product placement

Places a product image into a generated scene.

Parameters

Field	Data Type	Requirement	Description
image	string	Mandatory	Product image URL or base64 data
width	integer	Mandatory	Target output width
height	integer	Mandatory	Target output height
prompt	string	Mandatory	Scene description prompt

Sample Request

HTTP
    
 
POST https://jivoxapis.api.jivox.com/v2/accounts/:accountId/productPlacement
Copy

Request Body

JSON
    
 
{  "image": "https://cdn.example.com/product.png",  "width": 300,  "height": 250,  "prompt": "Place product on a wooden shelf in a kitchen"}
Copy

Sample Response

JSON
    
 
{  "imageUrl": "https://cdn.example.com/generated/placed-001.png"}
Copy

Product replacement

Replaces a product in a scene image with another product image.

Parameters

Field	Data Type	Requirement	Description
sceneImage	string	Mandatory	Scene image URL or base64 data
productImage	integer	Mandatory	New product image URL or base64 data
regenerate	boolean	Optional	Whether to regenerate if already processed. Defaults to `false`.

Sample Request

HTTP
    
 
POST https://jivoxapis.api.jivox.com/v2/accounts/:accountId/productReplacement
Copy

Request Body

JSON
    
 
{  "sceneImage": "https://cdn.example.com/scene.jpg",  "productImage": "https://cdn.example.com/new-product.png",  "regenerate": false}
Copy

Sample Response

JSON
    
 
{  "imageUrl": "https://cdn.example.com/generated/replaced-001.png"}
Copy

Fetch image assets

Fetches and sorts image assets from a feed or media channel for use in an ad unit.

Parameters

Field	Data Type	Requirement	Description
adIdx	integer	Mandatory	Ad index
adUnitIdx	integer	Mandatory	Ad unit index
dataServiceId	integer	Mandatory	Data service (feed) ID
sourceType	string	Mandatory	Source type (e.g. `productFeed`)
assetKey	string	Optional	Feed column key for the image asset
mediaChannelIdx	integer	Optional	Media channel index to scope asset fetching
keywords	string	Optional	Search keywords to filter assets
pageSize	integer	Optional	Number of assets to return. Defaults to `10.`
countryCode	string	Optional	Country code to filter assets. Defaults to `US.`

Sample Request

HTTP
    
 
POST https://jivoxapis.api.jivox.com/v2/accounts/:accountId/fetchImageAssets
Copy

Request Body

JSON
    
 
{  "adIdx": 200,  "adUnitIdx": 2000,  "dataServiceId": 1,  "sourceType": "productFeed",  "assetKey": "image_url",  "mediaChannelIdx": 3,  "keywords": "running shoes",  "pageSize": 10,  "countryCode": "US"}
Copy

Sample Response

Sorted list of image asset URLs/objects from the feed.

JSON
    
 
[  { "url": "https://cdn.example.com/img/001.jpg", "score": 0.95 },  { "url": "https://cdn.example.com/img/002.jpg", "score": 0.88 }]
Copy

Last updated on

Was this page helpful?