QuickStart Guide¶

Let's assume that you need to request Google Analytics data with canonical query published in GA API documentation

 1 https://www.google.com/analytics/feeds/data
 2 ?ids=ga:12345
 3 &dimensions=ga:source,ga:medium
 4 &metrics=ga:visits,ga:bounces
 5 &sort=-ga:visits
 6 &filters=ga:medium%3D%3Dreferral
 7 &segment=gaid::10 OR dynamic::ga:medium%3D%3Dreferral
 8 &start-date=2008-10-01
 9 &end-date=2008-10-31
10 &start-index=10
11 &max-results=100
12 &v=2
13 &prettyprint=true

We recommend to read carefully GA Data API - Feed Reference to better understand requests rules and response data. It will make library understanding much simpler for you.

So, let's start embedding Google Analytics data into your Application.

1. Download AS3 Google Analytics API library SWC
2. Include SWC library into your project
3. Import library packages
   

    1 // Main class
    2 import com.denivip.ga.APILoader;
    3 // Google Analytics Account
    4 import com.denivip.ga.GAAccount;
    5 // Dimensions
    6 import com.denivip.ga.dimensions.CampaignMediumDimension;
    7 import com.denivip.ga.dimensions.CampaignSourceDimension;
    8 // Metrics
    9 import com.denivip.ga.metrics.VisitorBouncesMetric;
   10 import com.denivip.ga.metrics.VisitorVisitsMetric;
   11 // Filters classes
   12 import com.denivip.ga.filter.Filter;
   13 import com.denivip.ga.filter.FilterItem;
   14 import com.denivip.ga.filter.FilterOperator;
   15 // View classes
   16 import com.denivip.ga.view.GAView;
   

4. Configure Google Analytics API request through APILoader class and initiate connection
   

    1 // Create GA API connector
    2 var apiloader_ga:APILoader = new APILoader();
    3 // Initial configuration - ids=ga:12345
    4 apiloader_ga.setTableID("ga:12345");
    5 // Configure dimensions - check Developers Guide Dimensions section for details
    6 apiloader_ga.setDimensions(new Array(new CampaignSourceDimension(), new CampaignMediumDimension()));
    7 // Configure metrics - check Developers Guide Metrics section for details
    8 apiloader_ga.setMetrics(new Array(new VisitorVisitsMetric(), new VisitorBouncesMetric()));
    9 // Configure filter - check Developers Guide Filters section for details
   10 apiloader_ga.setFilter(new Filter(new FilterItem(new CampaignMediumDimension(), new FilterOperator("=="), "referral" )));
   11 // Configure segment
   12 var sgm:Filter = new Filter(new FilterItem("gaid::10"));
   13 sgm.addFilterItem("OR", new FilterItem("dynamic::ga:medium", new FilterOperator("=="), "referral"));
   14 apiloader_ga.segmentData(sgm);            
   15 
   16 // Timeframe setup, pay attention that months are zero based in AS3
   17 var start_date:Date = new Date(2010, 10, 9);
   18 var end_date:Date = new Date(2010, 11, 8);
   19 apiloader_ga.setPeriod(start_date, end_date);
   20 
   21 // Set callback (returns array of DataFeedResponse objects)
   22 apiloader_ga.setCallback(refreshGraph);
   23 
   24 // Configure view (process data and prepares everything in your way)
   25 apiloader_ga.registerView(gav);
   26 
   27 // Connect and begin data loading
   28 apiloader_ga.connect(new GAAccount("login@gmail.com", "pwd"));
   

   
   You could get your profile id (a.e. "12345") in two ways: using Account Feed request or in the Profile Settings page of Google Analytics. Data API - Account Feed

Dimensions and Metrics could be configured with predefined classes or simple object creation with Strings. Check [[Developers Guide]] for details.

1. Parse returned data
   It is possible to retrieve data in two ways: via callback function and via providing custom view object. Callback function receives Array of DataFeedResponse objects. Customized view object let's you prepare continuous data into any suitable form.
2. Show graph
   Actually, working with charts is out of the scope of this guide but we will address this issue to make sample application complete.
   Import chart packages
   Create chart
   Ingest chart data
   Check real sample here