Serialized Form


Package com.citygrid

Class com.citygrid.CGAddress extends Object implements Serializable

Serialized Fields

street

String street

city

String city

state

String state

zip

String zip

Class com.citygrid.CGBaseReview extends Object implements Serializable

Serialized Fields

reviewId

String reviewId

url

URI url

title

String title

author

String author

text

String text

pros

String pros

cons

String cons

date

Date date

rating

int rating

helpful

int helpful

unhelpful

int unhelpful

attributionText

String attributionText

attributionLogo

URI attributionLogo

attributionSource

int attributionSource

Class com.citygrid.CGException extends Exception implements Serializable

Serialized Fields

errors

CGError[] errors

Class com.citygrid.CGHistogram extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

name

String name

items

CGHistogramItem[] items

Class com.citygrid.CGHistogramItem extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

name

String name

count

int count

uri

URI uri

tagIds

String[] tagIds

Class com.citygrid.CGLatLon extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

latitude

double latitude

longitude

double longitude

Class com.citygrid.CGRegion extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

type

String type

name

String name

latlon

CGLatLon latlon

radius

float radius

Class com.citygrid.CGShared extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

publisher

String publisher

placement

String placement

connectTimeout

int connectTimeout

readTimeout

int readTimeout

baseUrl

String baseUrl

debug

boolean debug

simulation

boolean simulation

muid

String muid

mobileType

String mobileType

Class com.citygrid.CGTag extends Object implements Serializable

serialVersionUID: 1L

Serialized Fields

id

int id

name

String name

Package com.citygrid.ads.custom

Class com.citygrid.ads.custom.CGAdsCustom extends Object implements Serializable

Serialized Fields

publisher

String publisher

ua

String ua

serveUrl

String serveUrl

rawWhat

String rawWhat

rawWhere

String rawWhere

what

String what

where

String where

max

int max

placement

String placement

impressionId

String impressionId

latlon

CGLatLon latlon

radius

float radius

connectTimeout

int connectTimeout

readTimeout

int readTimeout

Class com.citygrid.ads.custom.CGAdsCustomAd extends Object implements Serializable

Serialized Fields

baseLocation

CGBaseLocation baseLocation

adId

int adId

type

String type

tagline

String tagline

businessDescription

String businessDescription

destinationUrl

URI destinationUrl

displayUrl

URI displayUrl

ppe

float ppe

reviews

int reviews

offers

String offers

distance

float distance

attributionText

String attributionText

Class com.citygrid.ads.custom.CGAdsCustomResults extends Object implements Serializable

Serialized Fields

ads

CGAdsCustomAd[] ads

Package com.citygrid.ads.mobile

Class com.citygrid.ads.mobile.CGAdsMobile extends Object implements Serializable

Serialized Fields

publisher

String publisher

collection

CGAdsMobileCollection collection

ua

String ua

rawWhat

String rawWhat

rawWhere

String rawWhere

what

String what

where

String where

latlon

CGLatLon latlon

radius

float radius

max

int max

placement

String placement

impressionId

String impressionId

size

CGSize size

connectTimeout

int connectTimeout

readTimeout

int readTimeout

muid

String muid

Class com.citygrid.ads.mobile.CGAdsMobileResults extends Object implements Serializable

Serialized Fields

ads

CGAdsMobileAd[] ads

Package com.citygrid.ads.tracker

Class com.citygrid.ads.tracker.CGAdsTracker extends Object implements Serializable

Serialized Fields

publisher

String publisher

actionTarget

CGAdsTrackerActionTarget actionTarget

locationId

int locationId

referenceId

int referenceId

impressionId

String impressionId

placement

String placement

sourcePhone

String sourcePhone

dialPhone

String dialPhone

connectTimeout

int connectTimeout

readTimeout

int readTimeout

muid

String muid

mobileType

String mobileType

Package com.citygrid.content.offers

Class com.citygrid.content.offers.CGOffersLocation extends Object implements Serializable

Serialized Fields

baseLocation

CGBaseLocation baseLocation

businessHours

String businessHours

tags

CGTag[] tags

Package com.citygrid.content.offers.detail

Class com.citygrid.content.offers.detail.CGOffersDetail extends Object implements Serializable

Serialized Fields

publisher

String publisher

offerId

String offerId

locationId

int locationId

impressionId

String impressionId

placement

String placement

connectTimeout

int connectTimeout

readTimeout

int readTimeout

Package com.citygrid.content.offers.search

Class com.citygrid.content.offers.search.CGOffersSearch extends Object implements Serializable

Serialized Fields

publisher

String publisher

type

CGOffersType type

