Export - Tag Generation

Export APIs are available once a retail campaign has been successfully activated (status: ACTIVE).

The various methods for Tag generation are listed below:

Export assets (retail campaign)

Triggers an asynchronous export of generated creative assets for a retail campaign. Requires Campaigns_Create permission.

Path Parameters

Name	Data Type	Requirement	Parameter Type	Description
accountId	string	Mandatory	path	ID of the account.
retailCampaignIdx	integer	Mandatory	path	Index of the retail campaign.

Sample Request

HTTP
    
 
POST http://demo.stub.api.jivox.com/v2/accounts/:accountId/retail-campaigns/:retailCampaignIdx/exportAssets
Copy

Parameters

Field	Data Type	Requirement	Description
assetExportType	enum (string)	Mandatory	Format of the exported assets. Values: `png`, `jpg`, `gif`, `tiff`, `mp4`.
resolution	enum (string)	Mandatory	Export resolution multiplier. Values: `1` (1×), `2` (2×). Note: 2× is only supported for `png`, `jpg`, `gif`.

Request Body

JSON
    
 
{  "assetExportType": "png",  "resolution": "1"}
Copy

Response

Returns a MediaPlanV2 JSON object serialized via the explicit mediaPlanV2Format writer.

Field	Data Type	Description
queueId	string/null	Queue ID of the export job (if queued asynchronously), otherwise null.
status	enum (string)	Current export status. Values: INITIATED, PROCESSING, FAILED, COMPLETED, NOT_INITIATED_,_ FAILED TO_INITIATE.
message	string	Human-readable status message.

Get export asset status (retail campaign)

Returns the current export status for one or more resolution/format combinations for a retail campaign. Requires Campaigns_Create permission.

Path Parameters

Name	Data Type	Requirement	Parameter Type	Description
accountId	string	Mandatory	path	ID of the account.
retailCampaignIdx	integer	Mandatory	path	Index of the retail campaign.

Query Parameters

Name	Data Type	Requirement	Parameter Type	Description
isPreviewExport	boolean	Optional	false	Whether to fetch status for preview exports instead of production exports
assetExportType	enum (string)	Optional	--	Filter by export format: png, jpg, gif, tiff, mp4
resolution	enum (string)	Optional	--	Filter by resolution: `1` (1×), `2` (2×)

Sample Request

HTTP
    
GET http://demo.stub.api.jivox.com/v2/accounts/:accountId/retail-campaigns/:retailCampaignIdx/exportAssetStatus?assetExportType=png&resolution=1
Copy

Response

Returns a list of RetailExportMultiResolutionResponse objects, one per export format found.

Field	Data Type	Description
[].assetExportType	string	The export format (e.g. png)
[].resolutionsResponse	array	List of per-resolution export status entries.
[].resolutionsResponse[].status	enum (string)	Export status. Values: INITIATED, PROCESSING, FAILED, COMPLETED, FAILED_TO_INITIATE, ARCHIVED, AVAILABLE, NOT_INITIATED.
[].resolutionsResponse[].url	string	Download URL for the exported ZIP (populated when status is COMPLETED or AVAILABLE)
[].resolutionsResponse[].resolution	integer	Resolution multiplier (1 or 2)
[].resolutionsResponse[].statusMessage	string	Human-readable status message

Request Body

JSON
    
 
[  {    "assetExportType": "png",    "resolutionsResponse": [      {        "status": "COMPLETED",        "url": "https://s3.amazonaws.com/bucket/exports/campaign_5373_png_1x.zip",        "resolution": 1,        "statusMessage": "Export completed successfully"      },      {        "status": "NOT_INITIATED",        "url": "",        "resolution": 2,        "statusMessage": "Export not yet started"      }    ]  }]
Copy

Download tags (retail campaign)

Downloads the ad tags for all ad units in a retail campaign as a CSV file. The file is named {campaignName}_tags.csv. Requires MediaPlan_Tags_Download permission.

Path Parameters

Name	Data Type	Requirement	Parameter Type	Description
accountId	string	Mandatory	path	ID of the account.
retailCampaignIdx	integer	Mandatory	path	Index of the retail campaign.

Sample Request

HTTP
    
 
GET http://demo.stub.api.jivox.com/v2/accounts/:accountId/retail-campaigns/:retailCampaignIdx/download-tags
Copy

Response

Returns a CSV file download with the Content-Disposition header set to attachment; filename={campaignName}_tags.csv and content type application/x-download.

The CSV contains the ad tags for all ad units in the retail campaign.

Activate Campaign

This will activate the campaign for tag generation.

Parameters

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

Sample Request

HTTP
    
​x
 
POST http://demo.stub.api.jivox.com/v2/accounts/:accountId/retail-campaigns/:retailCampaignIdx/activate​POST http://demo.stub.api.jivox.com/SESSION_BASE/v2/accounts/:accountId/retail-campaigns/:retailCampaignIdx/activate
Copy

The Parameter:

accountId - is the Current account Id

retailCampaignIdx- is the Retail Campaign id

The trackerType array will be empty, if MOAT is not selected for that campaign.

Request Body

JSON
    
 
{  "trackerTypes": ["MOAT"] }
Copy

Sample Response

JSON
    
 
{  "message" : "Tags are getting generated and email will be sent shortly.",  "executionId" : <executionId> }
Copy

Get Trackers Type

This will get the tracker type associated with the retail media campaign.

Parameters

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

Sample Request

HTTP
    
 
GET http://demo.stub.api.jivox.com/v2/accounts/:accountId/retail-campaigns/:retailCampaignIdx/trackers
Copy

The Parameter:

accountId - is the Current account Id

retailCampaignIdx- is the Retail Campaign id

The Get Tracker API will return all the trackers present and the trackers selected for this campaign.

Sample Response

JSON
    
 
{  "trackerTypes": ["MOAT"]   "trackersSelected": ["MOAT"] // or empty}
Copy

Last updated on

Was this page helpful?