Media Channels
The various methods for Media Channels are listed below:
For Dropdown
This will list all ad-servers/DSPs associated with the organization.
Parameters
| Name | Data Type | Requirement | Parameter Type | Description |
|---|---|---|---|---|
| orgId | string | Mandatory | path | ID of the organization created on the platform. |
Sample Request
xxxxxxxxxxGET http://demo.stub.api.jivox.com/v2/org/:orgId/ad-serversSample Response
xxxxxxxxxx{ "adServers": [ { "id": "Amazon", "name": "Amazon", "logoURL": "https://dsp.logo.com", "type": "On-Site" }, { "id": "Appnexus", "name": "Appnexus", "logoURL": "https://dsp.logo.com", "type": "On-Site" }, { "id": "DCM", "name": "DCM", "logoURL": "https://dsp.logo.com", "type": "Off-Site" }, { "id": "LiveRail", "name": "LiveRail", "logoURL": "https://dsp.logo.com", "type": "On-Site" }, { "id": "random-dsp", "name": "random-dsp", "logoURL": "https://dsp.logo.com", "type": "On-Site" }, { "id": "TradeDesk", "name": "TradeDesk", "logoURL": "https://dsp.logo.com", "type": "Off-Site" }, { "id": "WallMart", "name": "Walmart", "logoURL": "https://dsp.logo.com", "type": "On-Site" } ], "next": "", "previous": "", "totalcount": ""}For Save and Update
This will add media channel to the organisation (to clarify against confluence doc "Save Campaign" versus google sheet Media Channel -> CREATE -> POST)
Parameters
| Name | Data Type | Requirement | Parameter Type | Description |
|---|---|---|---|---|
| orgId | string | Mandatory | path | ID of the organization created on the platform. |
| adServerId | string | Mandatory | path | ID of the Ad Server for which the details are being fetched. |
Sample Request
xxxxxxxxxxPOST http://demo.stub.api.jivox.com/v2/org/<orgId>/retail-media-channel/<adServerId>The Parameter:
|
Request Body
The request body for - in case of PromoteIQ
xxxxxxxxxx{ "apiEndpoint": "www.test.com" , "apiKey" : "secretKey"}The request body - for other Request body will be empty.
Sample Response
xxxxxxxxxx{ "msg" : "Updated Successfully "}For Listing
This will list all media channels for the organisation
Parameters
| Name | Data Type | Requirement | Parameter Type | Description |
|---|---|---|---|---|
| orgId | string | Mandatory | path | ID of the organization created on the platform. |
Sample Request
xxxxxxxxxxGET http://demo.stub.api.jivox.com/v2/org/<orgId>/retail-media-channel/listSample Response
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" }, ]}To get details of an adServer
This will fetch all the details of an adServer (to confirm....)
Parameters
| Name | Data Type | Requirement | Parameter Type | Description |
|---|---|---|---|---|
| orgId | string | Mandatory | path | ID of the organization created on the platform. |
| adServerId | string | Mandatory | path | ID of the Ad Server for which the details are being fetched. |
Sample Request
xxxxxxxxxxGET http://demo.stub.api.jivox.com/v2/org/<orgId>/retail-media-channel/<adServerId>The Parameter:
|
Sample Response
The response - incase of promote iq / on-site
xxxxxxxxxx{ "apiEndpoint" : "www.test.com", "apiKey" : "secretKey"}The response - incase of others the response will be empty.
For Delete
This will delete the media channel for the organisation
Parameters
| Name | Data Type | Requirement | Parameter Type | Description |
|---|---|---|---|---|
| orgId | string | Mandatory | path | ID of the organization created on the platform. |
| adServerId | string | Mandatory | path | ID of the Ad Server for which the details are being fetched. |
Sample Request
xxxxxxxxxxDELETE http://demo.stub.api.jivox.com/v2/org/<orgId>/retail-media-channel/<adServerId>The Parameter:
|
Sample Response
xxxxxxxxxx{ "msg" : "Deleted Successfully "}