what

String what

tag

int tag

where

String where

tagOperation

CGOffersSearchTagOperation tagOperation

excludeTag

int excludeTag

page

int page

resultsPerPage

int resultsPerPage

startDate

Date startDate

expiresBefore

Date expiresBefore

hasBudget

boolean hasBudget

sort

CGOffersSearchSort sort

source

String source

popularity

int popularity

histograms

boolean histograms

placement

String placement

impressionId

String impressionId

latlon

CGLatLon latlon

latlon2

CGLatLon latlon2

radius

float radius

connectTimeout

int connectTimeout

readTimeout

int readTimeout

Package com.citygrid.content.places.detail

Class com.citygrid.content.places.detail.CGPlacesDetail extends Object implements Serializable

Serialized Fields

publisher

String publisher

locationId

int locationId

infoUsaId

int infoUsaId

phone

String phone

customerOnly

boolean customerOnly

allResults

boolean allResults

reviewCount

int reviewCount

placement

String placement

connectTimeout

int connectTimeout

readTimeout

int readTimeout

impressionId

String impressionId

publicId

String publicId

Class com.citygrid.content.places.detail.CGPlacesDetailAddress extends CGAddress implements Serializable

Serialized Fields

deliveryPoint

String deliveryPoint

crossStreet

String crossStreet

Class com.citygrid.content.places.detail.CGPlacesDetailAttribute extends Object implements Serializable

Serialized Fields

attributeId

int attributeId

name

String name

value

String value

Class com.citygrid.content.places.detail.CGPlacesDetailCategory extends Object implements Serializable

Serialized Fields

categoryId

int categoryId

name

String name

parentId

int parentId

parent

String parent

groups

CGPlacesDetailGroup[] groups

Class com.citygrid.content.places.detail.CGPlacesDetailCustomerContent extends Object implements Serializable

Serialized Fields

message

CGPlacesDetailCustomerMessage message

bullets

String[] bullets

url

URI url

Class com.citygrid.content.places.detail.CGPlacesDetailCustomerMessage extends Object implements Serializable

Serialized Fields

message

String message

attributionText

String attributionText

attributionLogo

URI attributionLogo

attributionSource

String attributionSource

Class com.citygrid.content.places.detail.CGPlacesDetailEditorial extends Object implements Serializable

Serialized Fields

editorialId

String editorialId

url

URI url

title

String title

author

String author

review

String review

pros

String pros

cons

String cons

date

Date date

reviewRating

int reviewRating

helpfulnessTotal

int helpfulnessTotal

helpfulness

int helpfulness

unhelpfulness

int unhelpfulness

attributionText

String attributionText

attributionLogo

URI attributionLogo

attributionSource

int attributionSource

Class com.citygrid.content.places.detail.CGPlacesDetailGroup extends Object implements Serializable

Serialized Fields

groupId

int groupId

name

String name

Class com.citygrid.content.places.detail.CGPlacesDetailImage extends Object implements Serializable

Serialized Fields

type

CGPlacesDetailImageType type

height

int height

width

int width

url

URI url

Class com.citygrid.content.places.detail.CGPlacesDetailLocation extends Object implements Serializable

Serialized Fields

baseLocation

CGBaseLocation baseLocation

referenceId

int referenceId

displayAd

boolean displayAd

infoUsaId

int infoUsaId

publicId

String publicId

teaser

String teaser

callPhone

String callPhone

displayUrl

URI displayUrl

markets

String[] markets

neighborhoods

String[] neighborhoods

urls

CGPlacesDetailUrls urls

customerContent

CGPlacesDetailCustomerContent customerContent

offers

CGPlacesDetailOffer[] offers

categories

CGPlacesDetailCategory[] categories

attributes

CGPlacesDetailAttribute[] attributes

businessHours

String businessHours

parking

String parking

tips

CGPlacesDetailTip[] tips

images

CGPlacesDetailImage[] images

editorials

CGPlacesDetailEditorial[] editorials

reviews

CGPlacesDetailReviews reviews

Class com.citygrid.content.places.detail.CGPlacesDetailOffer extends Object implements Serializable

Serialized Fields

name

String name

text

String text

offerDescription

String offerDescription

url

URI url

expirationDate

Date expirationDate

Class com.citygrid.content.places.detail.CGPlacesDetailResults extends Object implements Serializable

Serialized Fields

locations

CGPlacesDetailLocation[] locations

Class com.citygrid.content.places.detail.CGPlacesDetailReviews extends Object implements Serializable

Serialized Fields

rating

int rating

count

int count

shown

int shown

reviews

CGBaseReview[] reviews

