New LI (3 Level Campaign)

POST {{campaign_url}}/packages/:packageId/lineItems

Create a new line item (LI)

You can create a new line item for a three-level campaign (i.e., IO, package, LI hierarchy) by sending this POST request. To define settings for your LI, open the body tab and edit the JSON object.

See POST New LI (2 Level Campaign) for information on definitions and allowed values of all fields and DTOs.

Note: Availability/requirements of LI settings may change depending on settings configured at the package level. See the table below for package settings and corresponding LI requirements or recommendations.

Request Body

{"name"=>"irene - automated bid LI", "status"=>"play", "mediaFormat"=>"display", "environment"=>{"targetedTypes"=>["desktopWeb"], "excludeMobileAppWithoutDeviceId"=>false, "excludeNonOptimizedMobileWeb"=>false}, "impressionFrequency"=>{"personOrDeviceFrequencyCapDetails"=>{"cap"=>3, "period"=>5, "periodUnits"=>"days"}}, "iabCategory"=>"iab2-1", "budget"=>{"asapDelivery"=>false, "clientMargin"=>0, "hasDesignatedBudget"=>true, "pacing"=>"evenImpression", "pacingMultiplier"=>0, "schedules"=>[{"budget"=>30, "dailyCap"=>0, "startDate"=>"2022-09-27T13:41:30Z", "endDate"=>"2022-11-27T13:41:30Z", "impressionCap"=>2}]}, "bidding"=>{"dcpm"=>{"bidLimit"=>14, "maxAvgBid"=>7, "goals"=>{"primary"=>{"action"=>{"hardGoal"=>false, "maximizeActionRate"=>true, "optimizationWindowInDays"=>5, "prioritizePerformance"=>95}}, "secondary"=>{"viewability"=>{"hardGoal"=>false, "measurement"=>"mrc", "rate"=>50}}}}, "enableViewabilityMeasurement"=>false}, "beacons"=>[{"id"=>"{{beaconId}}", "cta"=>2, "vta"=>5}], "thirdPartyCosts"=>[{"costType"=>"other", "provider"=>"adFin", "cpmCost"=>0.1, "paidBy"=>"amobee"}], "inventory"=>{"exchangeIds"=>["37", "1"], "privatePublisherDeals"=>[{"cpmBid"=>10.0, "publisherDealId"=>"{{publisherDealId}}"}], "enableAutomaticDeals"=>false, "enablePublisherBidCpm"=>false}, "targeting"=>{"nielsenAudience"=>{"gender"=>"female", "ageRange"=>[18, 24], "optimizeDemographicTargeting"=>true, "targetGoal"=>64.0}, "technographic"=>{"browsers"=>["internetExplorer7", "firefox", "opera"], "connectivity"=>{"mediums"=>["cable", "corporate", "dialup", "other", "mobileCarrierNetwork"]}, "devices"=>{"crossDeviceTargeting"=>true, "deviceProfiles"=>[{"operatingSystem"=>{"osId"=>"-16"}}, {"operatingSystem"=>{"osId"=>"-10"}}]}}, "segmentSetIdentity"=>"household", "behavioralSegmentSetId"=>"1615161490", "retargetingIdentity"=>"household", "retargetingSegmentId"=>"{{retargetingSegmentId}}", "inventory"=>{"adVisibility"=>["aboveFold", "belowFold", "unknown"], "adsTxtAuthorizationStatus"=>["authorizedDirectInventory", "authorizedResellerInventory", "unmeasurableInventory"], "siteLists"=>{"includeInventoryListIds"=>["{{inventoryListId}}"]}, "contextualConceptSetId"=>"1614685131", "brandSafetyConceptSetId"=>"1626278188", "ipLists"=>{"includeIpListId"=>"21129872"}}, "locale"=>{"browserLanguages"=>["aa", "en", "tw", "kr"], "daypart"=>[{"day"=>"sunday", "hours"=>["am1", "am5", "pm3"]}, {"day"=>"tuesday", "hours"=>["pm3", "pm8"]}], "geographic"=>{"mobileRadius"=>{"country"=>"us", "entryType"=>"latLong", "entries"=>[{"latLong"=>{"latitude"=>18, "longitude"=>-39}}], "groups"=>["{{locationGroupId}}"], "radius"=>10, "radiusUnits"=>"miles"}}}}}

RESPONSES

