New Beacon
POST {{campaign_url}}/advertisers/:advertiserId/beacons
Create a new beacon
You can create a new beacon by sending this POST request. To define settings for your beacon, open the body tab and edit the JSON object.
For DTO fields location and viewAssociationWindow, see the corresponding DTO tables below to customize the data.
Request Body (Definitions)
*Optional element
| JSON Object Key | Description | Type |
|---|---|---|
| name | Name of this IO. | string |
| beaconPlacement | Placement or type of beacon. Allowed values | string |
| workflowStatus | Workflow status of this beacon. Allowed values: approved, archived | string |
| dataProvider (Only required if beaconPlacement is offlineFootTraffic) | Data provider for this beacon. Allowed values: ODC, IRI, CUEBIQ, WSI | string |
| location (DTO) (Only required if beaconPlacement is offlineFootTraffic) | Location-based tracking information for this beacon. | DTO |
| pageProtocol | Page protocol used by the website on which this beacon will be placed. Allowed values: http, https | string |
| acceptedAction | Action(s) that this beacon will credit for conversion. Allowed values: click, clickAndView | string |
| clickAssociationWindow | Number of days a click-through can be associated with an action. | long |
| viewAssociationWindow (DTO) | Length of time a view can be associated with an action. | DTO |
| actionCap | Number of actions (i.e., clicks, views) that can be tracked and reported for a unique user. Exclude this field to set an unlimited action cap. | long |
| includeShoppingCartValue | Indicates if this beacon should pass shopping cart values whenever it fires. | boolean |
| *tatCategory | IAB-defined industry/interest category associated with your beacon. Allowed values | string |
| *trackingMethod | Tracking method used to monitor activity for the website on which this beacon is placed. Allowed values: alwaysFires, dynamicFlip, reporting, serverSide, atlas, dclk, other | string |
| isMobileActionTrackingEnabled | Indicates if this beacon should track mobile actions. | boolean |
| *thirdPartyRedirectUrl | Third-party URL used for the beacon redirect. Cannot be defined when thirdPartyRedirectHtml is defined. Not allowed when isMobileActionTrackingEnabled is true. | string |
| *thirdPartyRedirectHtml | Third-party HTML used for the beacon redirect. Cannot be defined when thirdPartyRedirectUrl is defined. Not allowed when isMobileActionTrackingEnabled is true. | string |
| isBeaconValidated | Indicates if this beacon is validated. | boolean |
| enableUserConsent | Indicates if this beacon supports the IAB transparency and consent framework. | boolean |
| gdprConsent | Indicates if this beacon supports GDPR regulations. | boolean |
| ccpaConsent | Indicates if this beacon supports CCPA regulations. | boolean |
location DTO
| Key | Description | Type |
|---|---|---|
| placeCategories | Keywords associated with a place (e.g., services/goods offered). | comma-separated array of strings |
| placeNames | Can be retrieved from GET List of Places. | comma-separated array of strings |
| addresses | Can be retrieved from GET List of Addresses. | comma-separated array of strings |
viewAssociationWindow DTO
| Key | Description | Type |
|---|---|---|
| period | Number of minutes/hours/days a view can be associated with an action. | long |
| periodUnits | Unit of time used to define view association window. Allowed values: minutes, hours, days | string |
Request Body
{"name"=>"doc test beacon", "beaconPlacement"=>"homepage", "workflowStatus"=>"approved", "dataProvider"=>"IRI", "location"=>{"placeCategories"=>["HAIRSTYLE", "CHEVROLET"], "placeNames"=>["Teschi", "Davidson-Gebhardt"], "addresses"=>["1845 Clinton Street # A, Buffalo", "3880 Test Drive, Loveland"]}, "pageProtocol"=>"https", "acceptedAction"=>"click", "clickAssociationWindow"=>30, "viewAssociationWindow"=>{"period"=>1, "periodUnits"=>"days"}, "actionCap"=>50, "includeShoppingCartValue"=>true, "tatCategory"=>"apparel_customClothing_general", "trackingMethod"=>"atlas", "isMobileActionTrackingEnabled"=>false, "thirdPartyRedirectUrl"=>"https://amobee.com", "isBeaconValidated"=>true, "enableUserConsent"=>false, "gdprConsent"=>false, "ccpaConsent"=>false}
RESPONSES
status: Created
{"data":[{"id":"1608792593","marketId":"1","resourceType":"beacon","advertiserId":"1608792487","createdAt":"2022-09-01T05:53:30Z","updatedAt":"2022-09-01T05:53:30Z","isMobileActionTrackingEnabled":false,"beaconPlacement":"homepage","name":"doc test beacon","workflowStatus":"approved","acceptedAction":"click","clickAssociationWindow":30,"viewAssociationWindow":{"period":1,"periodUnits":"days"},"actionCap":50,"includeShoppingCartValue":true,"tatCategory":"apparel_customClothing_general","trackingMethod":"atlas","thirdPartyRedirectUrl":"https://amobee.com","isBeaconValidated":true,"pageProtocol":"https","beaconJavascriptCode":"\u003c!-- Do Not Remove - Turn Tracking Beacon Code - Do Not Remove --\u003e\n\u003c!-- Advertiser Name : doc team test --\u003e\n\u003c!-- Beacon Name : doc test beacon --\u003e\n\u003c!-- If Beacon is placed on a Transaction or Lead Generation based page, please populate the turn_client_track_id with your order/confirmation ID --\u003e\n\u003cscript type=\"text/javascript\"\u003e\n turn_beacon_price = \"\";\n turn_client_track_id = \"\";\n\u003c/script\u003e\n\u003cscript type=\"text/javascript\" src=\"https://r.turn.com/server/beacon_call.js?b2=q1lyPA9wmgRbHqiTxRK2wD2uK-54VhSLAM4xS4qlX0h0IUrafYkwxdeRLaMC74lrvLdySmYLErpRHiv5AM7VCw\"\u003e\n\u003c/script\u003e\n\u003cnoscript\u003e\n \u003cimg border=\"0\" src=\"https://r.turn.com/r/beacon?b2=q1lyPA9wmgRbHqiTxRK2wD2uK-54VhSLAM4xS4qlX0h0IUrafYkwxdeRLaMC74lrvLdySmYLErpRHiv5AM7VCw\u0026cid=\u0026bprice=\"\u003e\n\u003c/noscript\u003e\n\u003c!-- End Turn Tracking Beacon Code Do Not Remove --\u003e","gdprConsent":false,"ccpaConsent":false,"beaconImageCode":"\u003cimg border=\"0\" src=\"https://r.turn.com/r/beacon?b2=q1lyPA9wmgRbHqiTxRK2wD2uK-54VhSLAM4xS4qlX0h0IUrafYkwxdeRLaMC74lrvLdySmYLErpRHiv5AM7VCw\u0026cid=\u0026bprice=\"\u003e"}],"errors":[]}