Class com.citygrid.content.places.detail.CGPlacesDetailTip extends Object implements Serializable

Serialized Fields

name

String name

text

String text

Class com.citygrid.content.places.detail.CGPlacesDetailUrls extends Object implements Serializable

Serialized Fields

profile

URI profile

reviews

URI reviews

video

URI video

website

URI website

menu

URI menu

reservation

URI reservation

map

URI map

sendToFriend

URI sendToFriend

email

URI email

custom1

URI custom1

custom2

URI custom2

Package com.citygrid.content.places.search

Class com.citygrid.content.places.search.CGPlacesSearch extends Object implements Serializable

Serialized Fields

publisher

String publisher
The publisher code that identifies you. This is required.


type

CGPlacesSearchType type
Restricts results to listings of the given type


what

String what
Search term text


tag

int tag
Restricts search to listings with the given tag id.

Tag ids are internal CityGrid identifiers and subject to change. This parameter should only be used in queries that are obtained as "refinement urls" from previous searches.


chain

int chain
Restricts search to listings with the given chain id.

@discussion Chain ids are internal CityGrid identifiers and subject to change. This parameter should only be used in queries that are obtained as "chain expansion urls" from previous searches.


first

String first
Restricts search to entities whose name begins with the given character, or if "#", then to entities beginning with any digit.


where

String where
The geographic location

Address-based search is performed when this parameter starts with a number and contains non-numeric characters; it is much slower than searching a named region


radius

float radius
Radius of a circle search. If larger than 50 it defaults to 50.


page

int page
The page number of the result set to display.


resultsPerPage

int resultsPerPage
The number of results to be displayed/returned in a page.


sort

CGPlacesSearchSort sort
Sort criterion for the results.

Use alpha to sort results alphabetically, and dist to sort by increasing distance from the center of the search region. The dist request is only valid for address-based and circle searches.

If this parameter is omitted, the results will be ranked by relevance for keyword searches and distance for latitude and longitude


placement

String placement
An optional property for storing additional information you would like CityGrid Media to log for this view.

An example: if you run a search engine marketing campaign for, say, Google and Yahoo!, you can set the placement property to "sem_google" or "sem_yahoo". Alternatively, if you publish CityGrid listings in different locations in your own site, you can set the placement property to values such as "home_page" or "search" (all up to you). CityGrid will organize reports for you by placement


offers

boolean offers
Whether to return only listings that have offers associated with them.


histograms

boolean histograms
An optional property for providing information on how many listings are in given groups and categories.

Turning on histograms can affect performance.


latlon

CGLatLon latlon
Latitude and longitude of the center of a circle for a geographic search.


latlon2

CGLatLon latlon2
Second latitude and longitude used when performing a manual box search.


connectTimeout

int connectTimeout
The network connect connectTimeout used when performing a search. In milliseconds.


readTimeout

int readTimeout
The network read connectTimeout used when performing a search. In milliseconds.


impressionId

String impressionId
An optional property for grouping API calls for tracking purposes.

The value should be set when making subsequent calls that are related to a previously made call. The user should never supply their own generated value for the impression_id.

Class com.citygrid.content.places.search.CGPlacesSearchLocation extends Object implements Serializable

Serialized Fields

baseLocation

CGBaseLocation baseLocation

featured

boolean featured

publicId

String publicId

neighborhood

String neighborhood

fax

String fax

profile

URI profile

website

URI website

hasVideo

boolean hasVideo

hasOffers

boolean hasOffers

offers

String offers

reviews

int reviews

categories

String[] categories

tagline

String tagline

tags

CGTag[] tags

Class com.citygrid.content.places.search.CGPlacesSearchResults extends Object implements Serializable

Serialized Fields

firstHit

int firstHit

lastHit

int lastHit

totalHits

int totalHits

page

int page

resultsPerPage

int resultsPerPage

uri

URI uri

didYouMean

String didYouMean

regions

CGRegion[] regions

locations

CGPlacesSearchLocation[] locations

histograms

CGHistogram[] histograms

Package com.citygrid.content.reviews

Class com.citygrid.content.reviews.CGReviewsSearch extends Object implements Serializable

Serialized Fields

publisher

String publisher

type

CGReviewType type

what

String what

tag

int tag

where

String where

radius

float radius

page

int page

resultsPerPage

int resultsPerPage

sort

String sort

placement

String placement

impressionId

String impressionId

latlon

CGLatLon latlon

rating

int rating

days

int days

customerOnly

boolean customerOnly

locationId

int locationId

connectTimeout

int connectTimeout

readTimeout

int readTimeout



Copyright © 2011. All Rights Reserved.