Media plan
The various methods for Media plan are listed below:
- List Media-Plans
- Get Import Media Plan Data
- Import Media Plan Data (Saving a Media Plan)
- Edit an Existing Media Plan
- Mail MediaPlan
- Download MediaPlan
- Update DSP API
List Media-Plans
Gets media plans for a given user 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?isBulkTag=trueSample Response
xxxxxxxxxx{ "mediaPlans": [ { "bulkTagGenStatus": "notstarted", //possible values ['finished','started','notstarted','failed'] "dcmCampaignId": 25058625, "executionId": -1, //Latest Bulk Tag Generation Id ['-1' implies no bulktag generation been done] "externalPlacementExists": false, "id": 1377, "mediaPlanId": 1377, "mediaPlanName": "Qwertykk-1_25058625" }, { "bulkTagGenStatus": "notstarted", "dcmCampaignId": 0, "executionId": -1, "externalPlacementExists": false, "id": 1954, "mediaPlanId": 1954, "mediaPlanName": "bulktag1" } ], "next": "", "previous": "", "totalcount": "2"}Pagination
To fetch first 10 media-plans:
xxxxxxxxxxGET http://demo.stub.api.jivox.com/v2/accounts/<accountId>/media-plans?limit=10&offset=0To fetch the next 10 media plans:
xxxxxxxxxxGET http://demo.stub.api.jivox.com/v2/accounts/<accountId>/media-plans?limit=10&offset=10Search
To search for a media-plan that has the string test in its name:
xxxxxxxxxxGET http://demo.stub.api.jivox.com/v2/accounts/<accountId>/media-plans?filters=mediaPlanName(like)testGet Import Media Plan Data
This is to parse the csv file which needs to be uploaded when creating or updating a 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/import-media-planSample Response
xxxxxxxxxx{ "data": [], "maxColumns": 31, "selections": {}, "tagFile": "/tmp/bulkTag63577e59-fd01-4071-be5f-8bd6d9325dee/upload/BulkTagMPSample - Sheet1.csv" // location of uploaded file in server}Import Media Plan Data (Saving a Media Plan)
Saves a new media plan for a given account.
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": "first-bulk-tag_5", "mediaPlanUrl": "/tmp/bulkTaga74b8ef9-9167-4434-a23b-6a07dd52ea28/upload/simple BulkTagMPSample - Sheet1.csv", // location of uploaded file in server [should be receieved during csv upload ] "type": "filePath", "mappingDetails": { "dspName": 0, //coloumn index of the csv file "siteName": 1, "placementName": 2, "dimension": 3, "expansionUnit": 4, "tagType": 5, "adChoices": 6, "privacy": 7, "gdprMacro": 8, "gdprConsentMacro": 9, "ccpa": 10, "noScriptTag": 11, "mraid": 12, "embeddable": 13 }, "ignoreFirstRow": true "campaignId": 12324}Sample Response
xxxxxxxxxx{ "mediaPlanId": 0, "msg": "string"}Edit an Existing Media Plan
Updates an existing media plan for an account.
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
xxxxxxxxxxPATCH http://demo.stub.api.jivox.com/v2/accounts/:accountId/media-plans/:mediaPlanIdRequest Body
xxxxxxxxxx{ "mediaPlanName": "first-bulk-tag_5", "mediaPlanUrl": "/tmp/bulkTaga74b8ef9-9167-4434-a23b-6a07dd52ea28/upload/simple BulkTagMPSample - Sheet1.csv", // location of uploaded file in server [should be receieved during csv upload ] "type": "filePath", "mappingDetails": { "dspName": 0, //coloumn index of the csv file "siteName": 1, "placementName": 2, "dimension": 3, "expansionUnit": 4, "tagType": 5, "adChoices": 6, "privacy": 7, "gdprMacro": 8, "gdprConsentMacro": 9, "ccpa": 10, "noScriptTag": 11, "mraid": 12, "embeddable": 13 }, "ignoreFirstRow": true "campaignId": 12324}Sample Response
xxxxxxxxxx{ "siteUpdatedCount": 0, "siteAppendedCount": 0, "placementUpdatedCount": 0, "placementAppendedCount": 0, "trackerAppendedCount": 0, "updatedCampaignId": true, "updatedMediaPlanName": true}Mail MediaPlan
Mail an existing media plan to all the given email address
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/mailQuery Parameters
mailIDs - Comma separated values of emailIDs eg: test1.jivox.com, test2.jivox.com, test3.jivox.com
campaignId(optional field) - It is optional. Use this when you require the tracker details in CSV.
Sample Response
xxxxxxxxxx{ "message": "Please check your mail, MediaPlan will be sent shortly"}Download MediaPlan
Downloads an existing media plan in csv format.
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/downloadQuery Parameters
campaignId(optional field)- It is optional. Use this when you require the tracker details in CSV.
Sample Response
Download CSV File
Update DSP API
Updates the DSP details.
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
xxxxxxxxxxPATCH http://demo.stub.api.jivox.com/v2/accounts/:accountId/media-plans/:mediaPlanId/dspRequest Body
xxxxxxxxxx{ "adChoices": false, "ccpa": true, "embeddable": false, "expansionUnit": "Non expanding", "gdprConsentMacro": "${abcdef}", "gdprMacro": true, "mraid": false, "noScriptTag": false, "privacy": true, "tagType": "JS tag", "adServer": "DCM"}Sample Response
xxxxxxxxxx{ "adServerId": "DCM", "message": "Updated DSP Successfully."}Was this page helpful?