Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Parameter

Description

Required

Examples

Notes

action_target

The type of the object you are displaying

Yes

listing_profile
listing_map
partner_menu

See #Action Targets below

listing_id

The unique CityGrid identifier of the business or event associated with this impression

Yes

33230

 

reference_id

The tracking identifier for the business that you obtained from a previous webservice call

Yes

2

 

publisher

The publisher code that identifies you so that you get credit

Yes

acme

 

i

The impression_id that you receive from a previous API Call

Yes

f39cc83915414da5b1ab513d298e6f39

 

placement

An optional property for storing additional information you would like CityGrid Media to log on your behalf

No

sem_google
sem_yahoo 
home_page 
search

An example: if you run a search engine marketing campaign for 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" — choose the values based on your needs. CityGrid will organize reports for you by placement

mobile_type

This field designates your device type name or designates the usage of our content on your Wireless Application Protocol (WAP) site

Yes for mobile publisher

wap
iphonev20

For a WAP site, set the value to "wap"

muid

The hash of user phone number and/or device ID as provided by the carrier

Yes for mobile publisher

device ID
phone number

Maximum of 32 characters

sourcePhone

The source phone for the click to call implementation on mobile phones

No

8878323451

Include the 10 digits for the phone number without any dashes.

dialPhone

The dialed phone for the click to call implementation on mobile phones

Yes for mobile

3124567892

Include the 10 digits for the phone number without any dashes.

ua

The client side user agent

Yes

Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.9.0.10) Gecko/2009042316 Firefox/3.0.10 (.NET CLR 3.5.30729)

Must be properly HTML encoded

historyReferer2This is the url of the page that the user browses before reaching the page that fires the tracker scriptNohttp://www.citysearch.com/search?what=pizza&listingId=&where=Los+Angeles%2C+CA+Metro&geoId=If this parameter is not passed, we will use document.referrer as the default historyReferer2

...

Action_Target

Usage

Tracking Purpose

Billable

listing_profile

Embed on the profile page of both advertisers and non advertisers

Profile page views

Yes

click_to_call

Embed where user clicks to call provided phone number

Phone Calls

Yes

listing_profile_print

Embed on confirmation page of user printing a profile page

Profile page print

No

listing_website

Click to External Listing Website

View merchant website

Yes

listing_review

Embed anywhere reviews are shown

Review page views

Yes

write_review

Embed on confirmation page of user writing a review

Review creation

No

listing_map

Embed where a map is shown with advertiser's location

Map views

Yes

listing_driving_direction

Embed on page where directions are provided to merchant location

Views of driving directions

Yes

listing_map_print

Embed on confirmation page of user printing map of merchant location

Map printing

Yes

listing_profile_print

Embed on confirmation page of user printing merchant profile

Profile page printing

No

send_listing_email

Embed on confirmation page of user sending merchant information via email

Merchant info has been emailed

Yes

send_listing_phone

Embed on confirmation page of user sending merchant information via SMS

Merchant info has been messaged

Yes

send_listing_gps

Embed on confirmation page of user sending merchant information to GPS

Merchant info sent to GPS

No

offer

Embed on page where advertiser offer is displayed

Offer views

Yes

offer_print

Embed on confirmation page of user printing an offer

Offer printing

No

listing_request_offer

Embed on request a offer from merchant page

Offer requests

No

partner_menu

Trigger when a CityGrid menu is shown

Menu views

Yes

partner_reservation

Trigger when a CityGrid reservation window is shown

Reservation view

Yes

listing_photo

Embed on photos page

Photo view

No

upload_listing_photo

Embed on confirmation page of user uploading photo

Photo uploads

No

listing_blog

Embed on a merchant blog page

Blog page views

No

listing_forums

Embed on forums/messageboards page

Forums/messageboard page view

No

listing_newsletters

Embed on merchant newsletter page

Newletter page view

No

listing_vote

Triggered when a user votes on / rates a business listing

User votes

No

listing_correction

Embed on suggest a correction page

User suggests a listing correction

No

listing_bookmark

Click to bookmark page

Profile page has been bookmarked

No

book_appointment

External link to book an appointmentLead Based ActionYes
book_roomExternal link to book a room (e.g. at a hotel)Lead Based ActionYes
contact_usExternal link to fill out a customized contact form (rather than generic email)Lead Based ActionYes
free_consultationExternal link to sign up for a free consultationLead Based ActionYes
free_estimateExternal link to request a free estimateLead Based ActionYes
online_orderExternal link to start an orderLead Based ActionYes
online_enrollmentExternal link to start online enrollment (e.g. in a school)Lead Based ActionYes
request_brochureExternal link to request a brochureLead Based ActionYes
request_informationExternal link to request more informationLead Based ActionYes
request_tourExternal link to request a tourLead Based ActionYes
request_quoteExternal link to request a quoteLead Based ActionYes
schedule_apptExternal link to schedule an appointmentLead Based ActionYes
schedule_consultExternal link to schedule a consultation Lead Based ActionYes
schedule_serviceExternal link to schedule a serviceLead Based ActionYes
view_brochureExternal link to view a brochureLead Based ActionYes
view_servicesExternal link to view available servicesLead Based ActionYes
view_inventoryExternal link to view inventoryLead Based ActionYes
virtual_tourExternal link to take a virtual tourLead Based ActionYes

Referral Tracking

The place data that you obtain from a CityGrid API response contains several content links to videos, reservations, menus, maps, and other types of content. You may display these links in your own applications. External links are encoded and already contain your publisher code and the corresponding reference ID within the URL. To be credited for your users following other links, you must append your publisher code and the reference ID to the links' URLs. You may also wish to append your placement identifier.

...