--- schema_version: "1" id: 7e21c9d8d88a2b6eb5429a7da4e97089bba8a283937f565e14316691801b462b title: Media AdTech Integration API collection: developer version: current locale: en-us portal_url: https://docs.salesforce.com/developer/current/en-us/industries-integrations/media_cloud/references/generated-api-specs/adtech_api.md canonical_url: https://developer.salesforce.com/docs/industries/media-cloud/references/adtech_api source_site: developer.salesforce.com content_type: documentation content_hash: ce409a6f87e626614685630e5bc3dd7dd684930467fd1b26ce69670f33811b66 products: - Media Cloud AdTech Integration API - Industries Integrations --- Media AdTech Integration API # Media AdTech Integration API Use the Media Integrations APIs to integrate the Media Cloud apps with external systems. **Version:** v1 Protocols: HTTPS. ## Operations ### POST Create orders `POST /orders` Creates the Orders entity. #### Request body Media type: `application/json`. Schema: `Create_Order`. Specifies the Orders to be created. #### Responses * **200** Created the Orders entity. Media type: `application/json`. Schema: `Create_Order_Response`. _Example_ ``` { "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "code": 200, "status": "success", "additionalStatus" : { "atomicTransaction": "Existing", "idValues": ["1135728"] } }, "minimalResults" : [ "1135728"], "detailResults": [ { "id" : "11013482", "advertiserId": "11323", "orderHeader": { "agencies": [ { "id": "AGENCY100" } ], "salespeople": [ { "id": "98878", "email": "rd@gmail.com", "name": "John", "role": "Customer Success Manager", "type": "Salesperson", "typeCode": "", "isComapny": false, "primary": false, "officeCode": "US_SF_01" } ], "publisher": { "id": "AGENCY100" }, "revenueSpecs": { "revenueTypecode": "PRORATE" }, "billingSpecs": { "billingCycleType": "Broadcast" }, "purchaseOrderNumber": "01/2023 DEN" } } ], "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_ ``` { "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "status": "error", "code": 422, "adServerLogId": "54uy-213i-9489-3121", "shortMessage": "Unprocessable Content", "verboseMessage": "Requested content can't be processed." }, "minimalResults": [], "detailResults": [], "additionalFields": [] } ``` * **500** Unable to complete the request as the server encountered an error. Media type: `application/json`. Schema: `ErrorMessage`. _Example_ ``` { "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "status": "error", "code": 500, "adServerLogId": "54uy-213i-9489-3121", "shortMessage": "Internal Server Error", "verboseMessage": "The server encountered an unexpected condition that prevented it from fulfilling the request." }, "minimalResults": [], "detailResults": [], "additionalFields": [] } ``` ### PUT Update orders `PUT /orders` Updates the Orders entity. #### Request body Media type: `application/json`. Schema: `Update_Order`. Specifies the Orders to be updated. #### Responses * **200** The Orders entity was updated. Media type: `application/json`. Schema: `Update_Order_Response`. _Example_ ``` { "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "code": 200, "status": "success" }, "minimalResults" : [ "1135728"], "detailResults": [ { "id" : "11013482", "advertiserId": "11323", "orderHeader": { "agencies": [ { "id": "AGENCY100" } ], "salespeople": [ { "id": "98878", "email": "rd@gmail.com", "name": "John", "role": "Customer Success Manager", "type": "Salesperson", "typeCode": "", "isComapny": false, "primary": false, "officeCode": "US_SF_01" } ], "publisher": { "id": "AGENCY100" }, "revenueSpecs": { "revenueTypecode": "PRORATE" }, "billingSpecs": { "billingCycleType": "Broadcast" }, "purchaseOrderNumber": "01/2023 DEN" } } ], "additionalFields": { "contractId": "additionField1" } } ``` * **400** There was an issue with your request. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 400 response._ * **401** Authorization failed. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 401 response._ * **403** Request forbidden. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 403 response._ * **404** Resource not found. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 404 response._ * **405** Method not allowed. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 405 response._ * **415** Unsupported media type. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 415 response._ * **422** Unprocessable entity. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 422 response._ * **500** Unable to complete the request as the server encountered an error. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 500 response._ ### POST Create line items `POST /orders/lineItems` Creates the LineItems entity. #### Request body Media type: `application/json`. Schema: `Create_LineItems`. Specifies the LineItems to be created. #### Responses * **200** Created the LineItems entity. Media type: `application/json`. Schema: `Create_LineItems_Response`. _Example_ ``` { "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "code": 200, "status": "success", "additionalStatus" : { "atomicTransaction": "Existing", "idValues": ["283718"] } }, "minimalResults" : [ {"10 sec skippable ad" : "234333"} , {"20 sec skippable ad" : "234333"}], "detailResults": [ { "id": "283718", "startDate": "2023-06-26", "endDate": "2023-06-26", "mediaChannelCode": "SONY", "adSpaceSpecifications": { "adServerAdUnitId" : "06:00-18:00", "creatives": [ { "AdServerCreativeId": "283718", "AdServerCreativeRunTime": "400", "AdServerCreativeType": "Bookend" } ] }, "targeting": "DENA", "RevenueSpecs" : { "revenueTypecode" : "NATREP" }, "pricingSpecs": { "mediaChannelRate": [{ "channelCode": "SONY", "regionCode": "NYC", "lineRate": { "value": 100, "currencyCode": "USD", "currencyName": "United States Dollar" } }], "totalCost": 100 }, "billingSpecs": { "billingModeType": "Threshold" }, "lineItemQuantity": { "totalQuantity": 12 }, "inventoryTypeCode": "DEFAULT" } ], "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } ``` * **400** There was an issue with your request. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 400 response._ * **401** Authorization failed. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 401 response._ * **403** Request forbidden. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 403 response._ * **404** Resource not found. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 404 response._ * **405** Method not allowed. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 405 response._ * **415** Unsupported media type. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 415 response._ * **422** Unprocessable entity. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 422 response._ * **500** Unable to complete the request as the server encountered an error. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 500 response._ ### PUT Update line items `PUT /orders/lineItems` Updates the LineItems entity. #### Request body Media type: `application/json`. Schema: `Update_LineItems`. Specifies the LineItems to be updated. #### Responses * **200** The LineItems entity was updated. Media type: `application/json`. Schema: `Update_LineItems_Response`. _Example_ ``` { "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "code": 200, "status": "success" }, "minimalResults" : [ "283718"], "detailResults": [ { "id": "283718", "startDate": "2023-06-26", "endDate": "2023-06-26", "mediaChannelCode": "SONY", "adSpaceSpecifications": { "adServerAdUnitId" : "06:00-18:00", "creatives": [ { "AdServerCreativeId": "283718", "AdServerCreativeRunTime": "400", "AdServerCreativeType": "Bookend" } ] }, "targeting": "DENA", "RevenueSpecs" : { "revenueTypecode" : "NATREP" }, "pricingSpecs": { "mediaChannelRate": [{ "channelCode": "SONY", "regionCode": "NYC", "lineRate": { "value": 100, "currencyCode": "USD", "currencyName": "United States Dollar" } }], "totalCost": 100 }, "billingSpecs": { "billingModeType": "Threshold" }, "lineItemQuantity": { "totalQuantity": 12 }, "inventoryTypeCode": "DEFAULT" } ], "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } ``` * **400** There was an issue with your request. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 400 response._ * **401** Authorization failed. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 401 response._ * **403** Request forbidden. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 403 response._ * **404** Resource not found. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 404 response._ * **405** Method not allowed. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 405 response._ * **415** Unsupported media type. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 415 response._ * **422** Unprocessable entity. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 422 response._ * **500** Unable to complete the request as the server encountered an error. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 500 response._ ### POST Perform order action `POST /orders/action` Creates the OrderAction entity. #### Request body Media type: `application/json`. Schema: `Update_OrderAction`. Specifies the OrderAction to be created. #### Responses * **200** The OrderAction entity was created. Media type: `application/json`. Schema: `Update_OrderAction_Response`. _Example_ ``` { "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "status": "success", "code": 200 } } ``` * **400** There was an issue with your request. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 400 response._ * **401** Authorization failed. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 401 response._ * **403** Request forbidden. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 403 response._ * **404** Resource not found. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 404 response._ * **405** Method not allowed. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 405 response._ * **415** Unsupported media type. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 415 response._ * **422** Unprocessable entity. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 422 response._ * **500** Unable to complete the request as the server encountered an error. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 500 response._ ### POST Get line item status `POST /orders/lineItem/statusQuery` Creates the LineItemStatus entity. #### Request body Media type: `application/json`. Schema: `Get_lineItemStatus`. Specifies the LineItemStatus to be created. #### Responses * **200** The LineItemStatus entity was created. Media type: `application/json`. Schema: `Get_lineItemStatus_Response`. _Example_ ``` { "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "additionalFields": {}, "result": { "status": "success", "code": 200 }, "minimalResults": [ { "lineitemid": 306522193, "status": "Proposed" } ] } ``` * **400** There was an issue with your request. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 400 response._ * **401** Authorization failed. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 401 response._ * **403** Request forbidden. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 403 response._ * **404** Resource not found. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 404 response._ * **405** Method not allowed. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 405 response._ * **415** Unsupported media type. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 415 response._ * **422** Unprocessable entity. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 422 response._ * **500** Unable to complete the request as the server encountered an error. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 500 response._ ### POST Get available details `POST /forecast/availability` Creates the Forecasts entity. #### Request body Media type: `application/json`. Schema: `object | object`. Specifies the Forecasts to be created. One of: `object`, `object`. * _object_ Specifies the Forecasts to be created. * `adServerInstanceId` (_string_, required) Specifies the instance identifier of the ad server. Example: `INS0491001`. * `requestId` (_string_, required) Specifies the unique identifier of the request. Example: `c9636ffa-bd35-f3ef-38f8-4c649a6fa33f`. * `adServerApplicationName` (_string_) Specifies the name of the ad server application to send the request. Example: `XGlinear`. * `additionalFields` (_object_) Specifies the additional data to be sent. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `requestMode` (_string_, required) Specifies whether the response to receive is minimal or detailed. Valid values are Minimal and Detail. Allowed values: `Minimal`, `Detail`. Example: `Detail`. * `attributes` (_object_) Represents any additional request attributes used by OOTB ASM flows. E.g for radio ad server Triton we make use of publisherId key to pass organizationId. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `requestI18NInfo` (_object_) Specifies details about the locale, timezone, and currency configuration to be used by the request. * `localeName` (_string_) Specifies the locale name of a request. Example: `United States`. * `localeCode` (_string_) Specifies the locale code of the request. Example: `en-us`. * `timezone` (_string_) Specifies the timezone of the request. Example: `Apia Standard Time (Pacific/Apia)`. * `currencyName` (_string_) Specifies the currency name related to the currencyCode property used in the request. Example: `United States Dollar`. * `currencyCode` (_string_) Specifies the currency code used in a request payload. Example: `USD`. * `lineItemId` (_string_, required) Required if the availablityType property is ByItemID. Example: `265987`. * `requestedBy` (_string_, required) Specifies the account or user who initiated the request. Example: `Bianca White`. * `adServerCode` (_string_, required) Specifies the code of the ad server to send the request. Example: `GAM`. * `availabilityType` (_string_, required) Specifies the type of the availability forecast based on an Ad slot or order line. Allowed values: `ByItemID`. Example: `ByItemID`. * `mediaType` (_string_, required) Specifies the media type of the order. Example: `Digital`. * `forecastOptions` (_object_) Specifies additional options, such as targeting criteria to provide the availability forecast. * `additionalFields` (_object_) Provides any additional inputs. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `targetingCriterias` (_object_) Specifies the breakdowns of the availability line item by its targeting method. Valid only when the AvailabilityType property is by prospectiveLineitem property. * `includeTargetingForecastBreakDown` (_boolean_) Indicates whether to return the forecast result broken down by the targeting of the forecasted line item (true) or not (false). The default value is false. Example: `true`. * `timeWindows` (_array of datetime_) Specifies the time ranges of the breakdown of the targeting forecast result. _Example_ ``` - 2016-02-28T16:41:41.090Z - 2016-02-28T16:41:41.090Z ``` * `additionalFields` (_object_) Provides any additional inputs. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `includeContendingLineItems` (_boolean_) Indicates whether the forecast result for the availability line item should include contending line items (true) or not (false). The default value is false. Example: `True`. * _object_ Specifies the Forecasts to be created. * `adServerInstanceId` (_string_, required) Specifies the instance identifier of the ad server. Example: `INS0491001`. * `requestId` (_string_, required) Specifies the unique identifier of the request. Example: `c9636ffa-bd35-f3ef-38f8-4c649a6fa33f`. * `adServerApplicationName` (_string_) Specifies the name of the ad server application to send the request. Example: `XGlinear`. * `additionalFields` (_object_) Specifies the additional data to be sent. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `requestMode` (_string_, required) Specifies whether the response to receive is minimal or detailed. Valid values are Minimal and Detail. Allowed values: `Minimal`, `Detail`. Example: `Minimal`. * `attributes` (_object_) Represents any additional request attributes used by OOTB ASM flows. E.g for radio ad server Triton we make use of publisherId key to pass organizationId. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `requestI18NInfo` (_object_) Specifies the details about the locale, timezone, and currency configuration to be used by the request. * `localeName` (_string_) Specifies the locale name of a request. Example: `United States`. * `localeCode` (_string_) Specifies the locale code of the request. Example: `en-us`. * `timezone` (_string_) Specifies the timezone of the request. Example: `Apia Standard Time (Pacific/Apia)`. * `currencyName` (_string_) Specifies the currency name related to the currencyCode property used in the request. Example: `United States Dollar`. * `currencyCode` (_string_) Specifies the currency code used in a request payload. Example: `USD`. * `requestedBy` (_string_, required) Specifies the account or user who initiated the request. Example: `Bianca White`. * `prospectiveLineitem` (_object_, required) Required if the availablityType property is ByProspectiveItem. * `inventoryTypeCode` (_string_) Specifies the code of the inventory type. The default value is DEFAULT. Example: `DEFAULT`. * `endDate` (_date-only_) Specifies the end date of the line item. Example: `2023-05-23`. * `linearAttributes` (_object_) Specifies any additional or custom attributes to be sent for a linear media type. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `lineItemName` (_string_) Specifies the name of the line item. Example: `10 sec skippable ad`. * `targeting` (_object_) Specifies the targeting details, such as geotargeting or daypart targeting methods. * `dayPartTargeting` (_array of object_) Specifies the targeting specs for the part of the day. Each item: Specifies the details of a targeting segment. * `segmentCode` (_string_) Specifies the segment code. Example: `SlotType`. * `segmentName` (_string_) Specifies the segment name. Example: `SlotType`. * `segmentValues` (_array of object_) Specifies the values of the targeting segment that contains the list of the segment keys and its corresponding targeting value. Each item: Specifies a Segment Value. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `isIncluded` (_boolean_) Specifies the additionalField1 is included or not Default: `true`. * `legacyExpression` (_string_) Specifies a string expression describing the relations between various audience segments. Example: `AND`. * `additionalFields` (_object_) Provides any additional inputs. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `geoTargeting` (_array of object_) Specifies the targeting specs for the geographic area. Each item: Specifies the details of a targeting segment. * `segmentCode` (_string_) Specifies the segment code. Example: `SlotType`. * `segmentName` (_string_) Specifies the segment name. Example: `SlotType`. * `segmentValues` (_array of object_) Specifies the values of the targeting segment that contains the list of the segment keys and its corresponding targeting value. Each item: Specifies a Segment Value. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `isIncluded` (_boolean_) Specifies the additionalField1 is included or not Default: `true`. * `contentTargeting` (_object_) Specifies the content targets linked with the lineitem. The OOTB content types supported are Video, Display, Audio * `contents` (_array of object_) The list of content. Each item: Specifies the details of a single content node. * `id` (_string_, required) The unique identifier of the content. * `type` (_string_) The type of content. Allowed values: `Video`, `Other`. * `typeCode` (_string_) The code that must be specified if the content type selected is Other. * `exclude` (_integer_) Indicates whether to exclude the content for targeting or not. * `attributes` (_object_) The placeholder for internal configurations and additional parameters. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `additionalFields` (_object_) The placeholder for external configurations and additional parameters. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `others` (_array of object_) Specifies the other targeting specs. Each item: Specifies the custom targeting information other than daypart or geographic targeting methods. * `targetingSegmentDefinition` (_array of object_) Specifies the list of the targeting segments related to a category. Each item: Specifies the details of a targeting segment. * `segmentCode` (_string_) Specifies the segment code. Example: `SlotType`. * `segmentName` (_string_) Specifies the segment name. Example: `SlotType`. * `segmentValues` (_array of object_) Specifies the values of the targeting segment that contains the list of the segment keys and its corresponding targeting value. Each item: Specifies a Segment Value. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `isIncluded` (_boolean_) Specifies the additionalField1 is included or not Default: `true`. * `categoryCode` (_string_) Specifies the code of the category. This code can be unique identifier for a custom targeting information. Example: `Audience`. * `categoryName` (_string_) Specifies the name of the targeting category. Example: `Audience Segment`. * `publisherOrderLineItemName` (_string_) Specifies whether to map the publisher order line item in the ad server, if required. The publisherOrderLineItemName property value must not be an internal ID. Example: `samplename`. * `additionalFields` (_object_) Specifies any additional attributes of the prospective line item, which can be defined by using the additionalFields key value. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `isProposal` (_boolean_) Indicates whether the prospectivelineitem property in the payload maps to proposallineitem property in GAM (true) or to a lineitem property in GAM (false). Default: `false`. * `proposalId` (_string_) Specifies the ID of the proposal. * `digitalAttributes` (_object_) Specifies any additional or custom attributes to be sent for a digital media type. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `id` (_string_) Specifies the unique identifier of the line item. Example: `283718`. * `orderId` (_string_) Specifies the identifier denoting the relationship to the order. Example: `1135728`. * `mediaChannelCode` (_string_) Specifies the name of the channel of the line item. Example: `SONY`. * `adSpaceSpecifications` (_array of object_, required) Specifies a place or a group of places where the ad creative is served. Each item: Specifies the details of the ad space spec or ad unit corresponding to the line item. * `adServerAdUnitId` (_string_, required) Specifies the unique identifier of the ad space spec. Daypart for xglinear, can be AdSpaceSpec Name. Format for xglinear is startTime-endTime, for others its adunit id. Example: `22214043670`. * `adServerAdUnitCode` (_string_) Specifies the unique identifier of the ad space spec. Example: `22214043670`. * `creatives` (_array of object_, required) Specifies the list of ad creatives related to the ad space spec. Each item: Specifies the details of the ad creative. * `height` (_string_) Specifies the height of the ad creative. Example: `970`. * `width` (_string_) Specifies the width of the ad creative. Example: `70`. * `adServerCreativeId` (_string_, required) Specifies the unique identifier of the ad creative. Example: `283718`. * `adServerCreativeRunTime` (_string_) Specifies the runtime of the ad creative. Example: `400`. * `adServerCreativeType` (_string_) Specifies the type of the ad creative. Example: `Bookend`. * `additionalFields` (_object_) Provides any additional inputs. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `adCreativeUOM` (_string_) Specifies the unit of measure for the ad creative. Example: `Pixels`. * `companions` (_array of object_) Specifies the list of companion creatives associated with a primary ad creative. Each item: Specifies the details of the ad creative. * `height` (_string_) Specifies the height of the ad creative. Example: `970`. * `width` (_string_) Specifies the width of the ad creative. Example: `70`. * `adServerCreativeId` (_string_) Specifies the unique identifier of the ad creative. Example: `283718`. * `adServerCreativeRunTime` (_string_) Specifies the runtime of the ad creative. Example: `400`. * `adServerCreativeType` (_string_) Specifies the type of the ad creative. Example: `Bookend`. * `adCreativeUOM` (_string_) Specifies the unit of measure for the ad creative. Example: `Pixels`. * `attributes` (_object_) Specifies the placeholder for the internal configurations and additional parameters. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `additionalFields` (_object_) Specifies the placeholder for the external (Customizations) configurations and additional parameters. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `attributes` (_object_) Specifies the placeholder for the internal configurations and additional parameters. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `isIncluded` (_boolean_) Specifies the AdSpaceSpecification is included or not Default: `true`. * `isGroup` (_boolean_) Specifies the AdSpaceSpecification is grouped or not Default: `false`. * `additionalFields` (_object_) Provides any additional input fields. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `frequencyCaps` (_array of object_) Each item: Limits the number of times a user can see an ad creative in a span of time. * `additionalFields` (_object_) Provides any additional inputs. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `timeUnit` (_string_) Specifies the type of the time unit as provided by the numTimeUnits property. Allowed values: `Minute`, `Hour`, `Day`, `Week`, `Month`, `Lifetime`. Example: `Hour`. * `maxImpressions` (_integer_) Specifies the maximum number of impressions for the line item. Example: `1000`. * `numTimeUnits` (_integer_) Specifies the maximum number of time units for the line item. Example: `5`. * `startDate` (_date-only_) Specifies the start date of the line item. Example: `2023-05-23`. * `goals` (_array of object_) Specifies the user engagement goal details related to the line item. Each item: Specifies the goals related to the line item. * `goalType` (_string_, required) Specifies the goal type of the line item. Allowed values: `Lifetime`, `Daily`, `Other`. Example: `Daily`. * `goalTypeCode` (_string_) Specifies the code of the goal type of the line item if the type is "Others". Example: `Weekly`. * `goalUnitType` (_string_, required) Specifies the unit type of the goals for the line item. Allowed values: `Impression`, `Click`, `Other`. Example: `Click`. * `goalUnitTypeCode` (_string_) Specifies the code of the unit type if the unit type is "Others". Example: `Action`. * `goalUnits` (_integer_, required) Specifies the count of the units as specified by the unitType property. Example: `2000`. * `primary` (_boolean_) Indicates whether the goal is primary (true) or not (false). The default value is false. Example: `True`. * `additionalFields` (_object_) Provides any additional inputs. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `pricingSpecs` (_object_, required) Specifies the details related to the pricing of the line item. * `costPerUnit` (_object_) Specifies the cost of one ad space specification. * `value` (_number_) Specifies the value of the currency field. Example: `100`. * `currencyName` (_string_) Specifies the name of the currency as defined by the currencyCode property. Example: `United States Dollar`. * `currencyCode` (_string_) Specifies the code of the currency field. Example: `USD`. * `valueCostPerUnit` (_object_) Specifies the detail about a currency field used in the request payload. * `value` (_number_) Specifies the value of the currency field. Example: `100`. * `currencyCode` (_string_) Specifies the code of the currency field. Example: `USD`. * `currencyName` (_string_) Specifies the name of the currency as defined by the currencyCode property. Example: `United States Dollar`. * `costType` (_string_, required) Specifies the type of the cost, such as cost per click and cost per impression. Example: `CPM`. * `discountType` (_string_) Specifies the type of the discount as specified by the discount field. A discountType percentage value of 15 means the discount provided is 15%. Allowed values: `Absolute`, `Percentage`. Example: `Percentage`. * `discount` (_number_) Specifies the value of the discount. Example: `15`. * `mediaChannelRate` (_array of object_) Specifies the list of the rates based on the media channel and region. Each item: Specifies the rate of a specific channel or region. * `channelCode` (_string_) Specifies the code of the media channel. Example: `SONY`. * `regionCode` (_string_) Specifies the code of the region. Example: `NYC`. * `lineRate` (_object_) Specifies the rate of the line item respective to the channel or region. * `value` (_number_) Specifies the value of the currency field. Example: `100`. * `currencyCode` (_string_) Specifies the code of the currency field. Example: `USD`. * `currencyName` (_string_) Specifies the name of the currency as defined by the currencyCode property. Example: `United States Dollar`. * `totalCost` (_object_) Specifies the total cost of the line item based on the total requested units. * `value` (_number_) Specifies the value of the currency field. Example: `100`. * `currencyName` (_string_) Specifies the name of the currency as defined by the currencyCode property. Example: `United States Dollar`. * `currencyCode` (_string_) Specifies the code of the currency field. Example: `USD`. * `additionalFields` (_object_) Specifies any additional attributes of the line pricing specification, which can be defined by using the additionalFields key value. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `lineItemType` (_string_) Specifies the type of the line item, which can also denote the priority of the line item. Example: `Standard`. * `billingSpecs` (_object_) Specifies the details related to the billing of the line item. * `additionalFields` (_object_) Provides any additional inputs. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `billingModeTypeCode` (_string_) Specifies the billing mode of the line item if the type is "Others". Example: `Usage`. * `billingModeType` (_string_) Specifies the billing mode of the line item. Allowed values: `Threshold`, `Fractional`, `Retail`, `Other`. Example: `Threshold`. * `adServerCode` (_string_, required) Specifies the code of the ad server to send the request. Example: `GAM`. * `availabilityType` (_string_, required) Specifies the type of the availability forecast based on an Ad slot or order line. Allowed values: `ByProspectiveItem`. Example: `ByProspectiveItem`. * `mediaType` (_string_, required) Specifies the media type of the order. Example: `Digital`. * `forecastOptions` (_object_) Specifies additional options, such as targeting criteria to provide the availability forecast. * `additionalFields` (_object_) Provides any additional inputs. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `targetingCriterias` (_object_) Specifies the breakdowns of the availability line item by its targeting method. Valid only when the AvailabilityType property is by prospectiveLineitem property. * `includeTargetingForecastBreakDown` (_boolean_) Indicates whether to return the forecast result broken down by the targeting of the forecasted line item (true) or not (false). The default value is false. Example: `true`. * `timeWindows` (_array of datetime_) Specifies the time ranges of the breakdown of the targeting forecast result. _Example_ ``` - 2016-02-28T16:41:41.090Z - 2016-02-28T16:41:41.090Z ``` * `additionalFields` (_object_) Provides any additional inputs. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `includeContendingLineItems` (_boolean_) Indicates whether the forecast result for the availability line item should include contending line items (true) or not (false). The default value is false. Example: `True`. #### Responses * **200** The Forecasts entity was created. Media type: `application/json`. Schema: `Get_Available_Details_Response`. _Example_ ``` { "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "status": "success", "code": 200 }, "minimalResults": [ "" ], "detailResults": [ { "lineItemId": "2213123", "orderId": 2213123, "unitType": "Impressions", "otherUnits": { "possibleUnits": 100 }, "totalUnits": 1000, "availableUnits": 100, "deliveredUnits": 100, "reservedUnits": 100, "breakdownByTimeWindow": { "start": "2016-02-28T16:41:41.090Z", "end": "2016-02-28T16:41:41.090Z", "availableUnits": 100, "totalUnits": 1000, "otherUnits": { "possibleUnits": 100 } }, "breakdownByTragetingCriteria": { "categoryType": "GEO", "categoryName": "Daypart", "availableUnits": 1 }, "contendingItems": { "lineitemid": 221312, "availableUnits": 100 }, "additionalFields": { "additionField1": "additionField_1_Value" } } ], "additionalFields": { "additionField1": "additionField_1_Value" } } ``` * **400** There was an issue with your request. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 400 response._ * **401** Authorization failed. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 401 response._ * **403** Request forbidden. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 403 response._ * **404** Resource not found. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 404 response._ * **405** Method not allowed. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 405 response._ * **415** Unsupported media type. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 415 response._ * **422** Unprocessable entity. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 422 response._ * **500** Unable to complete the request as the server encountered an error. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 500 response._ ### POST Retrieve delivery details `POST /forecast/delivery` Creates the Forecasts entity. #### Request body Media type: `application/json`. Schema: `object | object`. Specifies the Forecasts to be created. One of: `object`, `object`. * _object_ Specifies the Forecasts to be created. * `adServerInstanceId` (_string_, required) Specifies the instance identifier of the ad server. Example: `INS0491001`. * `lineItemIds` (_array of string_, required) Required if the availablityType property value is ByItemID. _Example_ ``` - '265987' - '265988' ``` * `requestId` (_string_, required) Specifies the unique identifier of the request. Example: `c9636ffa-bd35-f3ef-38f8-4c649a6fa33f`. * `adServerApplicationName` (_string_) Specifies the name of the ad server application to send the request. Example: `XGlinear`. * `additionalFields` (_object_) Specifies the additional data to be sent. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `requestMode` (_string_, required) Specifies whether the response to receive is minimal or detailed. Valid values are Minimal and Detail. Allowed values: `Minimal`, `Detail`. Example: `Detail`. * `deliveryType` (_string_, required) Specifies the type of the delivery forecast based on an Ad slot or an order line. Allowed values: `ByItemID`. Example: `ByItemID`. * `attributes` (_object_) Represents any additional request attributes used by OOTB ASM flows. E.g for radio ad server Triton we make use of publisherId key to pass organizationId. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `requestI18NInfo` (_object_) Specifies details about the locale, timezone, and currency configuration to be used by the request. * `localeName` (_string_) Specifies the locale name of a request. Example: `United States`. * `localeCode` (_string_) Specifies the locale code of the request. Example: `en-us`. * `timezone` (_string_) Specifies the timezone of the request. Example: `Apia Standard Time (Pacific/Apia)`. * `currencyName` (_string_) Specifies the currency name related to the currencyCode property used in the request. Example: `United States Dollar`. * `currencyCode` (_string_) Specifies the currency code used in a request payload. Example: `USD`. * `requestedBy` (_string_, required) Specifies the account or user who initiated the request. Example: `Bianca White`. * `adServerCode` (_string_, required) Specifies the code of the ad server to send the request. Example: `GAM`. * `mediaType` (_string_, required) Specifies the media type of the order. Example: `Digital`. * `forecastOptions` (_object_) Specifies additional options, such as targeting criteria to provide the availability forecast. * `additionalFields` (_object_) Provides any additional inputs. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * _object_ Specifies the Forecasts to be created. * `adServerInstanceId` (_string_, required) Specifies the instance identifier of the ad server. Example: `INS0491001`. * `requestId` (_string_, required) Specifies the unique identifier of the request. Example: `c9636ffa-bd35-f3ef-38f8-4c649a6fa33f`. * `adServerApplicationName` (_string_) Specifies the name of the ad server application to send the request. Example: `XGlinear`. * `additionalFields` (_object_) Specifies the additional data to be sent. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `requestMode` (_string_, required) Specifies whether the response to receive is minimal or detailed. Valid values are Minimal and Detail. Allowed values: `Minimal`, `Detail`. Example: `Minimal`. * `deliveryType` (_string_, required) Specifies the type of the delivery forecast based on an Ad slot or an order line. Allowed values: `ByProspectiveItem`. Example: `ByProspectiveItem`. * `attributes` (_object_) Represents any additional request attributes used by OOTB ASM flows. E.g for radio ad server Triton we make use of publisherId key to pass organizationId. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `requestI18NInfo` (_object_) Specifies details about the locale, timezone, and currency configuration to be used by the request. * `localeName` (_string_) Specifies the locale name of a request. Example: `United States`. * `localeCode` (_string_) Specifies the locale code of the request. Example: `en-us`. * `timezone` (_string_) Specifies the timezone of the request. Example: `Apia Standard Time (Pacific/Apia)`. * `currencyName` (_string_) Specifies the currency name related to the currencyCode property used in the request. Example: `United States Dollar`. * `currencyCode` (_string_) Specifies the currency code used in a request payload. Example: `USD`. * `requestedBy` (_string_, required) Specifies the account or user who initiated the request. Example: `Bianca White`. * `prospectiveLineitem` (_array of object_, required) Required if the availablityType property value is ByProspectiveItem. * `id` (_string_) Specifies the unique identifier of the line item. Example: `283718`. * `lineItemName` (_string_) Specifies the name of the line item. Example: `10 sec skippable ad`. * `startDate` (_date-only_) Specifies the start date of the line item. Example: `2023-05-23`. * `endDate` (_date-only_) Specifies the end date of the line item. Example: `2023-05-23`. * `lineItemType` (_string_) Specifies the type of the line item, which can also denote the priority of the line item. Example: `Standard`. * `mediaChannelCode` (_string_) Specifies the name of the channel of the line item. Example: `SONY`. * `orderId` (_string_) Specifies the identifier denoting the relationship to the order. Example: `1135728`. * `adSpaceSpecifications` (_array of object_, required) Specifies a place or a group of places where the ad creative is served. Each item: Specifies the details of the ad space spec or ad unit corresponding to the line item. * `adServerAdUnitId` (_string_, required) Specifies the unique identifier of the ad space spec. Daypart for xglinear, can be AdSpaceSpec Name. Format for xglinear is startTime-endTime, for others its adunit id. Example: `22214043670`. * `adServerAdUnitCode` (_string_) Specifies the unique identifier of the ad space spec. Example: `22214043670`. * `creatives` (_array of object_, required) Specifies the list of ad creatives related to the ad space spec. Each item: Specifies the details of the ad creative. * `height` (_string_) Specifies the height of the ad creative. Example: `970`. * `width` (_string_) Specifies the width of the ad creative. Example: `70`. * `adServerCreativeId` (_string_, required) Specifies the unique identifier of the ad creative. Example: `283718`. * `adServerCreativeRunTime` (_string_) Specifies the runtime of the ad creative. Example: `400`. * `adServerCreativeType` (_string_) Specifies the type of the ad creative. Example: `Bookend`. * `additionalFields` (_object_) Provides any additional inputs. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `adCreativeUOM` (_string_) Specifies the unit of measure for the ad creative. Example: `Pixels`. * `companions` (_array of object_) Specifies the list of companion creatives associated with a primary ad creative. Each item: Specifies the details of the ad creative. * `height` (_string_) Specifies the height of the ad creative. Example: `970`. * `width` (_string_) Specifies the width of the ad creative. Example: `70`. * `adServerCreativeId` (_string_) Specifies the unique identifier of the ad creative. Example: `283718`. * `adServerCreativeRunTime` (_string_) Specifies the runtime of the ad creative. Example: `400`. * `adServerCreativeType` (_string_) Specifies the type of the ad creative. Example: `Bookend`. * `adCreativeUOM` (_string_) Specifies the unit of measure for the ad creative. Example: `Pixels`. * `attributes` (_object_) Specifies the placeholder for the internal configurations and additional parameters. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `additionalFields` (_object_) Specifies the placeholder for the external (Customizations) configurations and additional parameters. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `attributes` (_object_) Specifies the placeholder for the internal configurations and additional parameters. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `isIncluded` (_boolean_) Specifies the AdSpaceSpecification is included or not Default: `true`. * `isGroup` (_boolean_) Specifies the AdSpaceSpecification is grouped or not Default: `false`. * `additionalFields` (_object_) Provides any additional input fields. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `targeting` (_object_) Specifies the targeting details, such as geotargeting or daypart targeting methods. * `dayPartTargeting` (_array of object_) Specifies the targeting specs for the part of the day. Each item: Specifies the details of a targeting segment. * `segmentCode` (_string_) Specifies the segment code. Example: `SlotType`. * `segmentName` (_string_) Specifies the segment name. Example: `SlotType`. * `segmentValues` (_array of object_) Specifies the values of the targeting segment that contains the list of the segment keys and its corresponding targeting value. Each item: Specifies a Segment Value. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `isIncluded` (_boolean_) Specifies the additionalField1 is included or not Default: `true`. * `legacyExpression` (_string_) Specifies a string expression describing the relations between various audience segments. Example: `AND`. * `additionalFields` (_object_) Provides any additional inputs. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `geoTargeting` (_array of object_) Specifies the targeting specs for the geographic area. Each item: Specifies the details of a targeting segment. * `segmentCode` (_string_) Specifies the segment code. Example: `SlotType`. * `segmentName` (_string_) Specifies the segment name. Example: `SlotType`. * `segmentValues` (_array of object_) Specifies the values of the targeting segment that contains the list of the segment keys and its corresponding targeting value. Each item: Specifies a Segment Value. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `isIncluded` (_boolean_) Specifies the additionalField1 is included or not Default: `true`. * `contentTargeting` (_object_) Specifies the content targets linked with the lineitem. The OOTB content types supported are Video, Display, Audio * `contents` (_array of object_) The list of content. Each item: Specifies the details of a single content node. * `id` (_string_, required) The unique identifier of the content. * `type` (_string_) The type of content. Allowed values: `Video`, `Other`. * `typeCode` (_string_) The code that must be specified if the content type selected is Other. * `exclude` (_integer_) Indicates whether to exclude the content for targeting or not. * `attributes` (_object_) The placeholder for internal configurations and additional parameters. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `additionalFields` (_object_) The placeholder for external configurations and additional parameters. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `others` (_array of object_) Specifies the other targeting specs. Each item: Specifies the custom targeting information other than daypart or geographic targeting methods. * `targetingSegmentDefinition` (_array of object_) Specifies the list of the targeting segments related to a category. Each item: Specifies the details of a targeting segment. * `segmentCode` (_string_) Specifies the segment code. Example: `SlotType`. * `segmentName` (_string_) Specifies the segment name. Example: `SlotType`. * `segmentValues` (_array of object_) Specifies the values of the targeting segment that contains the list of the segment keys and its corresponding targeting value. Each item: Specifies a Segment Value. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `isIncluded` (_boolean_) Specifies the additionalField1 is included or not Default: `true`. * `categoryCode` (_string_) Specifies the code of the category. This code can be unique identifier for a custom targeting information. Example: `Audience`. * `categoryName` (_string_) Specifies the name of the targeting category. Example: `Audience Segment`. * `frequencyCaps` (_array of object_) Each item: Limits the number of times a user can see an ad creative in a span of time. * `additionalFields` (_object_) Provides any additional inputs. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `timeUnit` (_string_) Specifies the type of the time unit as provided by the numTimeUnits property. Allowed values: `Minute`, `Hour`, `Day`, `Week`, `Month`, `Lifetime`. Example: `Hour`. * `maxImpressions` (_integer_) Specifies the maximum number of impressions for the line item. Example: `1000`. * `numTimeUnits` (_integer_) Specifies the maximum number of time units for the line item. Example: `5`. * `pricingSpecs` (_object_, required) Specifies the details related to the pricing of the line item. * `costPerUnit` (_object_) Specifies the cost of one ad space specification. * `value` (_number_) Specifies the value of the currency field. Example: `100`. * `currencyName` (_string_) Specifies the name of the currency as defined by the currencyCode property. Example: `United States Dollar`. * `currencyCode` (_string_) Specifies the code of the currency field. Example: `USD`. * `valueCostPerUnit` (_object_) Specifies the detail about a currency field used in the request payload. * `value` (_number_) Specifies the value of the currency field. Example: `100`. * `currencyCode` (_string_) Specifies the code of the currency field. Example: `USD`. * `currencyName` (_string_) Specifies the name of the currency as defined by the currencyCode property. Example: `United States Dollar`. * `costType` (_string_, required) Specifies the type of the cost, such as cost per click and cost per impression. Example: `CPM`. * `discountType` (_string_) Specifies the type of the discount as specified by the discount field. A discountType percentage value of 15 means the discount provided is 15%. Allowed values: `Absolute`, `Percentage`. Example: `Percentage`. * `discount` (_number_) Specifies the value of the discount. Example: `15`. * `mediaChannelRate` (_array of object_) Specifies the list of the rates based on the media channel and region. Each item: Specifies the rate of a specific channel or region. * `channelCode` (_string_) Specifies the code of the media channel. Example: `SONY`. * `regionCode` (_string_) Specifies the code of the region. Example: `NYC`. * `lineRate` (_object_) Specifies the rate of the line item respective to the channel or region. * `value` (_number_) Specifies the value of the currency field. Example: `100`. * `currencyCode` (_string_) Specifies the code of the currency field. Example: `USD`. * `currencyName` (_string_) Specifies the name of the currency as defined by the currencyCode property. Example: `United States Dollar`. * `totalCost` (_object_) Specifies the total cost of the line item based on the total requested units. * `value` (_number_) Specifies the value of the currency field. Example: `100`. * `currencyName` (_string_) Specifies the name of the currency as defined by the currencyCode property. Example: `United States Dollar`. * `currencyCode` (_string_) Specifies the code of the currency field. Example: `USD`. * `additionalFields` (_object_) Specifies any additional attributes of the line pricing specification, which can be defined by using the additionalFields key value. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `publisherOrderLineItemName` (_string_) Specifies whether to map the publisher order line item in the ad server, if required. The publisherOrderLineItemName property value must not be an internal ID. Example: `samplename`. * `billingSpecs` (_object_) Specifies the details related to the billing of the line item. * `additionalFields` (_object_) Provides any additional inputs. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `billingModeTypeCode` (_string_) Specifies the billing mode of the line item if the type is "Others". Example: `Usage`. * `billingModeType` (_string_) Specifies the billing mode of the line item. Allowed values: `Threshold`, `Fractional`, `Retail`, `Other`. Example: `Threshold`. * `goals` (_array of object_) Specifies the user engagement goal details related to the line item. Each item: Specifies the goals related to the line item. * `goalType` (_string_, required) Specifies the goal type of the line item. Allowed values: `Lifetime`, `Daily`, `Other`. Example: `Daily`. * `goalTypeCode` (_string_) Specifies the code of the goal type of the line item if the type is "Others". Example: `Weekly`. * `goalUnitType` (_string_, required) Specifies the unit type of the goals for the line item. Allowed values: `Impression`, `Click`, `Other`. Example: `Click`. * `goalUnitTypeCode` (_string_) Specifies the code of the unit type if the unit type is "Others". Example: `Action`. * `goalUnits` (_integer_, required) Specifies the count of the units as specified by the unitType property. Example: `2000`. * `primary` (_boolean_) Indicates whether the goal is primary (true) or not (false). The default value is false. Example: `True`. * `additionalFields` (_object_) Provides any additional inputs. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `inventoryTypeCode` (_string_) Specifies the code of the inventory type. The default value is DEFAULT. Example: `DEFAULT`. * `linearAttributes` (_object_) Specifies any additional or custom attributes to be sent for a linear media type. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `digitalAttributes` (_object_) Specifies any additional or custom attributes to be sent for a digital media type. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `isProposal` (_boolean_) Indicates whether the prospectivelineitem property in the payload maps to proposallineitem property in GAM (true) or to a lineitem property in GAM (false). Default: `false`. * `proposalId` (_string_) Specifies the ID of the proposal. * `additionalFields` (_object_) Specifies any additional attributes of the prospective line item, which can be defined by using the additionalFields key value. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `adServerCode` (_string_, required) Specifies the code of the ad server to send the request. Example: `GAM`. * `mediaType` (_string_, required) Specifies the media type of the order. Example: `Digital`. * `forecastOptions` (_object_) Specifies additional options, such as targeting criteria to provide the availability forecast. * `additionalFields` (_object_) Provides any additional inputs. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` #### Responses * **200** The Forecasts entity was created. Media type: `application/json`. Schema: `Get_Delivery_Details_Response`. _Example_ ``` { "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "code": 200, "status": "success" }, "minimalResults": [ { "lineitemid": "221312", "orderId": "221312", "deliveryUnitType": "clicks", "deliveredUnits": 1000, "otherUnitsAttributes": { "matched": 100, "predicted": 100 }, "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } ], "detailResults": [ { "lineitemid": "221312", "orderId": "221312", "deliveryUnitType": "clicks", "deliveredUnits": 1000, "otherUnitsAttributes": { "matched": 100, "predicted": 100 }, "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } ], "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } ``` * **400** There was an issue with your request. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 400 response._ * **401** Authorization failed. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 401 response._ * **403** Request forbidden. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 403 response._ * **404** Resource not found. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 404 response._ * **405** Method not allowed. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 405 response._ * **415** Unsupported media type. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 415 response._ * **422** Unprocessable entity. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 422 response._ * **500** Unable to complete the request as the server encountered an error. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 500 response._ ### POST Create proposal `POST /proposal` Creates the Proposal entity. #### Request body Media type: `application/json`. Schema: `Create_Proposal`. Specifies the Proposal to be created. #### Responses * **200** The Proposal entity was created. Media type: `application/json`. Schema: `Create_Proposal_Response`. _Example_ ``` { "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "code": 200, "status": "success", "additionalStatus" : { "atomicTransaction": "Existing", "idValues": ["1135728"] } }, "minimalResults" : ["1135728"], "detailResults": [ { "id": "1135728", "name": "Test Proposal", "startDate": "2022-03-30", "endDate": "2022-03-30", "status": "DRAFT", "proposalHeader": { "isProgrammatic": false, "publisher": { "id": "43321", "email": "publisher@gmail.com", "name": "Mossaic", "role": "Ads Publisher", "type": "Salesperson", "typeCode": "", "isComapny": false, "primary": false, "officeCode": "US_SF_02", "sharePercent": "", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } }, "revenueSpecs": { "revenueTypecode": "PRORATE", "additionalFields": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" } }, "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } }, "invoiceSpecs": { "invoiceType": "PDF", "invoiceTypeCode": "XLS", "EDIProductCode": "", "EDIOrder": "", "EDIClientCode": "", "additionalFields": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" } }, "otherPersonas": [ { "id": "APIXXXXXX", "email": "rd@yahoo.com", "name": "Ritendra", "role": "Salesperson", "type": "Other", "typeCode": "Example", "isCompany": false, "primary": false, "officeCode": "IND01", "sharePercent": "23", "additionalFields": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" } } ], "notes": "", "tags": [ "release-244", "release-246" ], "purchaseOrderNumber": "", "publisherOrderName": "01/2023 DEN", "totalBudget": { "value": 100, "currencyCode": "USD", "currencyName": "United States Dollar" }, "salespeople": [ { "id": "98878", "email": "rd@gmail.com", "name": "John", "role": "Customer Success Manager", "type": "Salesperson", "typeCode": "", "isComapny": false, "primary": false, "officeCode": "US_SF_01", "sharePercent": "", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } ], "agencies": [ { "id": "AGENCY100", "email": "agency@gmail.com", "name": "Sonyliv Agency", "role": "Manager", "type": "Agency", "typeCode": "", "isComapny": false, "primary": false, "officeCode": "US_SF_01", "sharePercent": "", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } ], "orderStatus": "Approved", "traffickers": [ { "id": "32312", "email": "james@gmail.com", "name": "James", "role": "Manager", "type": "Trafficker", "typeCode": "", "isComapny": false, "primary": false, "officeCode": "US_SF_01", "sharePercent": "", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } ], "billingSpecs": { "billingCycleType": "Broadcast", "billingCycleTypeCode": "QRTR", "billingMode": "Fractional", "additionalFields": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" } }, "orderType": "", "deliveryDetails": { "totalImpressionsDelivered": 20000, "totalClicksDelivered": 200, "totalViewableImpressionsDelivered": 200, "additionalFields": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" } } }, "advertiser": { "primary": false, "isCompany": false, "officeCode": "IND01", "name": "Ritendra", "additionalFields": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" }, "id": "APIXXXXXX", "sharePercent": "23", "email": "rd@yahoo.com", "role": "Salesperson", "typeCode": "Example", "type": "Other" }, "buyer": { "primary": false, "isCompany": false, "officeCode": "IND01", "name": "Ritendra", "additionalFields": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" }, "id": "APIXXXXXX", "sharePercent": "23", "email": "rd@yahoo.com", "role": "Salesperson", "typeCode": "Example", "type": "Other" }, "sellers": [ { "id": "APIXXXXXX", "email": "rd@yahoo.com", "name": "Ritendra", "role": "Salesperson", "type": "Other", "typeCode": "Example", "isCompany": false, "primary": false, "officeCode": "IND01", "sharePercent": "23", "additionalFields": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" } } ], "lineItems": [ { "proposalId": "1135728", "lineItemDetail": { "inventoryTypeCode": "DEFAULT", "endDate": "2023-06-26", "linearAttributes": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } }, "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": { "revenueTypecode": "PRORATE", "additionalFields": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" } }, "publisherOrderLineItemName": "", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } }, "digitalAttributes": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } }, "id": "283718", "orderId": "1135728", "mediaChannelCode": "SONY", "adSpaceSpecifications": [ { "adServerAdUnitId": "00:00-23:59", "adServerAdUnitCode": "22214043670", "creatives": [ { "height": "970", "width": "70", "adServerCreativeId": "283718", "adServerCreativeRunTime": "400", "adServerCreativeType": "Bookend", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } ], "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } ], "frequencyCaps": [ { "maxImpressions": 1000, "numTimeUnits": 5, "timeUnit": "Hour", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } ], "startDate": "2023-06-26", "lineItemQuantity": { "totalQuantity": 12, "quantityBreakdownByDay": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } }, "totalQuantityPeriodType": "weekly", "totalQuantityType": "impressions", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } }, "goals": [ { "goalType": "Daily", "goalTypeCode": "Weekly", "goalUnitType": "Click", "goalUnitTypeCode": "Action", "goalUnits": 2000, "primary": false, "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } ], "pricingSpecs": { "costPerUnit": { "value": 100, "currencyCode": "USD", "currencyName": "United States Dollar" }, "valueCostPerUnit": { "value": 100, "currencyCode": "USD", "currencyName": "United States Dollar" }, "costType": "CPM", "discountType": "Percentage", "discount": 15, "mediaChannelRate": [ { "channelCode": "SONY", "regionCode": "NYC", "lineRate": { "value": 100, "currencyCode": "USD", "currencyName": "United States Dollar" } } ], "totalCost": { "value": 100, "currencyCode": "USD", "currencyName": "United States Dollar" }, "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } }, "lineItemType": "STANDARD", "billingSpecs": { "billingModeType": "Threshold", "billingModeTypeCode": "Usage", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } }, "lineItemPriority": 1, "adTypeAttributes": { "videoAttributes": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" }, "audioAttributes": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" }, "displayAttributes": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" }, "otherAttributes": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" } }, "status": "DRAFT", "attributes": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" }, "additionalFields": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" } } ], "attributes": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" }, "additionalFields": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" } } ], "additionalFields": { "contractId": "additionField1" } } ``` * **400** There was an issue with your request. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 400 response._ * **401** Authorization failed. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 401 response._ * **403** Request forbidden. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 403 response._ * **404** Resource not found. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 404 response._ * **405** Method not allowed. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 405 response._ * **415** Unsupported media type. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 415 response._ * **422** Unprocessable entity. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 422 response._ * **500** Unable to complete the request as the server encountered an error. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 500 response._ ### POST Create proposal line items `POST /proposal/lineItems` Creates the Proposal entity. #### Request body Media type: `application/json`. Schema: `Create_Proposal_Line_Items`. Specifies the Proposal to be created. #### Responses * **200** Created the Proposal entity. Media type: `application/json`. Schema: `Create_Proposal_Line_Items_Response`. _Example_ ``` { "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "code": 200, "status": "success", "additionalStatus" : { "atomicTransaction": "Existing", "idValues": ["283718"] } }, "minimalResults" : [ { "id": "283718", "name": "Test Proposal 1", "status": "DRAFT", "operatingOn": "Proposal", "additionalFields": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" } }, { "id": "283719", "name": "Test Proposal 2", "status": "DRAFT", "operatingOn": "Order", "additionalFields": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" } } ], "detailResults": [ { "proposalId": "1135728", "lineItemDetail": { "inventoryTypeCode": "DEFAULT", "endDate": "2023-06-26", "linearAttributes": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } }, "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": { "revenueTypecode": "PRORATE", "additionalFields": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" } }, "publisherOrderLineItemName": "", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } }, "digitalAttributes": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } }, "id": "283718", "orderId": "1135728", "mediaChannelCode": "SONY", "adSpaceSpecifications": [ { "adServerAdUnitId": "00:00-23:59", "adServerAdUnitCode": "22214043670", "creatives": [ { "height": "970", "width": "70", "adServerCreativeId": "283718", "adServerCreativeRunTime": "400", "adServerCreativeType": "Bookend", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } ], "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } ], "frequencyCaps": [ { "maxImpressions": 1000, "numTimeUnits": 5, "timeUnit": "Hour", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } ], "startDate": "2023-06-26", "lineItemQuantity": { "totalQuantity": 12, "quantityBreakdownByDay": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } }, "totalQuantityPeriodType": "weekly", "totalQuantityType": "impressions", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } }, "goals": [ { "goalType": "Daily", "goalTypeCode": "Weekly", "goalUnitType": "Click", "goalUnitTypeCode": "Action", "goalUnits": 2000, "primary": false, "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } ], "pricingSpecs": { "costPerUnit": { "value": 100, "currencyCode": "USD", "currencyName": "United States Dollar" }, "valueCostPerUnit": { "value": 100, "currencyCode": "USD", "currencyName": "United States Dollar" }, "costType": "CPM", "discountType": "Percentage", "discount": 15, "mediaChannelRate": [ { "channelCode": "SONY", "regionCode": "NYC", "lineRate": { "value": 100, "currencyCode": "USD", "currencyName": "United States Dollar" } } ], "totalCost": { "value": 100, "currencyCode": "USD", "currencyName": "United States Dollar" }, "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } }, "lineItemType": "STANDARD", "billingSpecs": { "billingModeType": "Threshold", "billingModeTypeCode": "Usage", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } }, "lineItemPriority": 1, "adTypeAttributes": { "videoAttributes": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" }, "audioAttributes": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" }, "displayAttributes": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" }, "otherAttributes": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" } }, "status": "DRAFT", "attributes": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" }, "additionalFields": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" } } ], "additionalFields": { "contractId": "additionField1" } } ``` * **400** There was an issue with your request. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 400 response._ * **401** Authorization failed. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 401 response._ * **403** Request forbidden. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 403 response._ * **404** Resource not found. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 404 response._ * **405** Method not allowed. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 405 response._ * **415** Unsupported media type. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 415 response._ * **422** Unprocessable entity. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 422 response._ * **500** Unable to complete the request as the server encountered an error. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 500 response._ ### PUT Update proposal line items `PUT /proposal/lineItems` Updates the Proposal entity. #### Request body Media type: `application/json`. Schema: `Update_Proposal_Line_Items`. Specifies the Proposal to be updated. #### Responses * **200** The Proposal entity was updated. Media type: `application/json`. Schema: `Update_Proposal_Line_Items_Response`. _Example_ ``` { "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "code": 200, "status": "success" }, "minimalResults" : [], "detailResults": [ { "proposalId": "12345", "lineItemDetail": { "inventoryTypeCode": "DEFAULT", "endDate": "2023-06-26", "linearAttributes": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } }, "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": { "revenueTypecode": "PRORATE", "additionalFields": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" } }, "publisherOrderLineItemName": "", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } }, "digitalAttributes": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } }, "id": "283718", "orderId": "1135728", "mediaChannelCode": "SONY", "adSpaceSpecifications": [ { "adServerAdUnitId": "00:00-23:59", "adServerAdUnitCode": "22214043670", "creatives": [ { "height": "970", "width": "70", "adServerCreativeId": "283718", "adServerCreativeRunTime": "400", "adServerCreativeType": "Bookend", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } ], "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } ], "frequencyCaps": [ { "maxImpressions": 1000, "numTimeUnits": 5, "timeUnit": "Hour", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } ], "startDate": "2023-06-26", "lineItemQuantity": { "totalQuantity": 12, "quantityBreakdownByDay": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } }, "totalQuantityPeriodType": "weekly", "totalQuantityType": "impressions", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } }, "goals": [ { "goalType": "Daily", "goalTypeCode": "Weekly", "goalUnitType": "Click", "goalUnitTypeCode": "Action", "goalUnits": 2000, "primary": false, "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } ], "pricingSpecs": { "costPerUnit": { "value": 100, "currencyCode": "USD", "currencyName": "United States Dollar" }, "valueCostPerUnit": { "value": 100, "currencyCode": "USD", "currencyName": "United States Dollar" }, "costType": "CPM", "discountType": "Percentage", "discount": 15, "mediaChannelRate": [ { "channelCode": "SONY", "regionCode": "NYC", "lineRate": { "value": 100, "currencyCode": "USD", "currencyName": "United States Dollar" } } ], "totalCost": { "value": 100, "currencyCode": "USD", "currencyName": "United States Dollar" }, "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } }, "lineItemType": "STANDARD", "billingSpecs": { "billingModeType": "Threshold", "billingModeTypeCode": "Usage", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } }, "lineItemPriority": 1, "adTypeAttributes": { "videoAttributes": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" }, "audioAttributes": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" }, "displayAttributes": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" }, "otherAttributes": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" } }, "status": "DRAFT", "attributes": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" }, "additionalFields": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" } } ], "additionalFields": { "contractId": "additionField1" } } ``` * **400** There was an issue with your request. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 400 response._ * **401** Authorization failed. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 401 response._ * **403** Request forbidden. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 403 response._ * **404** Resource not found. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 404 response._ * **405** Method not allowed. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 405 response._ * **415** Unsupported media type. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 415 response._ * **422** Unprocessable entity. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 422 response._ * **500** Unable to complete the request as the server encountered an error. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 500 response._ ### POST Perform proposal action `POST /proposal/action` Performs the requested operation on a proposal. If line items are specified, then the requested operation is performed for the specified line items. Otherwise, all line items of a proposal are impacted. #### Request body Media type: `application/json`. Schema: `Perform_Proposal_Action`. Specifies the Perform Proposal to be created. #### Responses * **200** The Perform Proposal entity was created. Media type: `application/json`. Schema: `Perform_Proposal_Action_Response`. _Example_ ``` { "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "code": 200, "status": "success" }, "additionalFields": { "additionField1": "additionField_1_Value" } } ``` * **400** There was an issue with your request. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 400 response._ * **401** Authorization failed. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 401 response._ * **403** Request forbidden. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 403 response._ * **404** Resource not found. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 404 response._ * **405** Method not allowed. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 405 response._ * **415** Unsupported media type. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 415 response._ * **422** Unprocessable entity. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 422 response._ * **500** Unable to complete the request as the server encountered an error. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 500 response._ ### POST Get proposal status `POST /proposal/statusQuery` Creates the Proposal entity. #### Request body Media type: `application/json`. Schema: `Get_Proposal_Status`. Specifies the Proposal to be created. #### Responses * **200** The Proposal entity was created. Media type: `application/json`. Schema: `Get_Proposal_Status_Response`. _Example_ ``` { "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "code": 200, "status": "success" }, "minimalResults": [ { "id": "56736573", "name": "media plan 101", "status": "Draft", "operatingOn": "Proposal", "additionalFields": { "additionField1": "additionField_1_Value" } }, { "id": "56736562", "name": "media plan 102", "status": "InReview", "operatingOn": "Order", "additionalFields": { "additionField1": "additionField_1_Value" } } ], "detailResults": [ { "id": "1135728", "name": "Test Proposal", "startDate": "2022-03-30", "endDate": "2022-03-30", "status": "DRAFT", "proposalHeader": { "isProgrammatic": false, "publisher": { "id": "43321", "email": "publisher@gmail.com", "name": "Mossaic", "role": "Ads Publisher", "type": "Salesperson", "typeCode": "", "isComapny": false, "primary": false, "officeCode": "US_SF_02", "sharePercent": "", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } }, "revenueSpecs": { "revenueTypecode": "PRORATE", "additionalFields": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" } }, "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } }, "invoiceSpecs": { "invoiceType": "PDF", "invoiceTypeCode": "XLS", "EDIProductCode": "", "EDIOrder": "", "EDIClientCode": "", "additionalFields": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" } }, "otherPersonas": [ { "id": "APIXXXXXX", "email": "rd@yahoo.com", "name": "Ritendra", "role": "Salesperson", "type": "Other", "typeCode": "Example", "isCompany": false, "primary": false, "officeCode": "IND01", "sharePercent": "23", "additionalFields": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" } } ], "notes": "", "tags": [ "release-244", "release-246" ], "purchaseOrderNumber": "", "publisherOrderName": "01/2023 DEN", "totalBudget": { "value": 100, "currencyCode": "USD", "currencyName": "United States Dollar" }, "salespeople": [ { "id": "98878", "email": "rd@gmail.com", "name": "John", "role": "Customer Success Manager", "type": "Salesperson", "typeCode": "", "isComapny": false, "primary": false, "officeCode": "US_SF_01", "sharePercent": "", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } ], "agencies": [ { "id": "AGENCY100", "email": "agency@gmail.com", "name": "Sonyliv Agency", "role": "Manager", "type": "Agency", "typeCode": "", "isComapny": false, "primary": false, "officeCode": "US_SF_01", "sharePercent": "", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } ], "orderStatus": "Approved", "traffickers": [ { "id": "32312", "email": "james@gmail.com", "name": "James", "role": "Manager", "type": "Trafficker", "typeCode": "", "isComapny": false, "primary": false, "officeCode": "US_SF_01", "sharePercent": "", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } ], "billingSpecs": { "billingCycleType": "Broadcast", "billingCycleTypeCode": "QRTR", "billingMode": "Fractional", "additionalFields": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" } }, "orderType": "", "deliveryDetails": { "totalImpressionsDelivered": 20000, "totalClicksDelivered": 200, "totalViewableImpressionsDelivered": 200, "additionalFields": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" } } }, "advertiser": { "primary": false, "isCompany": false, "officeCode": "IND01", "name": "Ritendra", "additionalFields": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" }, "id": "APIXXXXXX", "sharePercent": "23", "email": "rd@yahoo.com", "role": "Salesperson", "typeCode": "Example", "type": "Other" }, "buyer": { "primary": false, "isCompany": false, "officeCode": "IND01", "name": "Ritendra", "additionalFields": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" }, "id": "APIXXXXXX", "sharePercent": "23", "email": "rd@yahoo.com", "role": "Salesperson", "typeCode": "Example", "type": "Other" }, "sellers": [ { "id": "APIXXXXXX", "email": "rd@yahoo.com", "name": "Ritendra", "role": "Salesperson", "type": "Other", "typeCode": "Example", "isCompany": false, "primary": false, "officeCode": "IND01", "sharePercent": "23", "additionalFields": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" } } ], "lineItems": [ { "proposalId": "1135728", "lineItemDetail": { "inventoryTypeCode": "DEFAULT", "endDate": "2023-06-26", "linearAttributes": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } }, "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": { "revenueTypecode": "PRORATE", "additionalFields": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" } }, "publisherOrderLineItemName": "", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } }, "digitalAttributes": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } }, "id": "283718", "orderId": "1135728", "mediaChannelCode": "SONY", "adSpaceSpecifications": [ { "adServerAdUnitId": "00:00-23:59", "adServerAdUnitCode": "22214043670", "creatives": [ { "height": "970", "width": "70", "adServerCreativeId": "283718", "adServerCreativeRunTime": "400", "adServerCreativeType": "Bookend", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } ], "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } ], "frequencyCaps": [ { "maxImpressions": 1000, "numTimeUnits": 5, "timeUnit": "Hour", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } ], "startDate": "2023-06-26", "lineItemQuantity": { "totalQuantity": 12, "quantityBreakdownByDay": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } }, "totalQuantityPeriodType": "weekly", "totalQuantityType": "impressions", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } }, "goals": [ { "goalType": "Daily", "goalTypeCode": "Weekly", "goalUnitType": "Click", "goalUnitTypeCode": "Action", "goalUnits": 2000, "primary": false, "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } ], "pricingSpecs": { "costPerUnit": { "value": 100, "currencyCode": "USD", "currencyName": "United States Dollar" }, "valueCostPerUnit": { "value": 100, "currencyCode": "USD", "currencyName": "United States Dollar" }, "costType": "CPM", "discountType": "Percentage", "discount": 15, "mediaChannelRate": [ { "channelCode": "SONY", "regionCode": "NYC", "lineRate": { "value": 100, "currencyCode": "USD", "currencyName": "United States Dollar" } } ], "totalCost": { "value": 100, "currencyCode": "USD", "currencyName": "United States Dollar" }, "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } }, "lineItemType": "STANDARD", "billingSpecs": { "billingModeType": "Threshold", "billingModeTypeCode": "Usage", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } }, "lineItemPriority": 1, "adTypeAttributes": { "videoAttributes": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" }, "audioAttributes": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" }, "displayAttributes": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" }, "otherAttributes": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" } }, "status": "DRAFT", "attributes": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" }, "additionalFields": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" } } ], "attributes": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" }, "additionalFields": { "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" }, "additionField1": "additionField1" } } ], "additionalFields": { "additionField1": "additionField_1_Value" } } ``` * **400** There was an issue with your request. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 400 response._ * **401** Authorization failed. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 401 response._ * **403** Request forbidden. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 403 response._ * **404** Resource not found. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 404 response._ * **405** Method not allowed. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 405 response._ * **415** Unsupported media type. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 415 response._ * **422** Unprocessable entity. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 422 response._ * **500** Unable to complete the request as the server encountered an error. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 500 response._ ### POST Create ad server users `POST /setup/user` Creates the Ad Server User entity. #### Request body Media type: `application/json`. Schema: `Create_Ad_Server_User`. Specifies the Ad Server User to be created. #### Responses * **200** The Ad Server User entity was created. Media type: `application/json`. Schema: `Create_Ad_Server_User_Response`. _Example_ ``` { "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "code": 200, "status": "success" }, "minimalResults": [ "1135728", "1135729" ], "detailResults": [ "1135728", "1135729" ], "additionalFields": { "additionField1": "additionField_1_Value" } } ``` * **400** There was an issue with your request. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 400 response._ * **401** Authorization failed. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 401 response._ * **403** Request forbidden. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 403 response._ * **404** Resource not found. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 404 response._ * **405** Method not allowed. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 405 response._ * **415** Unsupported media type. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 415 response._ * **422** Unprocessable entity. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 422 response._ * **500** Unable to complete the request as the server encountered an error. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 500 response._ ### POST Create ad server accounts `POST /setup/account` Creates the Ad Server Account entity. #### Request body Media type: `application/json`. Schema: `Create_Ad_Server_Account`. Specifies the Ad Server Account to be created. #### Responses * **200** The Ad Server Account entity was created. Media type: `application/json`. Schema: `Create_Ad_Server_Account_Response`. _Example_ ``` { "requestId": "RQST00001", "requestedBy": "Bianca White", "adServerInstanceId": "INS0491001", "result": { "code": 200, "status": "success" }, "minimalResults": [ "1135728", "1135729" ], "detailResults": [ { "id": "32312", "email": "james@gmail.com", "name": "James", "role": "Manager", "type": "Other", "typeCode": "User", "isComapny": false, "primary": false, "officeCode": "HQ", "sharePercent": "90%", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } }, { "id": "98878", "email": "rd@gmail.com", "name": "John", "role": "Manager", "type": "Other", "typeCode": "User", "isComapny": false, "primary": false, "officeCode": "HQ", "sharePercent": "90%", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } ], "additionalFields": { "additionField1": "additionField_1_Value" } } ``` * **400** There was an issue with your request. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 400 response._ * **401** Authorization failed. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 401 response._ * **403** Request forbidden. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 403 response._ * **404** Resource not found. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 404 response._ * **405** Method not allowed. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 405 response._ * **415** Unsupported media type. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 415 response._ * **422** Unprocessable entity. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 422 response._ * **500** Unable to complete the request as the server encountered an error. Media type: `application/json`. Schema: `ErrorMessage`. _Example: same as POST /orders 500 response._ ## Schemas ### Create\_Order * `requestId` (_string_, required) Specifies the unique identifier of the request. Example: `c9636ffa-bd35-f3ef-38f8-4c649a6fa33f`. * `requestedBy` (_string_, required) Specifies the account or user who initiated the request. Example: `Bianca White`. * `requestI18NInfo` (_object_) Specifies the details about the locale, timezone, and currency configuration to be used by the request. Includes all fields of `I18NInfo`. * `requestMode` (_string_, required) Specifies whether the response to receive is minimal or detailed. Valid values are Minimal and Detail. Allowed values: `Minimal`, `Detail`. Example: `Minimal`. * `adServerInstanceId` (_string_, required) Specifies the instance identifier of the ad server. Example: `INS0491001`. * `adServerCode` (_string_, required) Specifies the code of the ad server to send the request. Example: `FW`. * `adServerApplicationName` (_string_, required) Specifies the name of the ad server application to send the request. Example: `XGlinear`. * `mediaType` (_string_, required) Specifies the media type of the order. Example: `Digital`. * `orders` (_array of object_, required) Specifies the list of orders to create. Includes all fields of `Order`. * `additionalFields` (_object_) Specifies the additional data to be sent. Includes all fields of `KeyValuePair`. * `attributes` (_object_) Represents any additional request attributes used by OOTB ASM flows. E.g for radio ad server Triton we make use of publisherId key to pass organizationId. Includes all fields of `KeyValuePair`. ### Create\_Order\_Response * `requestId` (_string_, required) Specifies a unique identifier of the request. Example: `RQST00001`. * `requestedBy` (_string_, required) Specifies the account or user who initiated the request. Example: `Bianca White`. * `adServerInstanceId` (_string_, required) Specifies the instance identifier of the ad server. Example: `INS0491001`. * `result` (_object_, required) Represents A standard Result Includes all fields of `Result`. _Example_ ``` { "status": "success", "code": 200 } ``` * `minimalResults` (_array of string_) Specifies the minimal response. _Example_ ``` - "11013482" ``` * `detailResults` (_array of object_) Specifies the detailed response. Includes all fields of `OrderResponse`. * `additionalFields` (_object_) Specifies the additional data to be sent. Includes all fields of `KeyValuePair`. ### ErrorMessage Shown when an API throws an error, typically with an HTTP error response code (3xx, 4xx, or 5xx). * `requestId` (_string_, required) Specifies the unique identifier of the request. Example: `RQST00001`. * `requestedBy` (_string_, required) Specifies the account or user who initiated the request. Example: `Bianca White`. * `adServerInstanceId` (_string_, required) Specifies the instance identifier of the ad server. Example: `INS0491001`. * `result` (_object_, required) Specifies the metadata of the error payload. Includes all fields of `Result`. * `minimalResults` (_array of any_) Specifies the minimal response. _Example_ ``` [] ``` * `detailResults` (_array of any_) Specifies the detailed response. _Example_ ``` [] ``` * `additionalFields` (_array of any_) Specifies the additional data to be sent. _Example_ ``` [] ``` ### Update\_Order * `requestId` (_string_, required) Specifies a unique identifier of the request. Example: `c9636ffa-bd35-f3ef-38f8-4c649a6fa33f`. * `requestedBy` (_string_, required) Specifies the account or user who initiated the request. Example: `Bianca White`. * `requestI18NInfo` (_object_) Specifies details about the locale, timezone, and currency configuration to be used by the request. Includes all fields of `I18NInfo`. * `requestMode` (_string_, required) Specifies whether the response to receive is minimal or detailed. Valid values are Minimal and Detail. Allowed values: `Minimal`, `Detail`. Example: `Minimal`. * `adServerInstanceId` (_string_, required) Specifies the instance identifier of the ad server. Example: `INS0491001`. * `adServerCode` (_string_, required) Specifies the code of the ad server to send the request. Example: `FW`. * `adServerApplicationName` (_string_) Specifies the name of the ad server application to send the request. Example: `XGlinear`. * `mediaType` (_string_, required) Specifies the media type of the order. Example: `Digital`. * `orders` (_array of object_, required) Specifies the list of the orders to create. Includes all fields of `Order`. * `additionalFields` (_object_) Specifies the additional data to be sent. Includes all fields of `KeyValuePair`. * `attributes` (_object_) Represents any additional request attributes used by OOTB ASM flows. E.g for radio ad server Triton we make use of publisherId key to pass organizationId. Includes all fields of `KeyValuePair`. ### Update\_Order\_Response * `requestId` (_string_, required) Specifies the unique identifier of the request. Example: `RQST00001`. * `requestedBy` (_string_, required) Specifies the account or user who initiated the request. Example: `Bianca White`. * `adServerInstanceId` (_string_, required) Specifies the instance identifier of the ad server. Example: `INS0491001`. * `result` (_object_, required) Represents the standard result. Includes all fields of `Result`. _Example_ ``` { "status": "success", "code": 200 } ``` * `minimalResults` (_array of string_) Specifies the minimal response. _Example_ ``` - "11013482" ``` * `detailResults` (_array of object_) Specifies the detailed response. Includes all fields of `OrderResponse`. * `additionalFields` (_object_) Specifies the additional data to be sent. Includes all fields of `KeyValuePair`. ### Create\_LineItems * `requestId` (_string_, required) Specifies a unique identifier of the request. Example: `RQST00001`. * `requestedBy` (_string_, required) Specifies the account or user who initiated the request. Example: `Bianca White`. * `requestMode` (_string_, required) Specifies whether the response to receive is minimal or detailed. Valid values are Minimal and Detail. Allowed values: `Minimal`, `Detail`. Default: `Minimal`. Example: `Minimal`. * `requestI18NInfo` (_object_) Specifies details about the locale, timezone, and currency configuration to be used by the request. Includes all fields of `I18NInfo`. * `adServerInstanceId` (_string_, required) Specifies the instance identifier of the ad server. Example: `INS0491001`. * `adServerCode` (_string_, required) Specifies the code of the ad server to send the request to. Example: `GAM`. * `adServerApplicationName` (_string_, required) Specifies the name of the ad server application to send the request. Example: `xglinear`. * `mediaType` (_string_, required) Specifies the media type of the order. Example: `TV`. * `orderId` (_string_, required) Specifies the order ID to create the line items. * `items` (_array of object_, required) Specifies the list of the line items to create. Includes all fields of `LineItem`. * `additionalFields` (_object_) Specifies the additional data to be sent. Includes all fields of `KeyValuePair`. * `attributes` (_object_) Represents any additional request attributes used by OOTB ASM flows. E.g for radio ad server Triton we make use of publisherId key to pass organizationId. Includes all fields of `KeyValuePair`. ### Create\_LineItems\_Response * `requestId` (_string_, required) Specifies a unique identifier of the request. Example: `RQST00001`. * `requestedBy` (_string_, required) Specifies the account or user who initiated the request. Example: `Bianca White`. * `adServerInstanceId` (_string_, required) Specifies the instance identifier of the ad server. Example: `INS0491001`. * `result` (_object_, required) Represents the standard result. Includes all fields of `Result`. _Example_ ``` { "status": "success", "code": 200 } ``` * `minimalResults` (_array of object_) Specifies the minimal response. _Example_ ``` - "10 sec skippable ad": "234333" - "20 sec skippable ad": "234333" ``` * `detailResults` (_array of object_) Specifies the detailed response. Includes all fields of `LineItemResponse`. * `additionalFields` (_object_) Specifies the additional data to be sent. Includes all fields of `KeyValuePair`. ### Update\_LineItems * `requestId` (_string_, required) Specifies the unique identifier of the request. Example: `c9636ffa-bd35-f3ef-38f8-4c649a6fa33f`. * `requestedBy` (_string_, required) Specifies the account or user who initiated the request. Example: `Bianca White`. * `requestI18NInfo` (_object_) Specifies details about the locale, timezone, and currency configuration to be used by the request. Includes all fields of `I18NInfo`. * `requestMode` (_string_, required) Specifies whether the response to receive is minimal or detailed. Valid values are Minimal and Detail. Allowed values: `Minimal`, `Detail`. Example: `Minimal`. * `adServerInstanceId` (_string_, required) Specifies the instance identifier of the ad server. Example: `INS0491001`. * `adServerCode` (_string_, required) Specifies the code of the ad server to send the request. Example: `GAM`. * `adServerApplicationName` (_string_) Specifies the name of the ad server application to send the request. Example: `XGlinear`. * `orderId` (_string_, required) Specifies the order ID to update the order status. Example: `1135728`. * `mediaType` (_string_, required) Specifies the media type of the order. Example: `Digital`. * `items` (_array of object_, required) Specifies the list of orders to be created. Includes all fields of `LineItem`. * `additionalFields` (_object_) Specifies the additional data to be sent. Includes all fields of `KeyValuePair`. * `attributes` (_object_) Represents any additional request attributes used by OOTB ASM flows. E.g for radio ad server Triton we make use of publisherId key to pass organizationId. Includes all fields of `KeyValuePair`. ### Update\_LineItems\_Response * `requestId` (_string_, required) Specifies the unique identifier of the request. Example: `RQST00001`. * `requestedBy` (_string_, required) Specifies the account or user who initiated the request. Example: `Bianca White`. * `adServerInstanceId` (_string_, required) Specifies the instance identifier of the ad server. Example: `INS0491001`. * `result` (_object_, required) Represents the standard result. Includes all fields of `Result`. _Example_ ``` { "status": "success", "code": 200 } ``` * `minimalResults` (_array of string_, required) Specifies the minimal response. * `detailResults` (_array of object_, required) Specifies the detailed response. Includes all fields of `LineItemResponse`. * `additionalFields` (_object_, required) Specifies the additional data to be sent. Includes all fields of `KeyValuePair`. ### Update\_OrderAction * `requestId` (_string_, required) Specifies the unique identifier of the request. Example: `RQST00001`. * `requestedBy` (_string_, required) Specifies the account or user who initiated the request. Example: `Bianca White`. * `requestI18NInfo` (_object_) Specifies details about the locale, timezone, and currency configuration to be used by the request. Includes all fields of `I18NInfo`. * `adServerInstanceId` (_string_, required) Specifies the instance identifier of the ad server. Example: `INS0491001`. * `adServerCode` (_string_, required) Specifies the code of the ad server to send the request. Example: `XG`. * `adServerApplicationName` (_string_, required) Specifies the name of the ad server application to send the request. Example: `xglinear`. * `mediaType` (_string_, required) Specifies the media type of the order. Example: `TV`. * `updateActionType` (_string_, required) Specifies the type of update action on the order or order lines. Allowed values: `ActivateLineItems`, `ArchiveLineItems`, `DeleteLineItems`, `ApproveOrder`, `DeleteOrder`, `PauseOrder`, `ResumeOrder`, `ArchiveOrder`, `Other`. * `updateActionCode` (_string_) Specifies the update action code in case of action type as others. * `orderId` (_string_, required) Specifies the order ID to update the order status. Example: `1135728`. * `lineIds` (_array of string_) Specifies the line item IDs to update the status. _Example_ ``` - "283718" - "283719" - "283720" ``` * `additionalFields` (_object_) Specifies the additional data to be sent. Includes all fields of `KeyValuePair`. * `attributes` (_object_) Represents any additional request attributes used by OOTB ASM flows. E.g for radio ad server Triton we make use of publisherId key to pass organizationId. Includes all fields of `KeyValuePair`. ### Update\_OrderAction\_Response * `requestId` (_string_, required) Specifies the unique identifier of the request. Example: `RQST00001`. * `requestedBy` (_string_, required) Specifies the account or user who initiated the request. Example: `Bianca White`. * `adServerInstanceId` (_string_, required) Specifies the instance identifier of the ad server. Example: `INS0491001`. * `result` (_object_, required) Represents the standard result. Includes all fields of `Result`. _Example_ ``` { "status": "success", "code": 200 } ``` * `additionalFields` (_object_) Specifies the additional data to be sent. Includes all fields of `KeyValuePair`. ### Get\_lineItemStatus * `requestId` (_string_, required) Specifies the unique identifier of the request. Example: `RQST00001`. * `requestedBy` (_string_, required) Specifies the account or user who initiated the request. Example: `Bianca White`. * `requestI18NInfo` (_object_) Specifies details about the locale, timezone, and currency configuration to be used by the request. Includes all fields of `I18NInfo`. * `requestMode` (_string_, required) Specifies whether the response to receive is minimal or detailed. Valid values are Minimal and Detail. Allowed values: `Minimal`, `Detail`. Example: `Minimal`. * `adServerInstanceId` (_string_, required) Specifies the instance identifier of the ad server. Example: `INS0491001`. * `adServerCode` (_string_, required) Specifies the code of the ad server to send the request. Example: `XG`. * `adServerApplicationName` (_string_, required) Specifies the name of the ad server application to send the request. Example: `xglinear`. * `mediaType` (_string_, required) Specifies the media type of the order. Example: `TV`. * `orderId` (_string_, required) Specifies the order ID to update the status. Minimum length: 1. Example: `1135728`. * `lineIds` (_array of string_, required) Specifies the line item IDs to update the status. Minimum items: 1. _Example_ ``` - "283718" - "283719" - "283720" ``` * `additionalFields` (_object_) Specifies the additional data to be sent. Includes all fields of `KeyValuePair`. * `attributes` (_object_) Represents any additional request attributes used by OOTB ASM flows. E.g for radio ad server Triton we make use of publisherId key to pass organizationId. Includes all fields of `KeyValuePair`. ### Get\_lineItemStatus\_Response * `requestId` (_string_, required) Specifies the unique identifier of the request. Example: `RQST00001`. * `requestedBy` (_string_, required) Specifies the account or user who initiated the request. Example: `Bianca White`. * `adServerInstanceId` (_string_, required) Specifies the instance identifier of the ad server. Example: `INS0491001`. * `result` (_object_, required) Represents the standard result. Includes all fields of `Result`. _Example_ ``` { "status": "success", "code": 200 } ``` * `minimalResults` (_any_) Specifies the minimal response. * `detailResults` (_array of object_) Specifies the detailed response. Includes all fields of `AvailabilityForecast`. * `additionalFields` (_object_) Specifies the additional data to be sent. Includes all fields of `KeyValuePair`. ### Get\_Available\_Details\_Response * `requestId` (_string_, required) Specifies the unique identifier of the request. Example: `RQST00001`. * `requestedBy` (_string_, required) Specifies the account or user who initiated the request. Example: `Bianca White`. * `adServerInstanceId` (_string_, required) Specifies the instance identifier of the ad server. Example: `INS0491001`. * `result` (_object_, required) Represents the standard result. Includes all fields of `Result`. _Example_ ``` { "status": "success", "code": 200 } ``` * `minimalResults` (_array of string_) Specifies the minimal response. * `detailResults` (_array of object_) Specifies the detailed response. Includes all fields of `AvailabilityForecast`. * `additionalFields` (_object_) Specifies the additional data to be sent. Includes all fields of `KeyValuePair`. ### Get\_Delivery\_Details\_Response * `requestId` (_string_, required) Specifies the unique identifier of the request. Example: `RQST00001`. * `requestedBy` (_string_, required) Specifies the account or user who initiated the request. Example: `Bianca White`. * `adServerInstanceId` (_string_, required) Specifies the instance identifier of the ad server. Example: `INS0491001`. * `result` (_object_, required) Represents the standard result. Includes all fields of `Result`. _Example_ ``` { "status": "success", "code": 200 } ``` * `minimalResults` (_array of object_) Specifies the minimal response. Includes all fields of `DeliveryForecast`. * `detailResults` (_array of object_) Specifies the detailed response. Includes all fields of `DeliveryForecast`. * `additionalFields` (_object_) Specifies the additional data to be sent. Includes all fields of `KeyValuePair`. ### Create\_Proposal * `requestId` (_string_, required) Specifies the unique identifier of the request. Example: `c9636ffa-bd35-f3ef-38f8-4c649a6fa33f`. * `requestedBy` (_string_, required) Specifies the account or user who initiated the request. Example: `Bianca White`. * `requestI18NInfo` (_object_) Specifies details about the locale, timezone, and currency configuration, which are used by the request. Includes all fields of `I18NInfo`. * `requestMode` (_string_, required) Specifies whether the response to receive is minimal or detailed. Valid values are Minimal and Detail. Allowed values: `Minimal`, `Detail`. Example: `Minimal`. * `adServerInstanceId` (_string_, required) Specifies the instance identifier of the ad server. Example: `INS0491001`. * `adServerCode` (_string_, required) Specifies the code of the ad server to send the request. Example: `GAM`. * `adServerApplicationName` (_string_) Specifies the name of the ad server application to send the request. Example: `XGlinear`. * `mediaType` (_string_) Specifies the media type of the order. Example: `Digital`. * `proposals` (_array of object_, required) Contains the list of proposals along with each proposal's line items list. Includes all fields of `Proposal`. * `additionalFields` (_object_) Specifies the additional data to be sent. Includes all fields of `KeyValuePair`. * `attributes` (_object_) Represents any additional request attributes used by OOTB ASM flows. E.g for radio ad server Triton we make use of publisherId key to pass organizationId. Includes all fields of `KeyValuePair`. ### Create\_Proposal\_Response * `requestId` (_string_, required) Specifies the unique identifier of the request. Example: `RQST00001`. * `requestedBy` (_string_, required) Specifies the account or user who initiated the request. Example: `Bianca White`. * `adServerInstanceId` (_string_, required) Specifies the instance identifier of the ad server. Example: `INS0491001`. * `result` (_object_, required) Represents the standard result. Includes all fields of `Result`. _Example_ ``` { "status": "success", "code": 200 } ``` * `minimalResults` (_array of string_) Specifies the minimal response. _Example_ ``` - '1135728' - '1135729' ``` * `detailResults` (_array of object_) Specifies the detailed response. Includes all fields of `Proposal`. * `additionalFields` (_object_) Specifies the additional data to be sent. Includes all fields of `KeyValuePair`. ### Create\_Proposal\_Line\_Items * `requestId` (_string_, required) Specifies the unique identifier of the request. Example: `c9636ffa-bd35-f3ef-38f8-4c649a6fa33f`. * `requestedBy` (_string_, required) Specifies the account or user who initiated the request. Example: `Bianca White`. * `requestI18NInfo` (_object_) Specifies details about the locale, timezone, and currency configuration, which are used by the request. Includes all fields of `I18NInfo`. * `requestMode` (_string_, required) Specifies whether the response to receive is minimal or detailed. Valid values are Minimal and Detail. Allowed values: `Minimal`, `Detail`. Example: `Minimal`. * `adServerInstanceId` (_string_, required) Specifies the instance identifier of the ad server. Example: `INS0491001`. * `adServerCode` (_string_, required) Specifies the code of the ad server to send the request to. Example: `GAM`. * `adServerApplicationName` (_string_) Specifies the name of the ad server application to send the request. Example: `XGlinear`. * `mediaType` (_string_) Specifies the media type of the order. Example: `Digital`. * `proposalId` (_string_, required) Specifies the unique ID of the proposal. Example: `12345`. * `lineItems` (_array of object_, required) Specifies the line items to create. Includes all fields of `ProposalLineItem`. * `additionalFields` (_object_) Specifies the additional data to be sent. Includes all fields of `KeyValuePair`. * `attributes` (_object_) Represents any additional request attributes used by OOTB ASM flows. E.g for radio ad server Triton we make use of publisherId key to pass organizationId. Includes all fields of `KeyValuePair`. ### Create\_Proposal\_Line\_Items\_Response * `requestId` (_string_, required) Specifies the unique identifier of the request. Example: `RQST00001`. * `requestedBy` (_string_, required) Specifies the account or user who initiated the request. Example: `Bianca White`. * `adServerInstanceId` (_string_, required) Specifies the instance identifier of the ad server. Example: `INS0491001`. * `result` (_object_, required) Represents the standard result. Includes all fields of `Result`. _Example_ ``` { "status": "success", "code": 200 } ``` * `minimalResults` (_array of object_) Specifies the minimal response. Includes all fields of `OperationStatus`. * `detailResults` (_array of object_) Specifies the detailed response. Includes all fields of `ProposalLineItem`. * `additionalFields` (_object_) Specifies the additional data to be sent. Includes all fields of `KeyValuePair`. ### Update\_Proposal\_Line\_Items * `requestId` (_string_, required) Specifies the unique identifier of the request. Example: `c9636ffa-bd35-f3ef-38f8-4c649a6fa33f`. * `requestedBy` (_string_, required) Specifies the account or user who initiated the request. Example: `Bianca White`. * `requestI18NInfo` (_object_) Specifies details about the locale, timezone, and currency configuration, which are used by the request. Includes all fields of `I18NInfo`. * `requestMode` (_string_, required) Specifies whether the response to receive is minimal or detailed. Valid values are Minimal and Detail. Allowed values: `Minimal`, `Detail`. Example: `Minimal`. * `adServerInstanceId` (_string_, required) Specifies the instance identifier of the ad server. Example: `INS0491001`. * `adServerCode` (_string_, required) Specifies the code of the ad server to send the request to. Allowed values: `GAM`, `XG`. Example: `XG`. * `adServerApplicationName` (_string_) Specifies the name of the ad server application to send the request. Example: `XGlinear`. * `mediaType` (_string_) Specifies the media type of the order. Example: `Digital`. * `proposalId` (_string_, required) Specifies the unique ID of the proposal. Example: `12345`. * `lineItems` (_array of object_, required) Specifies the line items to update. Includes all fields of `ProposalLineItem`. * `additionalFields` (_object_) Specifies the additional data to be sent. Includes all fields of `KeyValuePair`. * `attributes` (_object_) Represents any additional request attributes used by OOTB ASM flows. E.g for radio ad server Triton we make use of publisherId key to pass organizationId. Includes all fields of `KeyValuePair`. ### Update\_Proposal\_Line\_Items\_Response * `requestId` (_string_, required) Specifies the unique identifier of the request. Example: `RQST00001`. * `requestedBy` (_string_, required) Specifies the account or user who initiated the request. Example: `Bianca White`. * `adServerInstanceId` (_string_, required) Specifies the instance identifier of the ad server. Example: `INS0491001`. * `result` (_object_, required) Represents a standard result. Includes all fields of `Result`. _Example_ ``` { "status": "success", "code": 200 } ``` * `minimalResults` (_array of string_) Specifies the minimal response. _Example_ ``` [] ``` * `detailResults` (_array of object_) Specifies the detailed response. Includes all fields of `ProposalLineItem`. * `additionalFields` (_object_) Specifies the additional data to be sent. Includes all fields of `KeyValuePair`. ### Perform\_Proposal\_Action * `requestId` (_string_, required) Specifies the unique identifier of the request. Example: `RQST00001`. * `requestedBy` (_string_, required) Specifies the account or user who initiated the request. Example: `Bianca White`. * `requestI18NInfo` (_object_) Specifies details about the locale, timezone, and currency configuration to be used by the request. Includes all fields of `I18NInfo`. * `adServerInstanceId` (_string_, required) Specifies the instance identifier of the ad server. Example: `INS0491001`. * `adServerCode` (_string_, required) Specifies the code of the ad server to send the request. Example: `GAM`. * `adServerApplicationName` (_string_) Specifies the name of the ad server application to send the request. Example: `GAM360`. * `updateActionType` (_string_, required) Specifies the update action type. For example, OpenForEdit action for proposal and Archive action for proposal line item. Example: `Archive`. * `updateActionCode` (_string_) Specifies the update action code in case of action type as others. * `mediaType` (_string_) Specifies the media type of the order. Example: `Digital`. * `proposalId` (_string_, required) Specifies the unique ID of the proposal. Example: `12345`. * `lineItemIds` (_array of string_) Specifies the list of the proposal line item IDs. _Example_ ``` - "265987" - "265988" ``` * `additionalFields` (_object_) Specifies the additional data to be sent. Includes all fields of `KeyValuePair`. * `attributes` (_object_) Represents any additional request attributes used by OOTB ASM flows. E.g for radio ad server Triton we make use of publisherId key to pass organizationId. Includes all fields of `KeyValuePair`. ### Perform\_Proposal\_Action\_Response * `requestId` (_string_, required) Specifies the unique identifier of the request. Example: `RQST00001`. * `requestedBy` (_string_, required) Specifies the account or user who initiated the request. Example: `Bianca White`. * `adServerInstanceId` (_string_, required) Specifies the instance identifier of the ad server. Example: `INS0491001`. * `result` (_object_, required) Represents A standard Result Includes all fields of `Result`. _Example_ ``` { "status": "success", "code": 200 } ``` * `additionalFields` (_object_) Specifies the additional data to be sent. Includes all fields of `KeyValuePair`. ### Get\_Proposal\_Status * `requestId` (_string_, required) Specifies the unique identifier of the request. Example: `RQST00001`. * `requestedBy` (_string_, required) Specifies the account or user who initiated the request. Example: `Bianca White`. * `requestI18NInfo` (_object_) Specifies details about the locale, timezone, and currency configuration to be used by the request. Includes all fields of `I18NInfo`. * `requestMode` (_string_, required) Specifies whether the response to receive is minimal or detailed. Valid values are Minimal and Detail. Allowed values: `Minimal`, `Detail`. Example: `Minimal`. * `adServerInstanceId` (_string_, required) Specifies the instance identifier of the ad server. Example: `INS0491001`. * `adServerCode` (_string_, required) Specifies the code of the ad server to send the request. Example: `GAM`. * `adServerApplicationName` (_string_) Specifies the name of the ad server application to send the request. Example: `GAM360`. * `mediaType` (_string_) Specifies the media type of the order. Example: `Digital`. * `proposalIds` (_array of string_, required) Specifies the unique ID of the proposal. _Example_ ``` - "12345" - "265988" ``` * `additionalFields` (_object_) Specifies the additional data to be sent. Includes all fields of `KeyValuePair`. * `attributes` (_object_) Represents any additional request attributes used by OOTB ASM flows. E.g for radio ad server Triton we make use of publisherId key to pass organizationId. Includes all fields of `KeyValuePair`. ### Get\_Proposal\_Status\_Response * `requestId` (_string_, required) Specifies the unique identifier of the request. Example: `RQST00001`. * `requestedBy` (_string_, required) Specifies the account or user who initiated the request. Example: `Bianca White`. * `adServerInstanceId` (_string_, required) Specifies the instance identifier of the ad server. Example: `INS0491001`. * `result` (_object_, required) Represents the standard result. Includes all fields of `Result`. _Example_ ``` { "status": "success", "code": 200 } ``` * `minimalResults` (_array of object_) Specifies the minimal response. Includes all fields of `OperationStatus`. * `detailResults` (_array of object_) Specifies the detailed response. Includes all fields of `Proposal`. * `additionalFields` (_object_) Specifies the additional data to be sent. Includes all fields of `KeyValuePair`. ### Create\_Ad\_Server\_User * `requestId` (_string_, required) The unique identifier of the request. Example: `RQST00001`. * `requestedBy` (_string_, required) The account or user who initiated the request. Example: `Bianca White`. * `requestI18NInfo` (_object_) The details about the locale, timezone, and currency configuration that the request uses. Includes all fields of `I18NInfo`. * `requestMode` (_string_, required) Specifies whether the response is minimal or detailed. Allowed values: `Minimal`, `Detail`. Example: `Minimal`. * `adServerInstanceId` (_string_, required) The instance identifier of the ad server. Example: `INS0491001`. * `adServerCode` (_string_, required) The code of the ad server to send the request. Example: `GAM`. * `adServerApplicationName` (_string_, required) The name of the ad server application to send the request. Example: `GAM`. * `userPersonas` (_array of object_, required) The persona of an ad server user. Includes all fields of `Persona`. * `mediaType` (_string_, required) The media type of the order. Example: `Digital`. * `additionalFields` (_object_) The additional inputs to be sent. Includes all fields of `KeyValuePair`. * `attributes` (_object_) The additional request attributes that ASM flows use. For example, for radio ad server Triton, the API uses the publisherId key to pass organizationId. Includes all fields of `KeyValuePair`. ### Create\_Ad\_Server\_User\_Response * `requestId` (_string_, required) The unique identifier of the request. Example: `RQST00001`. * `requestedBy` (_string_, required) The account or user who initiated the request. Example: `Bianca White`. * `adServerInstanceId` (_string_, required) The instance identifier of the ad server. Example: `INS0491001`. * `result` (_object_, required) The standard result of the request. Includes all fields of `Result`. _Example_ ``` { "status": "success", "code": 200 } ``` * `minimalResults` (_array of string_) The minimal response of the request that contains the list of user IDs. _Example_ ``` - "11013482" ``` * `detailResults` (_array of string_) The detailed response to the request. _Example_ ``` - "11013482" ``` * `additionalFields` (_object_) The additional inputs that are passed in the request. Includes all fields of `KeyValuePair`. ### Create\_Ad\_Server\_Account * `requestId` (_string_, required) The unique identifier of the request. Example: `RQST00001`. * `requestedBy` (_string_, required) The account or user who initiated the request. Example: `Bianca White`. * `requestI18NInfo` (_object_) The details about the locale, timezone, and currency configuration that the request uses. Includes all fields of `I18NInfo`. * `requestMode` (_string_, required) Specifies whether the response is minimal or detailed. Allowed values: `Minimal`, `Detail`. Example: `Minimal`. * `adServerInstanceId` (_string_, required) The instance identifier of the ad server. Example: `INS0491001`. * `adServerCode` (_string_, required) The code of the ad server to send the request. Example: `GAM`. * `adServerApplicationName` (_string_, required) The name of the ad server application to send the request. Example: `GAM`. * `accountPersonas` (_array of object_, required) The personas of the ad server accounts. Includes all fields of `Persona`. * `mediaType` (_string_, required) The media type of the order. Example: `Digital`. * `additionalFields` (_object_) The additional data to be sent. Includes all fields of `KeyValuePair`. * `attributes` (_object_) The additional request attributes that ASM flows use. For example, for radio ad server Triton, the API uses publisherId key to pass organizationId. Includes all fields of `KeyValuePair`. ### Create\_Ad\_Server\_Account\_Response * `requestId` (_string_, required) The unique identifier of the request. Example: `RQST00001`. * `requestedBy` (_string_, required) The account or user who initiated the request. Example: `Bianca White`. * `adServerInstanceId` (_string_, required) The instance identifier of the ad server. Example: `INS0491001`. * `result` (_object_, required) The standard result of the request. Includes all fields of `Result`. _Example_ ``` { "status": "success", "code": 200 } ``` * `minimalResults` (_array of string_) The minimal response of the request that contains the list of account IDs. _Example_ ``` - "11013482" ``` * `detailResults` (_array of object_) The detailed response of the request. Includes all fields of `Persona`. * `additionalFields` (_object_) The additional data that was passed in the request. Includes all fields of `KeyValuePair`. ### I18NInfo Represents the I18N information of the request. * `localeCode` (_string_) Specifies the locale code of the request. Example: `en-us`. * `localeName` (_string_) Specifies the locale name of a request. Example: `United States`. * `currencyCode` (_string_) Specifies the currency code used in a request payload. Example: `USD`. * `currencyName` (_string_) Specifies the currency name related to the currencyCode property used in the request. Example: `United States Dollar`. * `timezone` (_string_) Specifies the timezone of the request. Example: `Apia Standard Time (Pacific/Apia)`. ### Order Specifies the order details. * `id` (_string_) Specifies the unique identifier of the order. Example: `1135728`. * `startDate` (_date-only_, required) Specifies the start date of the order. Example: `2022-03-30`. * `endDate` (_date-only_) Specifies the end date of the order. Example: `2022-03-30`. * `advertiserId` (_string_, required) Specifies the unique identifier of the advertiser account. Example: `USR0913781`. * `orderName` (_string_) Specifies the name of the order. Example: `TV channel order`. * `orderHeader` (_object_) Specifies the details of the order. Includes all fields of `OrderHeader`. * `campaign` (_object_) Specifies the detailed information about an campaign to which this order belongs to. Includes all fields of `Campaign`. * `lines` (_array of object_) Specifies the line items of the order. Includes all fields of `LineItem`. * `attributes` (_object_) Includes all fields of `KeyValuePair`. * `additionalFields` (_object_) Specifies the additional metadata or custom details of the order. Includes all fields of `KeyValuePair`. ### KeyValuePair Specifies a key-value pair map. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` ### Result Specifies the metadata of the response payload. * `status` (_string_) Allowed values: `success`, `error`. * `code` (_integer_) Specifies a set of predefined codes similar to the HTTP status codes to indicate a business rule violation. * `additionalStatus` (_object_) Specifies the additional status for atomic transaction * `atomicTransaction` (_string_, required) Specifies the status of atomic transaction Example: `Existing`. * `idValues` (_array of string_, required) Specifies the id's which are already present _Example_ ``` - '1135728' - '1135729' ``` * `adServerLogId` (_string_) Specifies the unique log ID tied to the request for troubleshooting. * `shortMessage` (_string_) If request mode is minimal, send at least the minimum information required to understand the error case. * `verboseMessage` (_string_) If request mode is detail, send verbose information required to understand the error case. ### OrderResponse Specifies the order details. * `id` (_string_) Specifies the unique identifier of the order. Example: `1135728`. * `startDate` (_date-only_) Specifies the start date of the order. Example: `2022-03-30`. * `endDate` (_date-only_) Specifies the end date of the order. Example: `2022-03-30`. * `advertiserId` (_string_, required) Specifies the unique identifier of the advertiser account. Example: `USR0913781`. * `orderName` (_string_) Specifies the name of the order. Example: `TV channel order`. * `orderHeader` (_object_) Specifies the details of the order. Includes all fields of `OrderHeaderResponse`. * `lines` (_array of object_) Specifies the line items of the order. Includes all fields of `LineItem`. * `attributes` (_object_) Includes all fields of `KeyValuePair`. * `additionalFields` (_object_) Specifies the additional metadata or custom details of the order. Includes all fields of `KeyValuePair`. ### LineItem Specifies the line items details. * `id` (_string_) Specifies the ad server identifier of the order. Example: `283718`. * `startDate` (_date-only_, required) Specifies the start date of the order. Example: `2023-06-26`. * `endDate` (_date-only_) Specifies the end date of the order. Example: `2023-06-26`. * `startTime` (_string_) Specifies the start time in hh:mm:ss format. Example: `01:00:00`. * `endTime` (_string_) Specifies the end time in hh:mm:ss format. Example: `23:59:59`. * `lineItemName` (_string_, required) Specifies the name of the line item. Example: `10 sec skippable ad`. * `lineItemType` (_string_) Specifies the type of the line item, which can also denote the priority of the line item. Allowed values: `SPONSORSHIP`, `STANDARD`, `NETWORK`, `BULK`, `PRICE_PRIORITY`, `HOUSE`, `LEGACY_DFP`, `CLICK_TRACKING`, `ADSENSE`, `AD_EXCHANGE`, `BUMPER`, `ADMOB`, `PREFERRED_DEAL`, `UNKNOWN`. Example: `STANDARD`. * `mediaChannelCode` (_string_) Specifies the name of the channel of the line item. Example: `SONY`. * `orderId` (_string_) Specifies the identifier denoting the relationship to the order. Example: `1135728`. * `adSpaceSpecifications` (_array of AdSpaceSpecification_, required) Specifies a place or a group of places where the ad creative is served. * `targeting` (_object_) Specifies the targeting details, such as geotargeting and daypart targeting methods. Includes all fields of `Targeting`. _Example_ ``` { "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" }] } ], "legacyExpression": "AND" } ``` * `frequencyCaps` (_array of object_) Each item: Limits the number of times a user can see an ad creative in a span of time. Includes all fields of `FrequencyCaps`. * `pricingSpecs` (_object_, required) Specifies the details related to the pricing of the line item. Includes all fields of `PricingSpecs`. * `publisherOrderLineItemName` (_string_) Specifies the order line item name as provided by the publisher. * `billingSpecs` (_object_) Specifies the details related to the billing of the line item. Includes all fields of `OrderLineBillingSpecs`. * `goals` (_array of object_) Specifies the user engagement goal details related to the line item. Includes all fields of `Goal`. * `lineItemQuantity` (_object_, required) Specifies the details related to the requested units to the ad server. Includes all fields of `LineItemQuantity`. * `inventoryTypeCode` (_string_) Specifies the code of the inventory type. The default value is DEFAULT. Default: `DEFAULT`. * `linearAttributes` (_object_) Specifies additional linear attributes. Includes all fields of `KeyValuePair`. * `pacingType` (_string_) Specifies the delivery pacing of the line item from a list of accepted values. Allowed values: `Even`, `AsFastAsPossible`, `FrontLoaded`, `TrendBased`, `Other`. Example: `Even`. * `pacingCode` (_string_) Specifies the delivery pacing of the line item in case of Other pacingType. Example: `Other`. * `deliveryMethods` (_array of string_) Specifies the delivery methods within a lineitem. _Example_ ``` - "Live" ``` * `positions` (_array of string_) Specifies the Ad positions within a lineitem. _Example_ ``` - "PreRoll" ``` * `digitalAttributes` (_object_) Specifies additional digital attributes. Includes all fields of `KeyValuePair`. * `revenueSpecs` (_object_) Specifies the details related to the revenue line item. Includes all fields of `RevenueSpecs`. * `additionalFields` (_object_) Specifies the additional metadata or custom information of the order header. Includes all fields of `KeyValuePair`. * `hiatusDates` (_object_) Provides additional inputs. Includes all fields of `DateTimeRange`. * `hiatusDays` (_array of string_) Provides additional inputs. Items: Allowed values: `Monday`, `Tuesday`, `Wednesday`, `Thursday`, `Friday`, `Saturday`, `Sunday`. ### LineItemResponse Specifies the line items details. * `id` (_string_) Specifies the ad server identifier of the order. Example: `283718`. * `startDate` (_date-only_, required) Specifies the start date of the order. Example: `2023-06-26`. * `endDate` (_date-only_, required) Specifies the end date of the order. Example: `2023-06-26`. * `mediaChannelCode` (_string_, required) Specifies the name of the channel of the line item. Example: `SONY`. * `adSpaceSpecifications` (_object_, required) Specifies a place or a group of places where an ad creative is served. Includes all fields of `UpdateAdSpaceSpecification`. * `targeting` (_string_) Specifies the targeting details, such as geotargeting and daypart targeting methods. Example: `DENA`. * `pricingSpecs` (_object_) Specifies the details related to the pricing of the line item. Includes all fields of `UpdatePricingSpecs`. * `publisherOrderLineItemName` (_string_) Specifies the order line item name as provided by the publisher. * `billingSpecs` (_object_) Specifies the details related to the billing of the line item. Includes all fields of `OrderLineBillingSpecs`. * `goals` (_object_) Specifies the user engagement goal details related to the line item. Includes all fields of `Goal`. * `lineItemQuantity` (_object_, required) Specifies the details related to the requested units to the ad server. Includes all fields of `LineItemQuantity`. ### AvailabilityForecast Represents the availability forecast response for the forecast services. * `lineItemId` (_string_) Specifies the ad server ID of the line item. Example: `2213123`. * `orderId` (_integer_) Specifies the ad server ID of the order. Example: `2213123`. * `unitType` (_string_) Specifies how the units denoted by other fields are defined. Example: `Impressions`. * `otherUnits` (_object_) Specifies any other unit data to pass. Includes all fields of `OtherUnits`. * `totalUnits` (_integer_) Specifies the total units or capacity the ad server has on the requested date or date range. Example: `1000`. * `availableUnits` (_integer_) Specifies the number of units that can be booked without affecting the delivery of any reserved line items. Example: `100`. * `deliveredUnits` (_integer_) Specifies the number of units that are already served. Example: `100`. * `reservedUnits` (_integer_) Specifies the number of reserved units requested. Example: `100`. * `breakdownByTimeWindow` (_object_) Specifies the breakdowns for each time window. Includes all fields of `TimeWindowBreakDown`. * `breakdownByTragetingCriteria` (_object_) Specifies the breakdown by the targeting criteria. Includes all fields of `TargetingBreakDown`. * `contendingItems` (_object_) Specifies the breakdown by the contending line items. Includes all fields of `ContentingItemBreakdown`. * `additionalFields` (_object_) Provides any additional inputs. Includes all fields of `KeyValuePair`. ### DeliveryForecast Represents the delivery forecast response for the forecast services. * `additionalFields` (_object_) Provides any additional inputs. Includes all fields of `KeyValuePair`. * `lineitemid` (_string_) Specifies the identifier of the line item, if provided in the request. Example: `221312`. * `orderId` (_string_) Specifies the identifier of the order, if provided in the request. Example: `221312`. * `deliveryUnitType` (_string_) Specifies the delivery unit type, such as clicks and impressions. Example: `clicks`. * `deliveredUnits` (_number_) Specifies the number of units delivered. Example: `1000`. * `otherUnitsAttributes` (_object_) Specifies the other attributes related to the unit. Includes all fields of `KeyValuePair`. ### Proposal Specifies the proposal details. * `id` (_string_, required) Specifies the unique identifier of the proposal. Example: `1135728`. * `name` (_string_, required) Specifies the name of the proposal. Example: `Test Proposal`. * `startDate` (_date-only_, required) Specifies the start date of the proposal. Example: `2022-03-30`. * `endDate` (_date-only_, required) Specifies the end date of the proposal. Example: `2022-03-30`. * `status` (_string_) Specifies the status of the proposal. Example: `Draft`. * `proposalHeader` (_object_) Specifies the details of the proposal. Includes all fields of `OrderHeader`. * `advertiser` (_object_, required) Specifies the advertiser details. Includes all fields of `Persona`. * `buyer` (_object_) Specifies the buyer details. Includes all fields of `Persona`. * `sellers` (_array of object_) Specifies the seller's contacts. Includes all fields of `Persona`. * `lineItems` (_array of object_) Specifies the details of the proposal line items associated with the proposal. Includes all fields of `ProposalLineItem`. * `attributes` (_object_) Specifies the additional fields required for proposals. Attributes are reserved for internal use only. Includes all fields of `KeyValuePair`. * `additionalFields` (_object_) Specifies the additional metadata or custom information of the proposal. Includes all fields of `KeyValuePair`. ### ProposalLineItem Specifies the proposal line item details. * `proposalId` (_string_, required) Specifies the ID of the proposal associated with the proposal line item. Example: `1135728`. * `lineItemDetail` (_object_, required) Specifies the details of the proposal line item. Includes all fields of `LineItem`. * `lineItemPriority` (_integer_) Specifies the priority of the line item. Example: `1`. * `deliveryRateType` (_string_) Specifies the rate. Valid values are Evenly and Frontloaded. Allowed values: `EVENLY`, `FRONTLOADED`. * `videoAttributes` (_object_) Specifies the details related to the proposal line item of the video type. Includes all fields of `KeyValuePair`. * `audioAttributes` (_object_) Specifies the details related to the proposal line item of the audio type. Includes all fields of `KeyValuePair`. * `displayAttributes` (_object_) Specifies the details related to the proposal line item of the display type. Includes all fields of `KeyValuePair`. * `status` (_string_) Specifies the status. Example: `DRAFT`. * `attributes` (_object_) Specifies the additional fields required for proposal line items. Attributes are reserved for internal use only. Includes all fields of `KeyValuePair`. * `additionalFields` (_object_) Specifies the additional metadata or custom information of the proposal. Includes all fields of `KeyValuePair`. ### OperationStatus Specifies the status of the operation on the object, such as the Order, OrderLineItem, Proposal, ProposalLineItem objects. * `id` (_string_, required) Specifies the ID of the object. Example: `56736573`. * `name` (_string_) Specifies the name of the object. Example: `media plan 101`. * `status` (_string_, required) Specifies the status of the object. Example: `Draft`. * `operatingOn` (_string_, required) Specifies the object being operated upon. Example: `Proposal`. * `additionalFields` (_object_) Provides any additional inputs. Includes all fields of `KeyValuePair`. ### Persona * `id` (_string_, required) Specifies the ID of the persona, which can be an individual account or a company. Example: `APIXXXXXX`. * `email` (_string_) Specifies the email ID of the persona. Example: `rd@yahoo.com`. * `name` (_string_) Specifies the name of the persona. Example: `Ritendra`. * `role` (_string_) Specifies the role of the persona. Example: `Salesperson`. * `type` (_string_) Specifies a persona type, such as an advertiser or a salesperson. Valid values are Buyer, Seller, Agency, Advertiser, Trafficker, Salesperson, Publisher, and Other. Allowed values: `Buyer`, `Seller`, `Agency`, `Advertiser`, `Trafficker`, `Salesperson`, `Publisher`, `Other`. Example: `Other`. * `typeCode` (_string_) Specifies the code of the persona if the persona type isn't specified. Example: `Example`. * `isCompany` (_boolean_) Indicates whether the persona is a company (true) or an individual (false). The default value is False. Allowed values: `True`, `False`. Default: `False`. Example: `True`. * `primary` (_boolean_) Indicates whether the persona is the primary persona responsible for a role (true) or not (false). The default value is False. Default: `False`. Example: `True`. * `officeCode` (_string_) Specifies the persona office code that applies to a salesperson. Example: `IND01`. * `sharePercent` (_string_) Specifies the percentage by which the revenue is divided among the salespeople. The sharePercent property is applicable for the Salesperson persona type. Example: `23`. * `additionalFields` (_object_) Specifies any additional attributes of the persona, which can be defined by using the additionalFields key value. Includes all fields of `KeyValuePair`. ### OrderHeader Specifies the details of the order, such as pricing specs and billing specs. * `agencies` (_array of object_) Specifies the details of the agencies involved in the order. _Example_ ``` [ { "id": "AGENCY100", "email": "agency@gmail.com", "name": "Sonyliv Agency", "role": "Manager", "type": "Agency", "typeCode": "", "isComapny": false, "primary": false, "officeCode": "US_SF_01", "sharePercent": "", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } ] ``` Includes all fields of `Persona`. * `salespeople` (_array of object_) Specifies the details of the salespeople involved in the order. A salesperson is a user related to the ad server. _Example_ ``` [ { "id": "98878", "email": "rd@gmail.com", "name": "John", "role": "Customer Success Manager", "type": "Salesperson", "typeCode": "", "isComapny": false, "primary": false, "officeCode": "US_SF_01", "sharePercent": "", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } ] ``` Includes all fields of `Persona`. * `traffickers` (_array of object_) Specifies the details of the traffickers involved in the order. _Example_ ``` [ { "id": "32312", "email": "james@gmail.com", "name": "James", "role": "Manager", "type": "Trafficker", "typeCode": "", "isComapny": false, "primary": false, "officeCode": "US_SF_01", "sharePercent": "", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } ] ``` Includes all fields of `Persona`. * `publisher` (_object_) Specifies the details of the publisher account. Includes all fields of `Persona`. _Example_ ``` { "id": "43321", "email": "publisher@gmail.com", "name": "Mossaic", "role": "Ads Publisher", "type": "Salesperson", "typeCode": "", "isComapny": false, "primary": false, "officeCode": "US_SF_02", "sharePercent": "", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } ``` * `otherPersonas` (_array of object_) Specifies the additional user entities involved in the order. Includes all fields of `Persona`. * `revenueSpecs` (_object_) Specifies the details related to the revenue of the order. Includes all fields of `RevenueSpecs`. * `billingSpecs` (_object_) Specifies the details related to the billing of the order. Includes all fields of `OrderBillingSpecs`. * `invoiceSpecs` (_object_) Specifies the details related to the invoice of the order. Includes all fields of `Invoicespecs`. * `purchaseOrderNumber` (_string_) Specifies the purchase order number of the order. * `publisherOrderName` (_string_) Specifies the order name of the publishers. Example: `01/2023 DEN`. * `orderStatus` (_string_) Specifies the status of the order. Example: `Approved`. * `orderType` (_string_) Specifies the deal type of the order. * `deliveryDetails` (_object_) Specifies the details related to the delivery of the order, such as clicks and impressions. Includes all fields of `DeliverySpecs`. * `tags` (_array of any_) Specifies the custom keywords or labels related to the order that can be used for search or other purposes. _Example_ ``` - "release-244" - "release-246" ``` * `totalBudget` (_object_) Specifies the overall budget allocated to the order. Includes all fields of `CurrencyInfo`. * `isProgrammatic` (_boolean_) Specifies the value that denotes if the order is of programmatic type. * `notes` (_string_) Specifies the additional notes or memo related to the order. * `additionalFields` (_object_) Specifies the additional metadata or custom details of the order header. Includes all fields of `KeyValuePair`. ### Campaign Specifies the campiagn to which the order belongs. * `campaignName` (_string_) Specifies the name of the campaign which will be created to create an insertion\_order. Example: `nike_campaign`. * `campaignId` (_string_) Specifies the id of the campaign which will be created on adserver to create an insertion\_order. Example: `234456677`. * `attributes` (_object_) Placeholder for internal configurations and additional parameters. Includes all fields of `KeyValuePair`. * `additionalFields` (_object_) Placeholder for external(Customoizations) configurations and additional parameters. Includes all fields of `KeyValuePair`. ### OrderHeaderResponse Specifies the details of the order, such as pricing specs and billing specs. * `agencies` (_array of object_) Specifies the details of the agencies involved in the order. _Example_ ``` [ { "id": "AGENCY100", "email": "agency@gmail.com", "name": "Sonyliv Agency", "role": "Manager", "type": "Agency", "typeCode": "", "isComapny": false, "primary": false, "officeCode": "US_SF_01", "sharePercent": "", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } ] ``` Includes all fields of `PersonaResponse`. * `salespeople` (_array of object_) Specifies the details of the salespeople involved in the order. A salesperson is a user related to the ad server. _Example_ ``` [ { "id": "98878", "email": "rd@gmail.com", "name": "John", "role": "Customer Success Manager", "type": "Salesperson", "typeCode": "", "isComapny": false, "primary": false, "officeCode": "US_SF_01", "sharePercent": "", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } ] ``` Includes all fields of `PersonaResponse`. * `traffickers` (_array of object_) Specifies the details of the traffickers involved in the order. _Example_ ``` [ { "id": "32312", "email": "james@gmail.com", "name": "James", "role": "Manager", "type": "Trafficker", "typeCode": "", "isComapny": false, "primary": false, "officeCode": "US_SF_01", "sharePercent": "", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } ] ``` Includes all fields of `PersonaResponse`. * `publisher` (_object_) Specifies the details of the publisher account. Includes all fields of `PersonaResponse`. _Example_ ``` { "id": "43321", "email": "publisher@gmail.com", "name": "Mossaic", "role": "Ads Publisher", "type": "Salesperson", "typeCode": "", "isComapny": false, "primary": false, "officeCode": "US_SF_02", "sharePercent": "", "additionalFields": { "additionField1": "additionField1", "additionField2": { "field1": "XXXXYY", "field2": "XXXXYY" } } } ``` * `otherPersonas` (_array of object_) Specifies the additional user entities involved in the order. Includes all fields of `PersonaResponse`. * `revenueSpecs` (_object_) Specifies the details related to the revenue of the order. Includes all fields of `RevenueSpecs`. * `billingSpecs` (_object_) Specifies the details related to the billing of the order. Includes all fields of `OrderBillingSpecs`. * `invoiceSpecs` (_object_) Specifies the details related to the invoice of the order. Includes all fields of `Invoicespecs`. * `purchaseOrderNumber` (_string_) Specifies the purchase order number of the order. * `publisherOrderName` (_string_) Specifies the order name of the publishers. Example: `01/2023 DEN`. * `orderStatus` (_string_) Specifies the status of the order. Example: `Approved`. * `orderType` (_string_) Specifies the deal type of the order. * `deliveryDetails` (_object_) Specifies the details related to the delivery of the order, such as clicks and impressions. Includes all fields of `DeliverySpecs`. * `tags` (_array of any_) Specifies the custom keywords or labels related to the order that can be used for search or other purposes. _Example_ ``` - "release-244" - "release-246" ``` * `totalBudget` (_object_) Specifies the overall budget allocated to the order. Includes all fields of `CurrencyInfo`. * `isProgrammatic` (_boolean_) Specifies the value that denotes if the order is of programmatic type. * `notes` (_string_) Specifies the additional notes or memo related to the order. * `additionalFields` (_object_) Specifies the additional metadata or custom information of the order header. Includes all fields of `KeyValuePair`. ### AdSpaceSpecification Specifies the details of the ad space spec or ad unit corresponding to the line item. * `adServerAdUnitId` (_string_, required) Specifies the unique identifier of the ad space spec. Daypart for xglinear, can be AdSpaceSpec Name. Format for xglinear is startTime-endTime, for others its adunit id. Example: `22214043670`. * `adServerAdUnitCode` (_string_) Specifies the unique identifier of the ad space spec. Example: `22214043670`. * `creatives` (_array of object_, required) Specifies the list of ad creatives related to the ad space spec. Includes all fields of `AdCreatives`. * `isIncluded` (_boolean_) Specifies the AdSpaceSpecification is included or not Default: `true`. * `isGroup` (_boolean_) Specifies the AdSpaceSpecification is grouped or not Default: `false`. * `additionalFields` (_object_) Provides any additional input fields. Includes all fields of `KeyValuePair`. ### Targeting Specifies the targeting details, such as geotargeting and daypart targeting methods. * `geoTargeting` (_array of object_) Specifies the targeting specs for the geographic area. Includes all fields of `TargetSegmentItem`. * `dayPartTargeting` (_array of object_) Specifies the targeting specs for the part of the day. Includes all fields of `TargetSegmentItem`. * `others` (_array of object_) Specifies the other targeting specs. Includes all fields of `CustomTargetingDefinition`. * `legacyExpression` (_string_) Specifies a string expression describing the relations between various audience segments. Example: `AND`. * `contentTargeting` (_object_) Specifies the content targets linked with the lineitem. The OOTB content types supported are Video, Display, Audio Includes all fields of `ContentTargeting`. * `additionalFields` (_object_) Provides any additional inputs. Includes all fields of `KeyValuePair`. ### FrequencyCaps Specifies the frequency caps on the units for the line item. * `maxImpressions` (_integer_) Specifies the maximum number of impressions for the line item. Example: `1000`. * `numTimeUnits` (_integer_) Specifies the maximum number of time units for the line item. Example: `5`. * `timeUnit` (_string_) Specifies the type of the time unit as provided by the numTimeUnits property. Allowed values: `Minute`, `Hour`, `Day`, `Week`, `Month`, `Lifetime`. Example: `Hour`. * `additionalFields` (_object_) Provides any additional inputs. Includes all fields of `KeyValuePair`. ### PricingSpecs Specifies the pricing specifications of the line item. * `costPerUnit` (_object_, required) Specifies the cost of one ad space specification. Includes all fields of `CurrencyInfo`. * `valueCostPerUnit` (_object_) Optional. Required only for GAM. Includes all fields of `CurrencyInfo`. * `costType` (_string_, required) Specifies the type of the cost, such as cost per click and cost per impression. Example: `CPM`. * `discountType` (_string_) Specifies the type of the discount as specified by the discount field. A discountType percentage value of 15 means the discount provided is 15%. Allowed values: `Absolute`, `Percentage`. Example: `Percentage`. * `discount` (_number_) Specifies the value of the discount. Example: `15`. * `mediaChannelRate` (_array of object_) Specifies the list of the rates based on the media channel and region. Includes all fields of `MediaChannelRate`. * `totalCost` (_object_, required) Specifies the total cost of the line item based on the total requested units. Includes all fields of `CurrencyInfo`. * `additionalFields` (_object_) Provides any additional inputs. Includes all fields of `KeyValuePair`. ### OrderLineBillingSpecs Specifies the billing specifications of the line item. * `billingModeType` (_string_) Specifies the billing mode of the line item. Allowed values: `Threshold`, `Fractional`, `Retail`, `Other`. Example: `Threshold`. * `billingModeTypeCode` (_string_) Specifies the billing mode of the line item if the type is "Others". Example: `Usage`. * `additionalFields` (_object_) Provides any additional inputs. Includes all fields of `KeyValuePair`. ### Goal Specifies the goals related to the line item. * `goalType` (_string_, required) Specifies the goal type of the line item. Allowed values: `Lifetime`, `Daily`, `Other`. Example: `Daily`. * `goalTypeCode` (_string_) Specifies the code of the goal type of the line item if the type is "Others". Example: `Weekly`. * `goalUnitType` (_string_, required) Specifies the unit type of the goals for the line item. Allowed values: `Impression`, `Click`, `Other`. Example: `Click`. * `goalUnitTypeCode` (_string_) Specifies the code of the unit type if the unit type is "Others". Example: `Action`. * `goalUnits` (_integer_, required) Specifies the count of the units as specified by the unitType property. Example: `2000`. * `primary` (_boolean_) Indicates whether the goal is primary (true) or not (false). The default value is false. Example: `True`. * `additionalFields` (_object_) Provides any additional inputs. Includes all fields of `KeyValuePair`. ### LineItemQuantity Represents the quantity details. * `totalQuantity` (_integer_, required) Specifies the number of the line items to add. Example: `12`. * `quantityBreakdownByDay` (_object_) Specifies the breakdown of the quantity of the line items over the days of week. Includes all fields of `KeyValuePair`. * `totalQuantityPeriodType` (_string_) Specifies the total line item quantity for a monthly or weekly period. Example: `weekly`. * `totalQuantityType` (_string_) Specifies the daily or weekly line item quantity. Example: `impressions`. * `additionalFields` (_object_) Provides any additional inputs. Includes all fields of `KeyValuePair`. ### RevenueSpecs List of the salespeople and the respective sales offices associated with the order. * `revenueTypecode` (_string_) Specifies the code of the revenue type. Example: `PRORATE`. * `additionalFields` (_object_) Provides any additional inputs. Includes all fields of `KeyValuePair`. ### DateTimeRange Specifies the date and time range. * `fromDate` (_datetime-only_) Specifies the start date of the order. Example: `2023-07-01T00:00:00`. * `toDate` (_datetime-only_) Specifies the start date of the order. Example: `2023-10-01T00:00:00`. ### UpdateAdSpaceSpecification Specifies the details of the ad space spec or ad unit corresponding to the line item. * `adServerAdUnitId` (_string_) Specifies the unique identifier of the ad space spec. Daypart for xglinear, can be AdSpaceSpec Name. Format for xglinear is startTime-endTime, for others its adunit id. Example: `00:00-23:59`. * `adServerAdUnitCode` (_string_) Specifies the unique identifier of the ad space spec. Example: `22214043670`. * `creatives` (_array of object_) Specifies the list of ad creatives related to the ad space spec. Includes all fields of `AdCreativesResponse`. * `isIncluded` (_boolean_) Specifies the AdSpaceSpecification is included or not Default: `true`. * `isGroup` (_boolean_) Specifies the AdSpaceSpecification is grouped or not Default: `false`. * `additionalFields` (_object_) Provides any additional input fields. Includes all fields of `KeyValuePair`. ### UpdatePricingSpecs Specifies the pricing specifications of the line item. * `costPerUnit` (_object_) Specifies the cost of one ad space specification. Includes all fields of `CurrencyInfo`. * `valueCostPerUnit` (_object_) Optiona. Required only for GAM. Includes all fields of `CurrencyInfo`. * `costType` (_string_) Specifies the type of the cost, such as cost per click and cost per impression. Example: `CPM`. * `discountType` (_string_) Specifies the type of the discount as specified by the discount field. A discountType percentage value of 15 means the discount provided is 15%. Allowed values: `Absolute`, `Percentage`. Example: `Percentage`. * `discount` (_number_) Specifies the value of the discount. Example: `15`. * `mediaChannelRate` (_array of object_) Specifies the list of the rates based on the media channel and region. Includes all fields of `MediaChannelRate`. * `totalCost` (_CurrencyInfo | number_) Specifies the total cost of the line item based on the total requested units. One of: `CurrencyInfo`, `number`. * `additionalFields` (_object_) Provides any additional inputs. Includes all fields of `KeyValuePair`. ### OtherUnits Specifies a key-value pair map. * `additionField1` (_integer_) Specifies the additionField1 property value. The field name can be as required. Example: `1000`. ### TimeWindowBreakDown * `start` (_datetime_) Specifies the start date and time of the window. Example: `2016-02-28T16:41:41.090Z`. * `end` (_datetime_) Specifies the end date and time of the window. Example: `2016-02-28T16:41:41.090Z`. * `availableUnits` (_integer_) Specifies the number of units available for the window. Example: `100`. * `totalUnits` (_integer_) Specifies the total units or capacity the ad server has on the requested date or date range. Example: `1000`. * `otherUnits` (_object_) Specifies any other unit data to pass. Includes all fields of `OtherUnits`. ### TargetingBreakDown * `categoryType` (_string_) For geotargeting and daypart targeting methods, the category name is assigned as GeoTargeting or DayPartTargeting. For other methods, the category name is the value of the mentioned category name. Allowed values: `GEO`, `DAYPART`, `OTHER`. Example: `GEO`. * `categoryName` (_string_) Category name applies when the category type is "other". Example: `Daypart`. * `availableUnits` (_integer_) Specifies the units available for an ad space or ad unit. Example: `1`. ### ContentingItemBreakdown * `lineitemid` (_integer_) Specifies the identifier of the contending line item. Example: `221312`. * `availableUnits` (_integer_) Specifies the number of units available for the line item. Example: `100`. ### OrderBillingSpecs Specifies the billing specifications of the order. * `billingCycleType` (_string_) Specifies the billing cycle of the order. Allowed values: `Broadcast`, `EndOfFlight`, `Calendar`, `Other`. Example: `Broadcast`. * `billingCycleTypeCode` (_string_) Specifies the unique code of the billing cycle of the order if the type isn't specified by the billingCycleType property. Example: `QRTR`. * `billingMode` (_string_) Specifies the billing mode of the order. Example: `Fractional`. * `additionalFields` (_object_) Provides any additional inputs. Includes all fields of `KeyValuePair`. ### Invoicespecs Specifies the invoice specifications of the order. * `invoiceType` (_string_) Specifies the invoice type of the order. Allowed values: `PDF`, `EDI`, `Other`. Example: `PDF`. * `invoiceTypeCode` (_string_) Specifies the invoice type of the order if the invoiceType is "Others". Example: `XLS`. * `EDIProductCode` (_string_) Specifies the product code of the invoice if the invoice type is EDI. * `EDIOrder` (_string_) Specifies the order if the invoice type is EDI. * `EDIClientCode` (_string_) Specifies the client code if the invoice type is EDI. * `additionalFields` (_object_) Provides any additional inputs. Includes all fields of `KeyValuePair`. ### DeliverySpecs Specifies the delivery specifications of the order. * `totalImpressionsDelivered` (_integer_) Specifies the total impressions delivered for the order. Example: `20000`. * `totalClicksDelivered` (_integer_) Specifies the total clicks delivered in the order. Example: `200`. * `totalViewableImpressionsDelivered` (_integer_) Specifies the total viewable impressions delivered for the order. Example: `200`. * `additionalFields` (_object_) Provides any additional inputs. Includes all fields of `KeyValuePair`. ### CurrencyInfo Specifies the detail about a currency field used in the request payload. * `value` (_number_) Specifies the value of the currency field. Example: `100`. * `currencyCode` (_string_) Specifies the code of the currency field. Example: `USD`. * `currencyName` (_string_) Specifies the name of the currency as defined by the currencyCode property. Example: `United States Dollar`. ### PersonaResponse * `Id` (_string_) Specifies the ID of the persona, which can be an individual account or a company. Example: `APIXXXXXX`. * `email` (_string_) Specifies the email ID of the persona. Example: `rd@yahoo.com`. * `name` (_string_) Specifies the name of the persona. Example: `Ritendra`. * `role` (_string_) Specifies the role of the persona. Example: `Salesperson`. * `type` (_string_) Specifies a persona type, such as an advertiser or a salesperson. Valid values are Agency, Advertiser, Trafficker, Salesperson, and Other. Allowed values: `Agency`, `Advertiser`, `Trafficker`, `Salesperson`, `Other`. Example: `Other`. * `typeCode` (_string_) Specifies the code of the persona if the persona type isn't specified. Example: `Example`. * `isCompany` (_boolean_) Indicates whether the persona is a company (true) or an individual (false). The default value is False. Allowed values: `True`, `False`. Default: `False`. Example: `True`. * `primary` (_boolean_) Indicates whether the persona is the primary persona responsible for a role (true) or not (false). The default value is False. Default: `False`. Example: `True`. * `officeCode` (_string_) Specifies the persona office code that applies to a salesperson. Example: `IND01`. * `sharePercent` (_string_) Specifies the percentage by which the revenue is divided among the salespeople. The sharePercent property is applicable for the Salesperson persona type. Example: `23`. * `additionalFields` (_object_) Specifies any additional attributes of the persona, which can be defined by using the additionalFields key value. Includes all fields of `KeyValuePair`. ### AdCreatives Specifies the details of the ad creative. * `height` (_string_) Specifies the height of the ad creative. Example: `970`. * `width` (_string_) Specifies the width of the ad creative. Example: `70`. * `adServerCreativeId` (_string_, required) Specifies the unique identifier of the ad creative. Example: `283718`. * `adServerCreativeRunTime` (_string_) Specifies the runtime of the ad creative. Example: `400`. * `adServerCreativeType` (_string_) Specifies the type of the ad creative. Example: `Bookend`. * `additionalFields` (_object_) Provides any additional inputs. Includes all fields of `KeyValuePair`. * `adCreativeUOM` (_string_) Specifies the unit of measure for the ad creative. Example: `Pixels`. * `companions` (_array of CreativeDetails_) Specifies the list of companion creatives associated with a primary ad creative. * `attributes` (_object_) Specifies the placeholder for the internal configurations and additional parameters. Includes all fields of `KeyValuePair`. ### TargetSegmentItem Specifies the details of a targeting segment. * `segmentCode` (_string_) Specifies the segment code. Example: `SlotType`. * `segmentName` (_string_) Specifies the segment name. Example: `SlotType`. * `segmentValues` (_array of object_) Specifies the values of the targeting segment that contains the list of the segment keys and its corresponding targeting value. Includes all fields of `SegmentValue`. ### CustomTargetingDefinition Specifies the custom targeting information other than daypart or geographic targeting methods. * `targetingSegmentDefinition` (_array of object_) Specifies the list of the targeting segments related to a category. Includes all fields of `TargetSegmentItem`. * `categoryCode` (_string_) Specifies the code of the category. This code can be unique identifier for a custom targeting information. Example: `Audience`. * `categoryName` (_string_) Specifies the name of the targeting category. Example: `Audience Segment`. ### ContentTargeting Specifies the content targeting for a line item. * `contents` (_array of object_) The list of content. Includes all fields of `Content`. * `attributes` (_object_) The placeholder for internal configurations and additional parameters. Includes all fields of `KeyValuePair`. * `additionalFields` (_object_) The placeholder for external configurations and additional parameters. Includes all fields of `KeyValuePair`. ### MediaChannelRate Specifies the rate of a specific channel or region. * `channelCode` (_string_) Specifies the code of the media channel. Example: `SONY`. * `regionCode` (_string_) Specifies the code of the region. Example: `NYC`. * `lineRate` (_object_) Specifies the rate of the line item respective to the channel or region. Includes all fields of `CurrencyInfo`. ### AdCreativesResponse Specifies the details of the ad creative. * `height` (_string_) Specifies the height of the ad creative. Example: `970`. * `width` (_string_) Specifies the width of the ad creative. Example: `70`. * `adServerCreativeId` (_string_) Specifies the unique identifier of the ad creative. Example: `283718`. * `adServerCreativeRunTime` (_string_) Specifies the runtime of the ad creative. Example: `400`. * `adServerCreativeType` (_string_) Specifies the type of the ad creative. Example: `Bookend`. * `additionalFields` (_object_) Provides any additional inputs. Includes all fields of `KeyValuePair`. ### CreativeDetails Specifies the details of the ad creative. * `height` (_string_) Specifies the height of the ad creative. Example: `970`. * `width` (_string_) Specifies the width of the ad creative. Example: `70`. * `adServerCreativeId` (_string_) Specifies the unique identifier of the ad creative. Example: `283718`. * `adServerCreativeRunTime` (_string_) Specifies the runtime of the ad creative. Example: `400`. * `adServerCreativeType` (_string_) Specifies the type of the ad creative. Example: `Bookend`. * `adCreativeUOM` (_string_) Specifies the unit of measure for the ad creative. Example: `Pixels`. * `attributes` (_object_) Specifies the placeholder for the internal configurations and additional parameters. Includes all fields of `KeyValuePair`. * `additionalFields` (_object_) Specifies the placeholder for the external (Customizations) configurations and additional parameters. Includes all fields of `KeyValuePair`. ### SegmentValue Specifies a Segment Value. * `additionField1` (_any_) Specifies the additionField1 property value. _Example_ ``` additionField_1_Value ``` * `isIncluded` (_boolean_) Specifies the additionalField1 is included or not Default: `true`. ### Content Specifies the details of a single content node. * `id` (_string_, required) The unique identifier of the content. * `type` (_string_) The type of content. Allowed values: `Video`, `Other`. * `typeCode` (_string_) The code that must be specified if the content type selected is Other. * `exclude` (_integer_) Indicates whether to exclude the content for targeting or not.