Ruby library to track into the official Google Analytics Measurement Protocol
https://developers.google.com/analytics/devguides/collection/protocol/v1/
NOTE: The Measurement Protocol is part of Universal Analytics, which is currently available in public beta. Data from the measurement protocol will only be processed in Universal Analytics enabled properties.
Add this line to your application's Gemfile:
gem 'staccato'
And then execute:
$ bundle
Or install it yourself as:
$ gem install staccato
tracker = Staccato.tracker('UA-XXXX-Y') # REQUIRED, your Google Analytics Tracking ID#tracker optionally takes a second param for the client_id value
By default, the client_id is set to a random UUID with SecureRandom.uuid
# Track a Pageview (all values optional)
tracker.pageview(path: '/page-path', hostname: 'mysite.com', title: 'A Page!')
# Track an Event (all values optional)
tracker.event(category: 'video', action: 'play', label: 'cars', value: 1)
# Track social activity (all values REQUIRED)
tracker.social(action: 'like', network: 'facebook', target: '/something')
# Track exceptions (all values optional)
tracker.exception(description: 'RuntimeException', fatal: true)
# Track timing (all values optional, but should include time)
tracker.timing(category: 'runtime', variable: 'db', label: 'query', time: 50) # time in milliseconds
tracker.timing(category: 'runtime', variable: 'db', label: 'query') do
some_code_here
end
# Track transaction (transaction_id REQUIRED)
tracker.transaction({
transaction_id: 12345,
affiliation: 'clothing',
revenue: 17.98,
shipping: 2.00,
tax: 2.50,
currency: 'EUR'
})
# Track transaction item (matching transaction_id and item name REQUIRED)
tracker.transaction_item({
transaction_id: 12345,
name: 'Shirt',
price: 8.99,
quantity: 2,
code: 'afhcka1230',
variation: 'red',
currency: 'EUR'
})Any of the options on the parameters list (https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters) that are accepted on ALL hit types can be set as options on any of the hits.
tracker.pageview(path: '/video/1235', flash_version: 'v1.2.3')Flash Version is a global option in the example above.
Note: There are a few options that if used will override global options:
- document_path: overriden by
pathin pageviews - document_hostname: overriden by
hostnamein pageviews - document_title: overriden by
titlein pageviews
These are holdovers from the original design, where pageview is a hit type that can take any/all of the optional parameters. path, hostname, and title are slightly nicer to use on pageview.
The complete list at this time:
Staccato::Hit::GLOBAL_OPTIONS.keys # =>
[:anonymize_ip,
:queue_time,
:cache_buster,
:user_id,
:user_ip,
:user_agent,
:referrer,
:campaign_name,
:campaign_source,
:campaign_medium,
:campaign_keyword,
:campaign_content,
:campaign_id,
:adwords_id,
:display_ads_id,
:screen_resolution,
:viewport_size,
:screen_colors,
:user_language,
:java_enabled,
:flash_version,
:document_location,
:document_encoding,
:document_hostname,
:document_path,
:document_title,
:link_id,
:application_name,
:application_version,
:application_id,
:application_installer_id,
:experiment_id,
:experiment_variant,
:product_action,
:product_action_list,
:promotion_action]Boolean options like anonymize_ip will be converted from true/false into 1/0 as per the tracking API docs.
hit = Staccato::Pageview.new(tracker, '/sports-page-5')
hit.add_custom_dimension(19, 'Sports')
hit.add_custom_metric(2, 5)
hit.track!The first argument is the slot position. Custom dimensions and metrics have 20 slots or 200 if you're "Premium" account.
The second argument is the value. For dimensions, that's a text value. For metrics it is an integer.
# Track a Non-Interactive Hit
tracker.event(category: 'video', action: 'play', non_interactive: true)Non-Interactive events are useful for tracking things like emails sent, or other events that are not directly the result of a user's interaction.
The option non_interactive is accepted for all methods on tracker.
# start a session
tracker.pageview(path: '/blog', start_session: true)
# end a session
tracker.pageview(path: '/blog', end_session: true)Other options are acceptable to start and end a session: session_start, sessoin_end, and stop_session.
# Tracking an Experiment
# useful for tracking A/B or Multivariate testing
tracker.pageview({
path: '/blog',
experiment_id: 'a7a8d91df',
experiment_variant: 'a'
})Global parameters can be set as defaults on the tracker, and will be used for all hits (unless overwritten by parameters set directly on a hit).
The following example creates a tracker with a default hostname. The two pageviews will track the default hostname and the page path passed in.
tracker = Staccato.tracker('UA-XXXX-Y', client_id, {document_hostname: 'example.com'})
tracker.pageview(path: '/videos/123')
tracker.pageview(path: '/videos/987')Additional Measurements can be added to any Hit type, but most commonly used with pageviews or events. The current set of measurements is for handling Enhanced Ecommerce measurements. I've grouped these into ImpressionList, Product, ProductImpression, Promotion, Transaction, Checkout, and CheckoutOption (w/ ImpressionList). Each can be added and combined – per Google's documentation – onto an existing Hit.
Note: Certain Measurements require an index. This is an integer (usually) between 1 and 200 inclusive.
Note: Certain Measurements require a product_action to be set. This is a global option, and should be set on the original hit. The product_action can be any one of:
detailclickaddremovecheckoutcheckout_optionpurchaserefund
Using a pageview to track a transaction with a product (using the 'purchase' as the product_action:
pageview = tracker.build_pageview(path: '/receipt', hostname: 'mystore.com', title: 'Your Receipt', product_action: 'purchase')
pageview.add_measurement(:transaction, {
transaction_id: 'T12345',
affiliation: 'Your Store',
revenue: 37.39,
tax: 2.85,
shipping: 5.34,
currency: 'USD',
coupon_code: 'SUMMERSALE'
})
pageview.add_measurement(:product, {
index: 1, # this is our first product, value may be 1-200
id: 'P12345',
name: 'T-Shirt',
category: 'Apparel',
brand: 'Your Brand',
variant: 'Purple',
quantity: 2,
position: 1,
price: 14.60,
coupon_code: 'ILUVTEES'
})
pageview.track!The combination of product_action: 'refund' and transaction measurement setting a matching id to a previous transaction.
event = tracker.build_event(category: 'order', action: 'refund', non_interactive: true, product_action: 'refund')
event.add_measurement(:transaction, id: 'T12345')
event.track!The combination of product_action: 'refund' and transaction measurement setting a matching id to a previous transaction. You can also specify a product (or products, using index) with a quantity (for partial refunds) to refund.
event = tracker.build_event(category: 'order', action: 'refund', non_interactive: true, product_action: 'refund')
event.add_measurement(:transaction, id: 'T12345')
event.add_measurement(:product, index: 1, id: 'P12345', quantity: 1)
event.track!pageview = tracker.build_pageview(path: '/search', hostname: 'mystore.com', title: 'Search Results')
pageview.add_measurement(:promotion, {
index: 1,
id: 'PROMO_1234',
name: 'Summer Sale',
creative: 'summer_sale_banner',
position: 'banner_1'
})
pageview.track!Promotion also supports a promotion_action, similar to product_action. This is another global option on Hit.
event = tracker.build_event(category: 'promotions', action: 'click', label: 'internal', promotion_action: 'click')
event.add_measurement(:promotion, {
index: 1,
id: 'PROMO_1234',
name: 'Summer Sale',
creative: 'summer_sale_banner',
position: 'banner_1'
})
event.track!event = tracker.build_event(category: 'search', action: 'click', label: 'results', product_action: 'click', product_action_list: 'Search Results')
event.add_measurement(:product, {
index: 1,
id: 'P12345',
name: 'T-Shirt',
category: 'Apparel',
brand: 'Your Brand',
variant: 'Purple',
quantity: 2,
position: 1,
price: 14.60,
coupon_code: 'ILUVTEES'
})
event.track!pageview = tracker.build_pageview(path: '/checkout', hostname: 'mystore.com', title: 'Complete Your Checkout', product_action: 'checkout')
pageview.add_measurement(:product, {
index: 1, # this is our first product, value may be 1-200
id: 'P12345',
name: 'T-Shirt',
category: 'Apparel',
brand: 'Your Brand',
variant: 'Purple',
quantity: 2,
position: 1,
price: 14.60,
coupon_code: 'ILUVTEES'
})
pageview.add_measurement(:checkout, {
step: 1,
step_option: 'Visa'
})
pageview.track!event = tracker.build_event(category: 'checkout', action: 'option', non_interactive: true, product_action: 'checkout_option')
event.add_measurement(:checkout_options, {
step: 2,
step_option: 'Fedex'
})
event.track!pageview = tracker.build_pageview(path: '/home', hostname: 'mystore.com', title: 'Home Page')
pageview.add_measurement(:impression_list, index: 1, name: 'Search Results')
pageview.add_measurement(:product_impression, {
index: 1,
list_index: 1, # match the impression_list above
id: 'P12345',
name: 'T-Shirt',
category: 'Apparel',
brand: 'Your Brand',
variant: 'Purple',
position: 1,
price: 14.60
})
pageview.add_measurement(:impression_list, index: 2, name: 'Recommendations')
pageview.add_measurement(:product_impression, {
index: 1,
list_index: 2,
name: 'Yellow Tee'
})
pageview.add_measurement(:product_impression, {
index: 2,
list_index: 2,
name: 'Red Tee'
})
pageview.track!https://developers.google.com/analytics/devguides/collection/protocol/v1/devguide https://developers.google.com/analytics/devguides/collection/protocol/v1/reference https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request