Area Parameter Details

Geographic areas are defined within the areas object, which is a component of several different campaign-related API requests:

• Creating a Campaign Request: When programmatically creating a draft, the areas array is included in the body of the POST request to:

   

  https://api.dooh.one/api/v2/agency/<dsp_agency_id>/dsp/request/.

• Cost Estimation (Forecast): To get a cost estimate based on specific locations, the area parameters (formatted as <lon>x<lat>,<radius>,<action>) are passed as a query string in a GET request to:

   

  https://api.dooh.one/api/v2/agency/<dsp_agency_id>/dsp/device/stats/.

•  

  Updating a Campaign: Adjusting geographic targeting for an existing campaign is done by sending the updated areas object via a PATCH request to the specific request ID endpoint.

Area Parameter Structure

When used within these endpoints, each area entry in the array consists of the following fields:

•  

  title: Name of the area (e.g., "Moscow, Russia").

•  

  latitude: Float coordinate.

•  

  longitude: Float coordinate.

•  

  radius: Integer representing the distance in kilometers (default is 10).

•  

  action: Determines whether to include or exclude the specified zone.

This table defines the structure for geographic zones within the areas parameter.