CityGrid Advertising APIs
Places Management API
Introduction
The CityGrid Places Management API is part of the Advertising by CityGrid suite of APIs which allows developers to retrieve, create and update places and the content associated with places.
Contents
Places Get Endpoint
The CityGrid Places Get API allows to retrieve information regarding places. Response formats include XML and JSON.
Please note that Get API will require https and is a V3 endpoint.
Request Parameters
Field | Type | Description | Required | Examples |
|---|---|---|---|---|
| Comma separated listing if String values | A list of External IDs to be resolved to places | Required if no place_ids are specified | 183765, |
| Comma-separated list of Long values | List of places IDs | Required as an alternate for external_place_id | 11790182,12314 |
Get Header values
Name | Values | Description |
|---|---|---|
Content-Type | Application/JSON | Return format. Content-Type and Accept must match |
Accept | Application/JSON | Return format. Content-Type and Accept must match |
authToken | Authentication Token from Places Management API | Required |
Request Example
Description | Endpoint |
|---|---|
Get Places by External Place IDs | api.citygridmedia.com/content/places/v3/get?external_place_ids=4320920_a,5320920_a |
Response Parameters
Field | Type | Description |
|---|---|---|
rval | Places Page | Place identified by the selector |
Places Page
Field | Description | Type |
|---|---|---|
place_id | The ID of the Place | Integer |
place | The Place | Place |
Place
Field | Parent Element | Description | Type | Notes |
|---|---|---|---|---|
external_place_id |
| External Place ID | String |
|
place_id |
| CGM business listing ID | Long |
|
primary_tag_id |
| Tag id for business' main category | Long |
|
secondary_tags |
| Secondary tags ids for business' main category | String | Comma separated tag values |
name |
| Name of the location | String |
|
address_1 |
| Storefront address | String |
|
address_2 |
| Delivery point | String |
|
city |
| City of the location | String |
|
state |
| State of the location | String |
|
postal_code |
| Postal Code of the location | Long |
|
phone_number |
| Phone number of the Location | String |
|
display_url |
| Displayed URL of the location | String |
|
website_url |
| Website URL of the location | String |
|
tagline |
| Tagline of the location | String |
|
menu_link |
| URL to a menu page | String |
|
reservation_link |
| URL to a reservation page | String |
|
owners_message |
| Message of the owner of the location | String |
|
bullet_1 |
| Advertorial bullet text | String |
|
bullet_2 |
| Advertorial bullet text | String |
|