Campaigns
The various methods for Feed Settings are listed below:
- Retail Campaign List
- Campaign Details
- Fetch Templates by Label (Prospecting, Retargeting, Full-Funnel)
- Save Campaign
- Update Campaign
- Get Clone Status
Retail Campaign List
This will list all the retail media campaigns for the account.
Parameters
| Name | Data Type | Requirement | Parameter Type | Description |
|---|---|---|---|---|
| accountId | string | Mandatory | path | ID of the advertiser account created on the platform. |
Sample Request
xxxxxxxxxxGET http://demo.stub.api.jivox.com/v2/accounts/:accountId/retail-campaignsSample Response
xxxxxxxxxx{ "campaigns": [ { "dspName": "Appnexus", "dspLogoURL": "https://dsp.logo.com", "mediaPlanId": 2062, "mediaPlanName": "RMAMediaPlan15", "retailCampaignIdx": 1, "retailCampaignName": "ABCD", "dspCampaignId": "Campaign 1", "status": "NEW" } ], "count": 1, "next": "", "previous": ""}Campaign Details
This will fetch the details for a specific 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/:retailCampaignIdxretailCampaignIdx is the campaign Id for retail campaigns and is present in the campaigns list API |
Sample Response
xxxxxxxxxx{ "retailCampaignName": "ABCD", "retailCampaignIdx": 1, "labelId": 102, "templateCampaignIdx": 120102}Fetch Templates by Label (Prospecting, Retargeting, Full-Funnel)
This will fetch campaigns by label/category.
Parameters
| Name | Data Type | Requirement | Parameter Type | Description |
|---|---|---|---|---|
| accountId | string | Mandatory | path | ID of the advertiser account created on the platform. |
Sample Request
xxxxxxxxxxGET http://demo.stub.api.jivox.com/v2/accounts/:accountId/rma/campaigns?ids=<labelId>Sample Response
xxxxxxxxxx{ "campaigns": [ { "campaignId": 123, "campaignName": "Campaign 1", "description": "lorem ipsum", "numOfCards" : 3, "previewTag": { "adUnitCombination": { "bDim": "300x600" }, "tag": `<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>` } }, { "campaignId": 234, "campaignName": "Campaign 2", "description": "lorem ipsum", "numOfCards" : 1, "previewTag": { "adUnitCombination": { "bDim": "300x600" }, "tag": `<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>` } } ]}Save Campaign
Create retail media campaign from the template - (to clarify against confluence doc "Save Campaign" versus google sheet Campaign -> CREATE -> POST).
Parameters
| Name | Data Type | Requirement | Parameter Type | Description |
|---|---|---|---|---|
| accountId | string | Mandatory | path | ID of the advertiser account created on the platform. |
Sample Request
xxxxxxxxxxPOST http://demo.stub.api.jivox.com/v2/accounts/:accountId/retail-campaignThe Parameter:
|
Request Body
xxxxxxxxxx{ "templateCampaignIdx": 1234, "retailCampaignName": "Campaign1", "email": "abc@jivox.com", "labelId": 789}Sample Response
xxxxxxxxxx{ "messageId": "cloneMessageId", "retailCampaignIdx": 1234}Update Campaign
<info needed -pending>.
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
xxxxxxxxxxPUT http://demo.stub.api.jivox.com/v2/accounts/:accountId/retail-campaign/:retailCampaignIdxThe Parameter:
|
Request Body
xxxxxxxxxx{ "templateCampaignIdx": 1234, "retailCampaignName": "Campaign1", "email": "abc@jivox.com", "labelId": 789}Sample Response
xxxxxxxxxx{ "msg": "cloneMessage"}Get Clone Status
This will get the retail media campaign creation status.
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/campaigns/:retailCampaignIdx/clone/statusThe Parameter:
|
Sample Response
When the clone request fails for any reason:
xxxxxxxxxx{ "clonePercentCompleted" : -1, "cloneStatus" : "Failed"}When the clone request is in processing case:
xxxxxxxxxx{ "clonePercentCompleted" : 90, "cloneStatus" : "Queued"}When the clone request is completed successfully:
xxxxxxxxxx{ "clonePercentCompleted" : 100, "cloneStatus" : "Completed"}