status: Created

{"data":[{"id":"1608801242","marketId":"1","resourceType":"lineItem","status":"stopStartDate","advertiserId":"1608792487","insertionOrderId":"1608792488","packageId":"1608792594","mediaFormat":"display","createdAt":"2022-09-07T19:54:06Z","updatedAt":"2022-09-07T19:54:06Z","currency":"usd","name":"irene - automated bid LI","environment":{"targetedTypes":["desktopWeb"],"excludeNonOptimizedMobileWeb":false,"excludeMobileAppWithoutDeviceId":false},"iabCategory":"iab2-1","inventory":{"exchangeIds":["1","37"],"privatePublisherDeals":[{"publisherDealId":"1608799448"}],"dealGroups":[],"enabledAutomaticDeals":[]},"bidding":{"dcpm":{"maxAvgBid":7,"goals":{"primary":{"action":{"maximizeActionRate":true,"optimizationWindowInDays":5,"priortizePerformance":95,"prioritizePerformance":95}},"secondary":{"viewability":{"rate":50,"measurement":"mrc"}}},"bidLimit":14}},"beacons":[{"id":"1608792593","cta":2,"vta":5}],"budget":{"pacing":"evenImpression","schedules":[{"startDate":"2022-09-27T13:41:00Z","endDate":"2022-11-27T13:41:30Z","budget":30,"impressionCap":2}],"asapDelivery":false},"thirdPartyCosts":[{"costType":"other","provider":"adFin","cpmCost":0.1,"paidBy":"amobee"},{"costType":"obaCompliance","provider":"tRUSTe","cpmCost":0.015,"paidBy":"amobee"}],"impressionFrequency":{"personOrDeviceFrequencyCapDetails":{"cap":3,"period":5,"periodUnits":"days"}},"targeting":{"nielsenAudience":{"gender":"female","ageRange":[18,24],"targetGoal":64,"optimizeDemographicTargeting":true},"behavioralSegmentSetId":"1615161490","retargetingSegmentId":"2211421637","locale":{"geographic":{"mobileRadius":{"country":"US","entries":[{"latLong":{"latitude":18,"longitude":-39}}],"entryType":"latLong","radius":10,"radiusUnits":"miles","groups":["36400800"]}},"daypart":[{"day":"tuesday","hours":["pm3","pm8"]},{"day":"sunday","hours":["am1","pm3","am5"]}],"browserLanguages":["en-ie","en-us","tw","en-mp","en-il","en-in","en-mt","en-za","en-ms","en-ag","en-io","en-mu","en-ai","en-mw","en-vc","en-er","en-et","en-vg","en-na","en-vi","en-zm","en-as","en-au","en-ng","en-nf","aa","en-zw","en-vu","en-bb","en-be","en-jm","en-rw","en-fk","en-nr","en","en-fj","en-nu","en-fm","en-bm","en-bo","en-nz","en-bn","en-sb","en-bs","en-sc","en-sh","en-bw","en-sg","en-sl","en-bz","en-gb","en-ke","en-gd","en-so","en-ws","en-ki","en-ca","en-gh","en-kn","en-gi","en-sz","en-gm","en-ck","en-cm","aa-dj","en-tc","en-ky","en-gu","en-gy","en-lc","en-pg","en-tk","en-ph","en-pk","en-to","en-pn","en-tt","en-hk","en-pr","kr","en-ls","en-pw","en-lr","en-dm","en-ug","aa-er","en-um","en-mh","aa-et"]},"technographic":{"devices":{"deviceProfiles":[{"operatingSystem":{"osId":"-16"}},{"operatingSystem":{"osId":"-10"}}],"crossDeviceTargeting":true},"browsers":["opera","firefox","internetExplorer7"],"connectivity":{"mediums":["dialup","other","mobileCarrierNetwork","corporate","cable"],"includeIspIds":[]}},"inventory":{"contextualConceptSetId":"1614685131","brandSafetyConceptSetId":"1626278188","adVisibility":["belowFold","aboveFold","unknown"],"siteLists":{"includeInventoryListIds":["36402855"]},"ipLists":{"includeIpListId":"21129872"},"adsTxtAuthorizationStatus":["unmeasurableInventory","authorizedDirectInventory","authorizedResellerInventory"]},"segmentSetIdentity":"household","retargetingIdentity":"household"}}],"errors":[]}