Media Plans
The various methods for Media Plans are listed below:
- Media Plan Listing
- Media Plan Details
- Media Plan Create
- Media Plan Update
- Media Plan Delete
- DSP Listing
- Ad Dimensions Listing
Media Plan Listing
This will list all the retail media plans 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>/media-plans?isRetail=trueSample Response
xxxxxxxxxx{ "mediaPlans": [ { "bulkTagGenStatus": "notstarted", "dcmCampaignId": 0, "executionId": -1, "externalPlacementExists": false, "hasTags": false, "id": 1877, "mediaPlanId": 1877, "mediaPlanName": "test media plan", "dspCampaignId": 123, "dspName": "DSP 1", "retailCampaignStatus": "NEW", "retailCampaignName": "New Campaign" } ], "next": "", "previous": "", "totalcount": "1"}Media Plan Details
This will fetch details for a specific retail media plan.
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. |
Sample Request
xxxxxxxxxxGET http://demo.stub.api.jivox.com/v2/accounts/<accountId>/media-plans/<mediaPlanId>Sample Response
xxxxxxxxxx{ "mediaPlanId": 1877, "mediaPlanName": "test media plan", "dspCampaignId": 123, "dspName": "DSP 1", "retailCampaignStatus": "NEW", "sites": [ { "id": 9768, "placements": [ { "isEditable": false, "placementId": "1992c04", "placementName": "p1", "placementDimension": "300x600", "externalPlacementId": "asd123fg" }, { "isEditable": false, "placementId": "d295de8", "placementName": "p2", "placementDimension": "320x50", "externalPlacementId": "asd1f3fg" }, { "isEditable": false, "placementId": "bb9fa73", "placementName": "p3", "placementDimension": "160x600", "externalPlacementId": "asd123fh" } ], "siteId": 9768, "siteName": "DBM" } ]}Media Plan Create
This will create a retail media plan.
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>/media-plansRequest Body
xxxxxxxxxx{ "mediaPlanName": "name", "type": "inline", "dspCampaignId": "124dd", "dspName": "Appnexus", "mediaPlanDetails": [ { "placementName": "p1", "dimension": "320x50", "externalPlacementId": "asd123fg" }, { "placementName": "p2", "dimension": "320x600", "externalPlacementId": "zxc987vb" } ]}Media Plan Update
This will update the retail media plan.
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. |
Sample Request
xxxxxxxxxxPUT http://demo.stub.api.jivox.com/v2/accounts/<accountId>/media-plans/<mediaPlanId>Request Body
xxxxxxxxxx{ "mediaPlanName": "name", "type": "inline", "dspCampaignId": 1234, "dspName": "DSP 1", "mediaPlanDetails": [ { "placementName": "p1", "dimension": "320x50", "externalPlacementId": "asd123fg" }, { "placementName": "p2", "dimension": "320x600", "externalPlacementId": "asd123fh" } ], "deletedPlacements": [ "p3", "p4" ]}Media Plan Delete
This will delete a specific retail media plan.
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. |
Sample Request
xxxxxxxxxxDELETE http://demo.stub.api.jivox.com/v2/accounts/<accountId>/media-plans/<mediaPlanId>Sample Response
xxxxxxxxxx{ "mediaPlanId": 1234, "msg": "Media-plan deleted successfully"}DSP Listing
This will list the DSPs whitelisted for a retailer organization.
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-media-channel/listRequest Body
xxxxxxxxxx{ "mediaChannels": [ { "adServerId": "Amazon", "adServerName": "Amazon", "type": "On-site", "status": "Enabled" }, { "adServerId": "Amazon", "adServerName": "Amazon", "type": "Off-site", "status": "Enabled" },, { "adServerId": "Amazon", "adServerName": "Amazon", "type": "On-site", "status": "Enabled" }, ]}Ad Dimensions Listing
This will list the whitelisted ad dimensions for the account (derived from the associated org).
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>/ad-dimensionsRequest Body
xxxxxxxxxx{ "dimensions": [ "300x600", "300x250" ]}Was this page helpful?