1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201

202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266

// Copyright 2009 Google Inc. All Rights Reserved.

/* Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/**
 * @fileoverview Sample program that highlights how the GA Export API can
 *     be used with the Google Visualization API to store data in a dataTable
 *     as well as visualize the data as Table and PieChart objects.
 */

var myService;
var matchedTable;
var notMatchedTable;
var pieChart;
var dataTable;
var dataViewMatched;
var dataViewNotMatched;
var scope = 'https://www.google.com/analytics/feeds';

/**
 * Initialize all the objects from the Google AJAX Apis once they
 *     have been loaded and are ready to use.
 */
function init() {
  myService =
      new google.gdata.analytics.AnalyticsService('gaExportAPI_gVizBrand_v1.0');
  matchedTable =
      new google.visualization.Table(document.getElementById('matchedTableDiv'));
  notMatchedTable =
      new google.visualization.Table(document.getElementById('notMatchedTableDiv'));
  pieChart =
      new google.visualization.PieChart(document.getElementById('pieChartDiv'));

  setupEnterHandler();
  getStatus();
}

/**
 * Utility function to setup the event handling for pressing enter
 *     on the text matching input.
 */
function setupEnterHandler() {
  document.getElementById('filterInput').onkeydown = function(e) {
    if (e.which == 13) {
      drawViz();
    }
  };
}

/**
 * Utility function to setup the login/logout functionality.
 */
function getStatus() {
  var status = document.getElementById('status');
  var buttonLogin = document.getElementById('buttonLogin');
  var inputP = document.getElementById('inputP');
  buttonLogin.style.visibility = 'visible';

  if (!google.accounts.user.checkLogin(scope)) {
    buttonLogin.value = 'Login';
    buttonLogin.onclick = login;
    status.innerHTML = 'You are logged out, login to continue';
    inputP.style.visibility = 'hidden';
  } else {
    buttonLogin.value = 'Logout';
    buttonLogin.onclick = logout;
    status.innerHTML = 'You are logged in';
    inputP.style.visibility = 'visible';
  }
}

/**
 * AuthSub Authentication to allow user to grant this script
 * access to their GA data.
 */
function login() {
  google.accounts.user.login(scope);
  getStatus();
}

/**
 * AuthSub Authentication to allow user to remove this script
 * access to their GA data.
 */
function logout() {
  google.accounts.user.logout();
  getStatus();
}

/**
 * Request data from GA Export API
 */
function getDataFeed() {
  var myFeedUri = scope + '/data' +
    '?start-date=2008-10-01' +
    '&end-date=2008-10-31' +
    '&dimensions=ga:keyword' +
    '&metrics=ga:visits' +
    '&sort=-ga:visits' +
    '&max-results=50' +
    '&ids=ga:' + document.getElementById('inputProfileId').value;
  myService.getDataFeed(myFeedUri, handleMyDataFeed, handleError);
}

/**
 * Handle and display any error that occurs from the API request.
 * @param {Object} e The error object returned by the Analytics API.
 */
function handleError(e) {
  var error = 'There was an error!\n';
  if (e.cause) {
    error += e.cause.statusText;
  } else {
    error += e.message;
  }
  alert(error);
}

/**
 * Handle all the data returned by GA Export API.
 * Create GViz dataTable and dataViews objects.
 * @param {Object} myResultsFeedRoot the feed object
 *     retuned by the data feed.
 */
function handleMyDataFeed(myResultsFeedRoot) {
  dataTable = new google.visualization.DataTable();
  fillDataTable(dataTable, myResultsFeedRoot);
  dataViewMatched = new google.visualization.DataView(dataTable);
  dataViewNotMatched = new google.visualization.DataView(dataTable);

  drawViz();
}

/**
 * Put the feed result into a GViz Data Table.
 * @param {Object} dataTable the GViz dataTable object to put data into.
 * @param {Object} myResultsFeedRoot the feed returned by the GA Export API.
 */
