# adProductId integer required The ad product ID. # accept string enum Defaults to application/json Generated from available response content types application/jsontext/plain Allowed: `application/json``text/plain` # `200 Normal response, containing a JSON object with the ad product, if it exists. object An ad product is a campaign template. It aggregates targeting sets (flight templates) for which a forecast is run. ## id integer Unique identifier of the ad product. ## name string Name of the ad product. ## description string \| null An optional description of the ad product. ## enabled boolean Whether the ad product is enabled. Only enabled ad products are considered when calculating results. ## targetingSets array of objects ### targetingSets object A targeting set is an object which contains all the fields in a flight that are relevant and supported in the forecast planner. #### adProductId integer The ID of the ad product the targeting set belongs to. #### id integer The ID of the targeting set. #### name string required The name of the targeting set. #### enabled boolean required Whether the targeting set is enabled. Only enabled targeting sets are considered when calculating and displaying results. #### priorityId integer \| null The ID of the priority. It is required when the targeting set is enabled. #### rate object \| null The rate at which the advertiser pays you. It is required when the targeting set is enabled. ##### rate object \| null ###### keywordTargeting string \| null Please head to [Keyword Logic](https://dev.kevel.com/docs/keyword-logic) for more details. ###### frequencyCap object \| null Configuration for limiting ad frequency to users. ####### Frequency Cap object \| null ###### siteZoneTargeting array of objects \| null ####### siteZoneTargeting Object 1 Object 2 ###### geoTargeting array of objects \| null ####### geoTargeting object Geographic targeting rules. Please head to [Geo Targeting](https://dev.kevel.com/reference/create-geo-targeting) for more details. **CountryCode** string required The two-character country code. **Region** string The two-character code for the state, region, or province. **MetroCode** string The metro code, such as ZIP code. **IsExclude** boolean Set to 'false' (default) to target; 'true' to exclude. ###### distanceTargeting array of objects \| null ####### distanceTargeting object Distance-based geographic targeting. Please head to [Distance Targeting](https://dev.kevel.com/reference/create-geodistance-targeting-geometry) for more details. **distance** number required The radius distance in kilometers. **latitude** number required The latitude of the center point. **longitude** number required The longitude of the center point. ###### customTargeting string \| null A string for custom targeting using the [Zerkel Language](https://dev.kevel.com/docs/zerkel-queries). ###### duplicateMode integer \| null enum When defined, enables no duplicates and defines the type of the duplicate mode: - _1_: Flight - _2_: Campaign - _3_: Advertiser - _4_: Creative `1``2``3``4` ###### adTypes The ad type IDs to use in forecasts. It is required if the targeting set is enabled. arraystring adTypes array of numbers ###### searchTerms array of objects \| null Search term targeting rules. Please head to [Search Term Targeting](https://dev.kevel.com/docs/search-term-targeting) for more details. ####### searchTerms object Search term targeting rule. Please head to [Search Term Targeting](https://dev.kevel.com/docs/search-term-targeting) for more details. **term** string required The search term to match against. **matchType** string enum required How `term` is matched against the ad request's search term. `broad``strict``exact` **isExclude** boolean Defaults to false Whether to exclude (`true`) or include (`false`) requests that match this rule. ###### bidModifiers array of objects \| null Bid modifiers to apply to the flight's effective price for matching ad requests. Please head to [Bid Modifiers](https://dev.kevel.com/docs/bid-modifiers) for more details. ####### bidModifiers object A bid modifier that adjusts a flight's effective price for ad requests matching the given conditions. Please head to [Bid Modifiers](https://dev.kevel.com/docs/bid-modifiers) for more details. **match** object required The match conditions for the bid modifier. ###### match object **price** number \| null Fixed effective price to use when this modifier applies. Takes precedence over `multiplier` when both are set. **multiplier** number \| null Factor applied to the flight's price when this modifier applies. Ignored if `price` is set. # `404 The entity doesn't exist. # curl --request GET \ # --url https://api.kevel.co/v1/forecaster/ad-products/adProductId \ # --header 'accept: application/json' { "id": 4512, "name": "Awesome ad product", "description": "This ad product is awesome and very cool.", "enabled": true, "targetingSets": [ { "name": "Awesome targeting set", "enabled": true, "priorityId": 221170, "rate": { "rateType": 1, "price": 100 }, "keywordTargeting": "keyword1,keyword2\nkeyword3\n!keyword1,keyword2", "frequencyCap": { "type": 2, "duration": 1, "value": 5 }, "siteZoneTargeting": [ null, null ], "geoTargeting": [ { "CountryCode": "US", "Region": "NY", "MetroCode": "10001", "IsExclude": true } ], "distanceTargeting": [ { "distance": 20, "latitude": 41.40338, "longitude": 2.17403 } ], "customTargeting": "[\"order_confirmation\"] contains screen", "duplicateMode": 1, "adTypes": [ 4649 ], "searchTerms": [ { "term": "running shoes", "matchType": "broad", "isExclude": false } ], "bidModifiers": [ { "match": { "Keyword": "string", "Site": 0, "Zone": 0, "Segment": 0, "SearchTerm": { "Term": "string" } }, "price": 7.5, "multiplier": 1.5 } ] } ] }