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
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283

// 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 demonstrating how to make a data request to the
 * GA Data Export API using Auth Sub authentication as well as accessing
 * important data in the feed.
 */
//-----------------------------------------------------------------
// configure GA GData API
//-----------------------------------------------------------------
var myService;
var scope = 'https://www.google.com/analytics/feeds';

/**
 * Initialize the login controls
 */
function init() {
  myService = new google.gdata.analytics.AnalyticsService('gaExportAPI_dataFeed_v1.0');
  getStatus();
}

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

/**
 * Allow user to remove this script's access to their GA data.
 */
function logout() {
  google.accounts.user.logout();
  getStatus();
}

/**
 * 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');

  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';
  }
}

//-----------------------------------------------------------------
// GA Data Feed
//-----------------------------------------------------------------
/**
 * Construct a Data Feed query and send to the GA Export API.
 */
function getDataFeed() {
  // first build the query
  var myFeedUri = scope + '/data' +
    '?start-date=2008-10-01' +
    '&end-date=2008-10-31' +
    '&dimensions=ga:source,ga:medium' +
    '&metrics=ga:visits,ga:bounces' +
    '&sort=-ga:visits' +
    '&filters=ga:medium%3D%3Dreferral' +
    '&max-results=100' +
    '&ids=ga:' + document.getElementById('inputProfileId').value;

  // Send our request to the Analytics API and wait for the results to come back
  myService.getDataFeed(myFeedUri, handleDataFeed, 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 the data the API returns. Then output the data to the screen.
 * @param {Object} myResultsFeedRoot Parameter passed
 *     back from the feed handler.
 */
function handleDataFeed(myResultsFeedRoot) {
  outputFeedData(myResultsFeedRoot);
  outputFeedDataSources(myResultsFeedRoot);
  outputFeedAggregates(myResultsFeedRoot);
  outputEntryRowData(myResultsFeedRoot);

  var tableData = getFeedTable(myResultsFeedRoot);
  document.getElementById('entryDiv').innerHTML = tableData;

  document.getElementById('outputData').style.visibility = 'visible';
}

//-----------------------------------------------------------------
// Format Feed Related Data
//-----------------------------------------------------------------
/**
 * Output the information specific to the feed.
 * @param {Object} myResultsFeedRoot Parameter passed
 *     back from the feed handler.
 */
function outputFeedData(myResultsFeedRoot) {
  var feed = myResultsFeedRoot.feed;
  var feedString = [
    'Feed Title      = ' + feed.getTitle().getText(),
    'Feed Id         = ' + feed.getId().getValue(),
    'Total Results   = ' + feed.getTotalResults().getValue(),
    'Start Index     = ' + feed.getStartIndex().getValue(),
    'Items Per Page  = ' + feed.getItemsPerPage().getValue(),
    'Start Date      = ' + feed.getStartDate().getValue(),
    'End Date        = ' + feed.getEndDate().getValue()
  ].join('<br/>');
  document.getElementById('feedDataPre').innerHTML = feedString;
}

/**
 * Output information about the data sources in the feed.
 * Note: the GA Export API currently has exactly one data source.
 * @param {Object} myResultsFeedRoot Parameter passed
 *     back from the feed handler.
 */
function outputFeedDataSources(myResultsFeedRoot) {
  var feed = myResultsFeedRoot.feed;
  var gaDataSource = feed.getDataSources()[0];
  var dataSourceString = [
    'Table Name      = ' + gaDataSource.getTableName().getValue(),
    'Table Id        = ' + gaDataSource.getTableId().getValue(),
    'Web Property Id = ' + gaDataSource.getPropertyValue('ga:webPropertyId'),
    'Profile Id      = ' + gaDataSource.getPropertyValue('ga:profileId'),
    'Account Name    = ' + gaDataSource.getPropertyValue('ga:accountName')
  ].join('<br/>');
  document.getElementById('dataSourcePre').innerHTML = dataSourceString;
}

/**
 * Output all the metric names and values of the aggregate data.
 * The aggregate metrics represent values across all of the entries selected
 *     by the query and not just the rows returned.
 * @param {Object} myResultsFeedRoot Parameter passed
 *     back from the feed handler.
 */
function outputFeedAggregates(myResultsFeedRoot) {
  var feed = myResultsFeedRoot.feed;
  var aggregateString = '';
  var aggregates = feed.getAggregates().getMetrics();
  for (var idx = 0; idx < aggregates.length; idx++) {
    aggregateString = [
      'Metric Name     = ' + aggregates[idx].getName(),
      'Metric Value    = ' + aggregates[idx].getValue(),
      'Metric Type     = ' + aggregates[idx].getType(),
      'Metric CI       = ' + aggregates[idx].getConfidenceInterval()
    ].join('</br>');
    document.getElementById('aggregatesPre').innerHTML +=
      ['<div>', aggregateString, '</div>'].join('');
  }
}

/**
 * Output all the important information from the first entry in the data feed.
 * @param {Object} myResultsFeedRoot Parameter passed
 *     back from the feed handler.
 */
function outputEntryRowData(myResultsFeedRoot) {
  var entries = myResultsFeedRoot.feed.getEntries();
  if (entries.length == 0) {
    document.getElementById('entryIdPre').innerHTML = 'No entries found';
    return;
  }

  var entry = entries[0];
  var entryString = '';

  // properties specific to all the entries returned in the feed
  document.getElementById('entryIdPre').innerHTML = [
    'Entry Id        = ' + entry.getId().getValue(),
    'Entry Title     = ' + entry.getTitle().getText()
  ].join('<br/>');

  // iterate through all the dimensions
  var dimensions = entry.getDimensions();
  for (var idx = 0; idx < dimensions.length; idx++) {
    entryString = [
      'Dimension Name  = ' + dimensions[idx].getName(),
      'Dimension Value = ' + dimensions[idx].getValue()
    ].join('<br/>');
    document.getElementById('entryDimensionsPre').innerHTML =
      ['<div>', entryString, '</div>'].join('');
  }

  // iterate through all the metrics
  var metrics = entry.getMetrics();
  for (var idx = 0; idx < metrics.length; idx++) {
    entryString = [
      'Metric Name     = ' + metrics[idx].getName(),
      'Metric Value    = ' + metrics[idx].getValue(),
      'Metric Type     = ' + metrics[idx].getType(),
      'Metric CI       = ' + metrics[idx].getConfidenceInterval()
    ].join('<br/>');
    document.getElementById('entryMetricsPre').innerHTML =
    ['<div>', entryString, '</div>'].join('');
  }
}

/**
 * Get the data feed values into an HTML table.
 * @param {Object} myResultsFeedRoot Parameter passed
 *     back from the feed handler.
 * @return {String} This returns an HTML table.
 */
function getFeedTable(myResultsFeedRoot) {
  var entries = myResultsFeedRoot.feed.getEntries();
  if (entries.length == 0) {
    return '<table><tr><td>No entries found</td></tr></table>';
  }
  var entry = entries[0];
  var dimensions = entry.getDimensions();
  var metrics = entry.getMetrics();
  var tableData = ['<table>'];
  var tableNames = [];

  // put all the dimension and metric names into an array
  for (var idx = 0; idx < dimensions.length; idx++) {
    tableNames.push(dimensions[idx].getName());
  }
  for (var idx = 0; idx < metrics.length; idx++) {
    tableNames.push(metrics[idx].getName());
  }

  // put all the names into the header row of the table
  tableData.push('<tr><th>', tableNames.join('</th><th>'), '</th></tr>');

  // put the values of the dimension and metric names into the table
  for (var jdx = 0; jdx < entries.length; jdx++) {
    entry = entries[jdx];
    tableData.push('<tr>');
    for (var idx = 0; idx < tableNames.length; idx++) {
      tableData.push('<td>', entry.getValueOf(tableNames[idx]), '</td>');
    }
    tableData.push('</tr>');
  }
  tableData.push('</table>');

  return tableData.join('');
}

// Load the Google data JavaScript client library
google.load('gdata', '1.x', {packages: ['analytics']});

// Set the callback function when the library is ready
google.setOnLoadCallback(init);