function fillDataTable(dataTable, myResultsFeedRoot) {
  var entries = myResultsFeedRoot.feed.getEntries();

  dataTable.addColumn('string', 'Keyword');
  dataTable.addColumn('number', 'Visits');

  if (entries.length == 0) {
    dataTable.addRows(1);
    dataTable.setCell(0, 0, 'No Data');
    dataTable.setCell(0, 1, 0);
  } else {
    dataTable.addRows(entries.length);
    for (var idx = 0; idx < entries.length; idx++) {
      var entry = entries[idx];
      var keyword = entry.getValueOf('ga:keyword');
      var visits = entry.getValueOf('ga:visits');
      dataTable.setCell(idx, 0, keyword);
      dataTable.setCell(idx, 1, visits);
    }
  }
}

/**
 * Handle Visualization of data by drawing all the charts on the page.
 * Put focus on the matching form when done.
 */
function drawViz() {
  var matchedRows = [];
  var notMatchedRows = [];

  var matchedVisits = 0;
  var notMatchedVisits = 0;

  // put indicies of matched and not matched rows into two arrays
  // get matched and unmatched total visits
  for (var idx = 0; idx < dataTable.getNumberOfRows(); idx++) {
    var keyword = dataTable.getValue(idx, 0);
    var visits = dataTable.getValue(idx, 1);

    if (keyword.indexOf('(not set)') == -1) {
      if (isMatchedKeyword(keyword)) {
        matchedRows.push(idx);
        matchedVisits += visits;
      } else {
        notMatchedRows.push(idx);
        notMatchedVisits += visits;
      }
    }
  }

  // draw matched table views
  drawTable(dataViewMatched, matchedRows, matchedTable);
  drawTable(dataViewNotMatched, notMatchedRows, notMatchedTable);

  // draw visits pie chart
  drawChart('Visits of Matched', matchedVisits, notMatchedVisits, pieChart);


  //update the table headers
  document.getElementById('matchedVisitsSpan').innerHTML = matchedVisits;
  document.getElementById('notMatchedVisitsSpan').innerHTML = notMatchedVisits;

  document.getElementById('vizDiv').style.visibility = 'visible';
  document.getElementById('filterInput').focus();
}

/**
 * Draw a filtered GViz Table from Givz DataTable.
 * @param {Object} dataView a GViz DataView object.
 * @param {Array} filteredRows an array holding all the row indicies to show.
 * @param {Object} tableObject the visualization Table Object to display.
 */
function drawTable(dataView, filteredRows, tableObject) {
  dataView.setRows(filteredRows);
  tableObject.draw(dataView, null);
}

/**
 * Draw a pie chart from values passed into this function.
 * @param {String} myTitle the title of this chart.
 * @param {Number} chartValueOne the first value to display.
 * @param {Number} chartValueTwo the second number to display.
 * @param {Object} chartObject the visualization Chart Object to display.
 */
function drawChart(myTitle, chartValueOne, chartValueTwo, chartObject) {
  var label1 = 'Matched';
  var label2 = 'Didn\'t Match';

  // create a GViz DataTable JSON data object.
  chartDataTable = new google.visualization.DataTable({
    cols: [
      {id: 'A', label: 'Type', type: 'string'},
      {id: 'B', label: 'Count of Matched', type: 'number'}],
    rows: [
      {c: [{v: label1}, {v: chartValueOne}]},
      {c: [{v: label2}, {v: chartValueTwo}]}
    ]}, 0.5);

  chartObject.draw(chartDataTable, {width: 300, height: 200, title: myTitle, is3D: true});
}

/**
 * Test if the keyword is matched by the filter using a regualr expression match
 * @param {String} keyword the keyword returned to test.
 * @return {Boolean} true or false.
 */
function isMatchedKeyword(keyword) {
  var filter = document.getElementById('filterInput').value;
  return keyword.match(filter);
}

// Load the Google Visualization API client Libraries
google.load('visualization', '1', {packages: ['piechart', 'table', 'columnchart']});

// Load the Google data JavaScript client library
google.load('gdata', '1.x');

google.setOnLoadCallback(init);