Product Content

The various methods for Product Content are listed below:

Get Product Content

This will get the placement to product filters map.

Parameters

Name	Data Type	Requirement	Parameter Type	Description
accountId	string	Mandatory	path	ID of the advertiser account created on the platform.
mediaPlanId	string	Mandatory	path	ID of the media plan associated with a given user account.
retailCampaignId	string	Mandatory	path	ID of the retail campaigns.

Sample Request

HTTP
    
GET http://demo.stub.api.jivox.com/v2/accounts/<accountId>/media-plans/<mediaPlanId>/retail-campaign/:retailCampaignId/content-map
Copy

This is a paginated API. contentType key can only have 3 values i.e. “Product”, “Sub-category”, “Category”. The following set of params can be passed in query params.

filters The value for the filters parameter will be a comma separated string. Each part has to be of the format Field(Operator)Value (the parenthesis are optional but help in parsing the input).

Field will be the same as the fields query parameter.

Valid operators are =,<>,<,>,<=,>=,like,in. < and > are only supported for int field types.

By default, all filters are combined with AND operator. API only returns data that matches all the filters.

The below table lists the following set of params that can be passed in query params

params		Description
limit		Max number of items to return as part of the API response body. Default value is 100.
offset		Starting offset of pagination of data. Default value is 0.
fields		List of fields, comma separated, that the API requester wants to be returned. By default, all the values are returned.
orderby		List of fields, comma separated, that the API requester wants to order the response. use : at after every field and type `asc` or `desc` for ascending and descending ordering respectively. If `asc` or `desc` is not provided the default will be `asc` For example: `orderby=adServerId:asc,adServerName:desc`
filters		The value for the filters parameter will be a comma separated string. Each part has to be of the format `Field(Operator)Value` (the parenthesis are optional but help in parsing the input). Field will be the same as the fields query parameter. Valid operators are =,<>,<,>,<=,>=,like,in. < and > are only supported for `int` field types. By default, all filters are combined with AND operator. API only returns data that matches all the filters.

Sample Response

JSON
    
 
{  contentType: "Product",  numberOfCards: 3,  placementContentMap: [    {      externalPlacementId: "12df3",      placementId: "fhj12"      content: ["Dove Soap", "Dove Moisturising Lotion"],      placementName: "P1",      dimension: "300x250"    },    {      externalPlacementId: "12df4",      placementId: "fhj32"      content: ["Dove shampoo", "Dove conditioner"],      placementName: "P2",      dimension: "300x50"    },    {      externalPlacementId: "12df5",      placementId: "fhj36"      content: [],      placementName: "P3",      dimension: "300x150"    }  ],  "next": "SESSION_BASE/v2/accounts/<accountId>/media-plans/<mediaPlanId>/content-map?next=3ABFT",  "previous": ""}
Copy

List Product/Category/Subcategory from Asset Source

This will list all the Product/Category/SubCategory from the Asset Source.

Parameters

Name	Data Type	Requirement	Parameter Type	Description
accountId	string	Mandatory	path	ID of the advertiser account created on the platform.

Sample Request

HTTP
    
GET http://demo.stub.api.jivox.com/v2/accounts/:accountId/retail-feed-settings/list?fields=product&query=searchQuery&limit=10&offset=0
Copy

The Parameter:

accountId - is the Current account Id

field: product/category/sub-category field

query: the search query input by the user

limit: the limit of elements in the list

offset: the no. of elements to skip

Sample Response

JSON
    
 
{  values: ["Dove Soap", "Dove Conditioner", "Dove Shampoo"]}
Copy

Save/Update Product Content

This will save/update placement to product filters map.

Parameters

Name	Data Type	Requirement	Parameter Type	Description
accountId	string	Mandatory	path	ID of the advertiser account created on the platform.
mediaPlanId	string	Mandatory	path	ID of the media plan associated with a given user account.
retailCampaignId	string	Mandatory	path	ID of the retail campaigns.

Sample Request

HTTP
    
POST http://demo.stub.api.jivox.com/v2/accounts/<accountId>/media-plans/<mediaPlanId>/retail-campaign/:retailCampaignId/content-map
Copy

The placementId key is jivox placement Id and not an external placement Id.

Request Body

JSON
    
 
{  contentType: "Sub-category",  placementContentMap: [    {      placementId: "fhj12",      content: ["Dove Soap", "Dove Moisturising Lotion"]    },    {      placementId: "fhj32",      content: ["Dove shampoo", "Dove conditioner"]    }  ]}
Copy

Placement Preview

This will get previews for the campaign + placement(s).

Parameters

Name	Data Type	Requirement	Parameter Type	Description
accountId	string	Mandatory	path	ID of the advertiser account created on the platform.
campaignId	string	Mandatory	path	ID of the campaign created under a given user account on the platform.
placementId	string	Mandatory	path	ID of the placement associated with media plan to be used for tag generation

Sample Request

HTTP
    
GET http://demo.stub.api.jivox.com/v2/accounts/<accountId>/retail-placement-preview/<campaignid>?pIds=<comma separated placementId>
Copy

Sample Response

JSON
    
{  "placementPreviews" : [    {      "placementId":"p1",      "tags":[            `<script type="text/javascript" src="https://as.jivox.com/unit/unit_renderer.php?bDim=600x250&ap_cgName=Pampers_300x250&isPreviewRequest=1&cId=102&bUnitId=2000"></script>`,            `<script type="text/javascript" src="https://as.jivox.com/unit/unit_renderer.php?bDim=600x250&ap_cgName=Pampers_300x250&isPreviewRequest=1&cId=102&bUnitId=2000"></script>`,            `<script type="text/javascript" src="https://as.jivox.com/unit/unit_renderer.php?bDim=600x250&ap_cgName=Pampers_300x250&isPreviewRequest=1&cId=102&bUnitId=2000"></script>`,            `<script type="text/javascript" src="https://as.jivox.com/unit/unit_renderer.php?bDim=600x250&ap_cgName=Pampers_300x250&isPreviewRequest=1&cId=102&bUnitId=2000"></script>`      ]    },    {      "placementId":"p2",      "tags":[            `<script type="text/javascript" src="https://as.jivox.com/unit/unit_renderer.php?bDim=600x250&ap_cgName=Pampers_300x250&isPreviewRequest=1&cId=102&bUnitId=2000"></script>`,            `<script type="text/javascript" src="https://as.jivox.com/unit/unit_renderer.php?bDim=600x250&ap_cgName=Pampers_300x250&isPreviewRequest=1&cId=102&bUnitId=2000"></script>`,            `<script type="text/javascript" src="https://as.jivox.com/unit/unit_renderer.php?bDim=600x250&ap_cgName=Pampers_300x250&isPreviewRequest=1&cId=102&bUnitId=2000"></script>`,            `<script type="text/javascript" src="https://as.jivox.com/unit/unit_renderer.php?bDim=600x250&ap_cgName=Pampers_300x250&isPreviewRequest=1&cId=102&bUnitId=2000"></script>`      ]    }  ]}
Copy

Last updated on

Was this page helpful?