POST Perform Proposal Operation
POST /performProposalOperation
Creates the Proposal Operation resource.
Request body
Media type: application/json. Schema: Perform_Proposal_Operation.
Specifies the Proposal Operation to create.
Example
{
"requestId": "c9636ffa-bd35-f3ef-38f8-4c649a6fa33f",
"additionalFields": {
"additionField1": "additionField_1_Value"
},
"requestMode": "Minimal",
"requestI18NInfo": {
"localeName": "United States",
"localeCode": "en-us",
"timezone": "Apia Standard Time (Pacific/Apia)",
"currencyName": "United States Dollar",
"currencyCode": "USD"
},
"proposals": [
{
"name": "Proposal_Name",
"startDate": "2023-07-01",
"endDate": "2023-10-25",
"proposalHeader": {
"isProgrammatic": false,
"revenueSpecs": {
"additionalFields": {
"additionField1": "additionField_1_Value"
},
"revenueTypecode": "PRORATE"
},
"additionalFields": {
"additionField1": "additionField_1_Value"
},
"invoiceSpecs": {
"invoiceTypeCode": "XLS",
"additionalFields": {
"additionField1": "additionField_1_Value"
},
"invoiceType": "PDF",
"EDIProductCode": "Linear",
"EDIClientCode": "Linear",
"EDIOrder": "Linear"
},
"tags": [
""
],
"notes": "",
"purchaseOrderNumber": "",
"publisherOrderName": "",
"totalBudget": {
"value": 100,
"currencyName": "United States Dollar",
"currencyCode": "USD"
},
"adServerHeadersbyAdServerCode": {
"default": {
"advertiserId": "11323"
},
"XG": {
"advertiserId": "123456"
}
},
"orderStatus": "",
"billingSpecs": {
"billingCycleTypeCode": "QRTR",
"valueCostPerUnit": {
"value": 100,
"currencyName": "United States Dollar",
"currencyCode": "USD"
},
"additionalFields": {
"additionField1": "additionField_1_Value"
},
"billingMode": "Fractional",
"billingCycleType": "Broadcast"
},
"orderType": "",
"adServerAction": "Create",
"deliveryDetails": {
"additionalFields": {
"additionField1": "additionField_1_Value"
},
"totalClicksDelivered": 200,
"totalImpressionsDelivered": 20000,
"totalViewableImpressionsDelivered": 200
}
},
"lineItems": [
{
"proposalId": "435345345",
"lineItemDetail": {
"inventoryTypeCode": "DEFAULT",
"endDate": "2023-06-26",
"linearAttributes": {
"additionField1": "additionField_1_Value"
},
"lineItemName": "10 sec skippable ad",
"targeting": {
"dayPartTargeting": [
{
"segmentValues": [
{
"value": 0.5,
"label": "Hourly"
}
],
"segmentCode": "SlotType",
"segmentName": "SlotType"
},
{
"segmentValues": [
{
"value": "Monday 00:00",
"label": "Monday 00:00"
},
{
"value": "Wednesday 00:00",
"label": "Wednesday 00:00"
},
{
"value": "Wednesday 00:30",
"label": "Wednesday 00:30"
}
],
"segmentCode": "DayAndTime",
"segmentName": "DayAndTime"
}
],
"geoTargeting": [
{
"segmentValues": [
{
"value": "21132",
"label": "Alaska"
}
],
"segmentCode": "Region",
"segmentName": "Region"
}
],
"others": [
{
"categoryCode": "xgLineAudience",
"categoryName": "xgLineAudience",
"targetingSegmentDefinition": [
{
"segmentValues": [
{
"label": "RatingGoal ",
"value": "1"
},
{
"label": "SegmentCode ",
"value": "test segment"
}
],
"segmentCode": "2222",
"segmentName": "xgLineAudience"
}
]
},
{
"categoryCode": "Audience Segment",
"categoryName": "Audience Segment",
"targetingSegmentDefinition": [
{
"segmentValues": [
{
"label": "gender",
"value": "female"
}
],
"segmentCode": "Female",
"segmentName": "Gender Based"
}
]
}
]
},
"revenueSpecs": {
"additionalFields": {
"additionField1": "additionField_1_Value"
},
"revenueTypecode": "PRORATE"
},
"publisherOrderLineItemName": "",
"additionalFields": {
"additionField1": "additionField_1_Value"
},
"digitalAttributes": {
"additionField1": "additionField_1_Value"
},
"id": "283718",
"mediaChannelCode": "SONY",
"adSpaceSpecifications": [
{
"adServerAdUnitId": "22214043670",
"adServerDaypart": "00:00-23:59",
"creatives": [
{
"height": "970",
"width": "70",
"adServerCreativeId": "283718",
"adServerCreativeRunTime": "400",
"adServerCreativeType": "Bookend",
"adCreativeUOM": "Pixels",
"companions": [
{
"key": "temp",
"value": {
"adCreativeUOM": "Pixels",
"width": 90,
"height": 120
}
}
],
"attributes": {
"additionField1": "additionField_1_Value"
},
"additionalFields": {
"additionField1": "additionField_1_Value"
}
}
],
"additionalFields": {
"additionField1": "additionField_1_Value"
}
}
],
"frequencyCaps": [
{
"maxImpressions": 1000,
"numTimeUnits": 5,
"timeUnit": "Hour",
"additionalFields": {
"additionField1": "additionField_1_Value"
}
}
],
"startDate": "2023-06-26",
"lineItemQuantity": {
"additionalFields": {
"additionField1": "additionField_1_Value"
},
"totalQuantity": 12,
"totalQuantityPeriodType": "weekly",
"totalQuantityType": "Impressions",
"quantityBreakdownByDate": [
{
"additionField1": "additionField_1_Value"
}
]
},
"goals": [
{
"goalType": "Daily",
"goalTypeCode": "Weekly",
"goalUnitType": "Click",
"goalUnitTypeCode": "Action",
"goalUnits": 2000,
"primary": false,
"additionalFields": {
"additionField1": "additionField_1_Value"
}
}
],
"pricingSpecs": {
"costType": "CPM",
"discountType": "Percentage",
"valueCostPerUnit": {
"value": 100,
"currencyName": "United States Dollar",
"currencyCode": "USD"
},
"additionalFields": {
"additionField1": "additionField_1_Value"
},
"discount": 15,
"costPerUnit": {
"value": 100,
"currencyName": "United States Dollar",
"currencyCode": "USD"
},
"totalCost": {
"value": 100,
"currencyName": "United States Dollar",
"currencyCode": "USD"
},
"mediaChannelRate": [
{
"channelCode": "SONY",
"regionCode": "NYC",
"lineRate": {
"value": 100,
"currencyName": "United States Dollar",
"currencyCode": "USD"
}
}
]
},
"adServerCode": "GAM",
"adServerInstanceId": "22773096281",
"lineItemType": "STANDARD",
"billingSpecs": {
"additionalFields": {
"additionField1": "additionField_1_Value"
},
"billingModeTypeCode": "Usage",
"billingModeType": "Threshold"
},
"adServerAction": "Create"
},
"lineItemPriority": 2,
"deliveryRateType": "EVENLY",
"videoAttributes": {
"maxDuration": 100,
"skippable": "Enabled",
"displayCompanions": "AtLeastOne"
},
"audioAttributes": {
"maxDuration": 100,
"skippable": "Enabled",
"displayCompanions": "AtLeastOne"
},
"displayAttributes": {
"additionField1": "additionField_1_Value"
},
"attributes": {
"additionField1": "additionField_1_Value"
},
"additionalFields": {
"additionField1": "additionField_1_Value"
}
}
],
"attributes": {
"additionField1": "additionField_1_Value"
},
"additionalFields": {
"additionField1": "additionField_1_Value"
}
}
],
"requestedBy": "Bianca White"
}Responses
- 200
Created the Proposal Operation resource.
Media type:
application/json. Schema:Perform_Proposal_Operation_Response.Example
{ "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "code": 200, "status": "success" }, "minimalResults" : ["101"], "detailResults" : [], "stepwiseResults" : [{ "systemApiEndPoint" : "/proposal", "result" : { "id" : "56736573", "name" : "media plan 101", "status" : "success", "operatingOn" : "Proposal" }, "adServer" : { "adServerInstanceId" : "XG", "adServerCode" : "xglinear", "adServerApplicationName" : "NoName", "mediaType" : "xglinear"}, "status" : "success" }], "additionalFields": { "contractId": "additionField1" } } - 400
There was an issue with your request.
Media type:
application/json. Schema:ErrorMessage.Example
{ "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "status": "error", "code": 400, "adServerLogId": "54uy-213i-9489-3121", "shortMessage": "BAD_REQUEST", "verboseMessage": "Errors: /items/0 required key [startDate] not found." }, "minimalResults": [], "detailResults": [], "additionalFields": [] } - 401
Authorization failed.
Media type:
application/json. Schema:ErrorMessage.Example
{ "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "status": "error", "code": 401, "adServerLogId": "54uy-213i-9489-3121", "shortMessage": "Unauthorised", "verboseMessage": "Credentials are incorrect." }, "minimalResults": [], "detailResults": [], "additionalFields": [] } - 403
Request forbidden.
Media type:
application/json. Schema:ErrorMessage.Example
{ "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "status": "error", "code": 403, "adServerLogId": "54uy-213i-9489-3121", "shortMessage": "Forbidden", "verboseMessage": "Request forbidden." }, "minimalResults": [], "detailResults": [], "additionalFields": [] } - 404
Resource not found.
Media type:
application/json. Schema:ErrorMessage.Example
{ "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "status": "error", "code": 404, "adServerLogId": "54uy-213i-9489-3121", "shortMessage": "NotFound", "verboseMessage": "Resource not found." }, "minimalResults": [], "detailResults": [], "additionalFields": [] } - 405
Method not allowed.
Media type:
application/json. Schema:ErrorMessage.Example
{ "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "status": "error", "code": 405, "adServerLogId": "54uy-213i-9489-3121", "shortMessage": "Method Not Allowed", "verboseMessage": "Method not allowed for this resource." }, "minimalResults": [], "detailResults": [], "additionalFields": [] } - 415
Unsupported media type.
Media type:
application/json. Schema:ErrorMessage.Example
{ "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "status": "error", "code": 415, "adServerLogId": "54uy-213i-9489-3121", "shortMessage": "Unsupported Media Type", "verboseMessage": "Requested media type not supported." }, "minimalResults": [], "detailResults": [], "additionalFields": [] } - 422
Unprocessable entity.
Media type:
application/json. Schema:ErrorMessage.Example: same as POST /performProposalOperation 415 response.
- 500
Unable to complete the request as the server encountered an error.
Media type:
application/json. Schema:ErrorMessage.Example: same as POST /performProposalOperation 405 response.