...
Info |
---|
If you are looking to display templatized, pre-rendered ads for mobile applications (native or web), see the Mobile Ads API. If you are interested in obtaining ad data which you then render on your own, see the Custom Ads API. |
Contents
Table of Contents | ||||||
---|---|---|---|---|---|---|
|
Obtaining Web Ads
To enable the display of ads, you must include the CityGrid loader script in the page:
...
To obtain the actual ad, invoke the CityGrid.Ads constructor with two arguments: the id
of the div
element that wraps the ad unit, and a JavaScript object that holds the ad parameters.
Code Block |
---|
<script type="text/javascript">
new CityGrid.Ads(containerDiv, callParameters);
</script>
|
The ad image will be rendered into your div
. The following example adds an ad to a div
with the id
of sidebar_ad_slot
, and ad parameters that specify an ad relevant for sushi and a given longitude and latitude:
Code Block |
---|
<div id="sidebar_ad_slot"></div>
<script type="text/javascript" src="http://static.citygridmedia.com/ads/scripts/v2/loader.js"></script>
<script type="text/javascript">
new CityGrid.Ads('sidebar_ad_slot', {
collection_id: 'web-001-630x100',
publisher: 'citysearch',
what: 'sushi',
where: '90069',
lat: 34.088188,
lon: -118.37205,
width: 630,
height: 100
});
</script>
|
...
Parameter | Description | Required | Valid Values | Examples |
---|---|---|---|---|
publisher | The publisher code that identifies you. This parameter is required so that we know who to credit. | Yes | Contact your account manager for your publisher code. | acme |
collection_id | Used for rotation or targeting. A publisher can have multiple collections and is required to pass one collection id per request. | Yes | A predefined id that holds template information. See Collection IDs for more information. | web-001-630x100 |
width | The width of the ad slot. | Yes | An integer in pixels. | 300 |
height | The height of the ad slot. | Yes | An integer in pixels. | 250 |
what | What a user is searching for. For multi-word searches, simply put a space between the words. | Yes |
| pizza |
where | The geographic location, generally a zip code or city-state pair. | Yes, if lat and lon are not provided. | A zip code, city-state pair, or street address. Spaces are optional following the comma between a city and state. | 91011 |
lat | Latitude of the center of a circle for a geographic search. | Yes, if where is not specified | A decimal between -90 and 90. | 37.65056 |
lon | Longitude of the center of a circle for a geographic search. | Yes, if where is not specified | A decimal between -180 and 180. | -119.03639 |
radius | Radius of a circle search, in miles. Defaults to 5. If radius is larger than 25, it will be clamped to 25. | Yes, if lat and lon are specified | An integer between 1 and 25, inclusive. | 2 |
raw_what | The original user search phrase if available. | No |
| italian food |
raw_where | The original user search phrase if available. | No |
| los%20angeles |
max | The maximum number of results to return. The default value is 10. Values over 10 will be clamped to 10. | No | Integers in the range 1 through 10. | 3 |
i | The impressionId that you obtained from a previous CityGrid API call. | No |
| 0007000008b8b6fd23eb3c463ab3fdcc5b04f6ad13 |
placement | An optional property for storing additional information you would like CityGrid Media to log for this view. | No |
| google |
client_ip | The IP address of your client. | No | IPv4 or IPv6 | 17.148.221.102 |
user_agent | The version of browser or device the ad is served on. | No |
| Mozilla%2F5.0+%28BlackBerry%3B+U%3B+BlackBerry+9800%3B |
mapping_url | Click-throughs are mapped to the specified URL. | No | See #Mapping URL for more information. |
|
...
The mapping url must have the following form:
Code Block | ||||
---|---|---|---|---|
| ||||
httphttps://<hostname>/<path>?impressionId=${adImpressionId}&referenceId=${refId}&listingId=${listingId}&cgRefId=${cgRefId} |
...
You may pass mapping_url just as any other javascript parameters in the ad call.
Code Block | ||||
---|---|---|---|---|
| ||||
<script type="text/javascript">
new CityGrid.Ads('sidebar_ad_slot', {
collection_id: 'web-001-630x100',
publisher: 'citysearch',
what: 'sushi',
where: '90069',
lat: 34.088188,
lon: -118.37205,
width: 630,
height: 100,
mapping_url: "http://www.citygrid.com/adredirect?impressionId=${adImpressionId}&referenceId=${refId}&listingId=${listingId}&cgRefId=${cgRefId}"
});
</script>
|
The click-through of any local ad listing results will then redirect users to the following url. Publishers can use this information to send users to pages of their choice.
Code Block |
---|
http://www.citygrid.com/adredirect?impressionId=00070000063e8cd424d9dd42eba9589c458a58b339&referenceId=1&listingId=47405288&cgRefId=bc1a153dc3354075bb73d948e2f51914
|
...
Errors are indicated in the HTTP HTTPS response as follows:
HTTP HTTPS Status Code | Type | Message | Description |
---|---|---|---|
403 | Status report | publisher is a required field. | Access is forbidden because of a missing publisher property. |
403 | Status report | collection_id is a required field. | Access is forbidden because of a missing collection_id property. |
403 | Status report | what is a required field. | Access is forbidden because of a missing what parameter. |
403 | Status report | either where or lat/lon is required. | Access is forbidden because of missing location information (where or lat and lon). |
403 | Status report | Invalid publisher parameter | Access is forbidden because of an invalid publisher property. |
403 | Status report | Invalid collection_id parameter | Access is forbidden because of an invalid collection_id property. |
...