...
The budget API allows publishers to discover what advertisers have budget available at a particular moment in time by making accessible a report, generated on demand of the advertisers and budgets available.
...
HTTP Endpoint
The following endpoint is used with HTTPS HTTP GET:
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
<ads> <ad> <listing_ids> <listing_id>1000004</listing_id> </listing_ids> <reference_id>11</reference_id> <net_ppe>0.55</net_ppe> <budget_remaining>100000.0</budget_remaining> <budget_allocation_id>267382</budget_allocation_id> <ppe>0.2</ppe> <remaining_budget>3.0311</remaining_budget> <budget_allocation_id>16369425</budget_allocation_id> <listings> <listing> <listing_id>838628150</listing_id> <listing_name>Mojo's Seafood & Chicken</listing_name> <reference_id>7</reference_id> <categories> <category>Catering</category> <category>Health Food</category> <category>Home Meal Delivery</category> <category>Restaurants</category> <category primary="true">Seafood Markets</category> </categories> <markets/> <neighborhoods/> <postal_codes> <postal_code>36542</postal_code> </postal_codes> <cities> <city>Gulf Shores</city> </cities> </listing> </listings> </ad> </ads> |
Connecting to the streaming Discovery API
Accessing this API requires keeping a persistent HTTPS connection HTTPÂ connection open. This involves thinking about your client application differently than if you are using a REST API. In other words, use this API as a separate process independent of user requests.
...
Obtaining Budget Available by Named Geographic Region
...
HTTP Endpoint
The following endpoint is used with HTTPS HTTP GET:
...
Obtaining Budget Available by Latitude and Longitude
...
HTTP Endpoint
The following endpoint is used with HTTPS HTTP GET:
...
Obtaining Budget Available by ID
...
HTTP Endpoint
The following endpoint is used with HTTPS HTTP POST or GET:
...
Usage | URL |
|---|---|
Return listings with budget for restaurants in 90069 | httpshttp://api.citygridmedia.com/ads/budget/v2/where?publisher=test&what=restaurants&where=90069 |
Return listings with budget for restaurants within 5 miles of the specified lat/lon location | |
Return the budget information for the specified Places | httpshttp://api.citygridmedia.com/ads/budget/v2/detail?publisher=test&ids=45654239,41783749,32636885 |
...