Export - Tag Generation

AI Tools

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

The various methods for Tag generation are listed below:

  1. Export assets (retail campaign)

  2. Get export asset status (retail campaign)

  3. Download tags (retail campaign)

  4. Get Trackers Type

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

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

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

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

Response

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.

Request Body

{ "queueId": "q-abc123", "status": "INITIATED", "message": "Export initiated successfully" }

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

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

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

[ { "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" } ] } ]

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

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

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.

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

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

The Parameter:

accountId - is the Current account Id

retailCampaignIdx- is the Retail Campaign id

Info

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

Sample Response

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


Next to read:
Carousel API
null
On This Page
Export - Tag GenerationExport assets (retail campaign)Get export asset status (retail campaign)Download tags (retail campaign)Get Trackers Type