Tag Generation
The various methods for Tag generation are listed below:
Activate Campaign
This will generate tags for 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
xxxxxxxxxxPOST http://demo.stub.api.jivox.com/v2/accounts/:accountId/retail-campaigns/:retailCampaignIdx/activateThe Parameter:
|
The trackerType array will be empty, if MOAT is not selected for that campaign. |
Request Body
xxxxxxxxxx{ "trackerTypes": ["MOAT"] }Sample Response
xxxxxxxxxx{ "message" : "Tags are getting generated and email will be sent shortly.", "executionId" : <executionId> }Status
This will get the status of the tag generation request for 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
xxxxxxxxxxGET http://demo.stub.api.jivox.com/v2/accounts/:accountId/retail-campaigns/:retailCampaignIdx/statusThe executionid is fetched from the activate response |
Sample Response
{ "percentage" : "0"}{ "percentage" : "10"}{ "percentage" : "100"}Download
This will download the tags for 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
xxxxxxxxxxGET http://demo.stub.api.jivox.com/v2/accounts/:accountId/retail-campaigns/:retailCampaignIdx/tags/downloadFile will be downloaded automatically. |
Get Trackers Type
This will get trackers type associated with 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
xxxxxxxxxxGET http://demo.stub.api.jivox.com/v2/accounts/:accountId/retail-campaigns/:retailCampaignIdx/trackersThe Parameter:
|
The Get Tracker API will return all the trackers present and the trackers selected for this campaign. |
Sample Response
xxxxxxxxxx{ "trackerTypes": ["MOAT"] "trackersSelected": ["MOAT"] // or empty}