You are here

README.txt in Google Analytics Reports 8.3

Same filename and directory in other branches
  1. 6 README.txt
  2. 7.3 README.txt
  3. 7 README.txt
DESCRIPTION
-----------
Google Analytics Reports module provides graphical reporting of your site's
tracking data. Graphical reports include small path-based report in blocks,
and a full path-based report.

Google Analytics Reports API module provide API for developers to access data
from Google Analytics using Google Analytics Core Reporting API
https://developers.google.com/analytics/devguides/reporting/core/v3/.

Google Analytics Reports module provide Views query plugin to create Google
Analytics reports using Views interface.


REQUIREMENTS
------------
* Google Analytics user account https://www.google.com/analytics


DEPENDENCIES
------------
* Google Analytics Reports API has no dependencies.
* Google Analytics Reports depends on Google Analytics Reports API and Views
  modules.


RECOMMENDED MODULES
-------------------
* Charts module https://www.drupal.org/project/charts. Enable Google Charts or
  Highcharts sub-module to see graphical reports.
* Ajax Blocks module https://www.drupal.org/project/ajaxblocks for better page
  loading with Google Analytics Reports blocks.


INSTALLATION
------------
1. Copy the 'google_analytics_reports' module directory in to your Drupal
   sites/all/modules directory as usual. See https://www.drupal.org/documentati
   on/install/modules-themes/modules-7 for details.


CONFIGURATION
-------------
Configuration of Google Analytics Reports API module.

Before you can get the credentials you may need to create a new
project and enable the analytics API for it:

 1. Open Google Developers Console:
    https://console.developers.google.com.
    Log in to you Google account if required.
 2. This will take you to a screen to manage your Google analytics
    APIs. In the top bar there will be a menu to select an API project
    (if you have one), and to create a new project. Click on the
    down-triangle of the menu.
 3. This will produce a modal pop-up. To create a new project, click
    on the plus (+) sign.
 4. Give the project a name and press "Create".
 5. Make this the active project.
 6. Use the hamburger menu to select API & Services » Library Filter
    on "Analytics". Select "Analytics API"
 7. Press "Enable",

Then get the credentials:

 8. Use the hamburger menu to select API & Services » Credentials.
 9. Click the pull-down menu "Create credentials". Select "Help me
    choose".
10. Under "What API are you using", select "Analytics API". (If this
    option does not appear, you have not yet enabled this API for this
    project, see steps 6 and 7 above).
11. Under "Where will you be calling the API from?" select "Web
    Browser (Javascript)". Under "What data will you be accessing?",
    select "User Data".
12. Press "What credentials do I need?" and edit the name if
    necessary.
13. Leave empty "Authorized JavaScript origins".
14. Fill in "Authorized redirect URIs" with
    "http://YOURSITEDOMAIN/admin/config/services/google-analytics-reports-api".
    Replace  "YOURSITEDOMAIN" with the base URL of your site.
15. Press "Create Client ID"-button.
16. Type a product name to show to users and hit "Continue" and then
    "Done".
17. Use the hamburger menu to select API & Services » Credentials.
18. Click on the name of your new client ID to be shown both the
    "Client ID" and "Client Secret".

On the Drupal site navigate to "Configuration » System » Google
Analytics Reports API" and copy "Client ID" and "Client secret" from
the Google Developers console into the fields. Press "Start setup and
authorize account" to allow the project access to Google Analytics
data.

Configuration of Google Analytics Reports module:
1. Configure Google Analytics Reports API module first.
2. Enable Charts module and Google Charts or Highcharts sub-module to see
   graphical reports.
3. Go to "admin/reports/google-analytics-reports/summary" page to see
   Google Analytics Summary report.
4. Go to "admin/structure/block" page and enable "Google Analytics Reports
   Summary Block" and/or "Google Analytics Reports Page Block" blocks.


CACHING
-------
Note that Google has a moderately strict Quota Policy https://developers.google
.com/analytics/devguides/reporting/core/v3/limits-quotas#core_reporting. To aid
with this limitation, this module caches query results for a time that you
specify in the admin settings. Our recommendation is at least three days.


CREDITS
-------
* Joel Kitching (jkitching)
* Tony Rasmussen (raspberryman)
* Dylan Tack (grendzy)
* Nickolay Leshchev (Plazik)

File

README.txt
View source
  1. DESCRIPTION
  2. -----------
  3. Google Analytics Reports module provides graphical reporting of your site's
  4. tracking data. Graphical reports include small path-based report in blocks,
  5. and a full path-based report.
  6. Google Analytics Reports API module provide API for developers to access data
  7. from Google Analytics using Google Analytics Core Reporting API
  8. https://developers.google.com/analytics/devguides/reporting/core/v3/.
  9. Google Analytics Reports module provide Views query plugin to create Google
  10. Analytics reports using Views interface.
  11. REQUIREMENTS
  12. ------------
  13. * Google Analytics user account https://www.google.com/analytics
  14. DEPENDENCIES
  15. ------------
  16. * Google Analytics Reports API has no dependencies.
  17. * Google Analytics Reports depends on Google Analytics Reports API and Views
  18. modules.
  19. RECOMMENDED MODULES
  20. -------------------
  21. * Charts module https://www.drupal.org/project/charts. Enable Google Charts or
  22. Highcharts sub-module to see graphical reports.
  23. * Ajax Blocks module https://www.drupal.org/project/ajaxblocks for better page
  24. loading with Google Analytics Reports blocks.
  25. INSTALLATION
  26. ------------
  27. 1. Copy the 'google_analytics_reports' module directory in to your Drupal
  28. sites/all/modules directory as usual. See https://www.drupal.org/documentati
  29. on/install/modules-themes/modules-7 for details.
  30. CONFIGURATION
  31. -------------
  32. Configuration of Google Analytics Reports API module.
  33. Before you can get the credentials you may need to create a new
  34. project and enable the analytics API for it:
  35. 1. Open Google Developers Console:
  36. https://console.developers.google.com.
  37. Log in to you Google account if required.
  38. 2. This will take you to a screen to manage your Google analytics
  39. APIs. In the top bar there will be a menu to select an API project
  40. (if you have one), and to create a new project. Click on the
  41. down-triangle of the menu.
  42. 3. This will produce a modal pop-up. To create a new project, click
  43. on the plus (+) sign.
  44. 4. Give the project a name and press "Create".
  45. 5. Make this the active project.
  46. 6. Use the hamburger menu to select API & Services » Library Filter
  47. on "Analytics". Select "Analytics API"
  48. 7. Press "Enable",
  49. Then get the credentials:
  50. 8. Use the hamburger menu to select API & Services » Credentials.
  51. 9. Click the pull-down menu "Create credentials". Select "Help me
  52. choose".
  53. 10. Under "What API are you using", select "Analytics API". (If this
  54. option does not appear, you have not yet enabled this API for this
  55. project, see steps 6 and 7 above).
  56. 11. Under "Where will you be calling the API from?" select "Web
  57. Browser (Javascript)". Under "What data will you be accessing?",
  58. select "User Data".
  59. 12. Press "What credentials do I need?" and edit the name if
  60. necessary.
  61. 13. Leave empty "Authorized JavaScript origins".
  62. 14. Fill in "Authorized redirect URIs" with
  63. "http://YOURSITEDOMAIN/admin/config/services/google-analytics-reports-api".
  64. Replace "YOURSITEDOMAIN" with the base URL of your site.
  65. 15. Press "Create Client ID"-button.
  66. 16. Type a product name to show to users and hit "Continue" and then
  67. "Done".
  68. 17. Use the hamburger menu to select API & Services » Credentials.
  69. 18. Click on the name of your new client ID to be shown both the
  70. "Client ID" and "Client Secret".
  71. On the Drupal site navigate to "Configuration » System » Google
  72. Analytics Reports API" and copy "Client ID" and "Client secret" from
  73. the Google Developers console into the fields. Press "Start setup and
  74. authorize account" to allow the project access to Google Analytics
  75. data.
  76. Configuration of Google Analytics Reports module:
  77. 1. Configure Google Analytics Reports API module first.
  78. 2. Enable Charts module and Google Charts or Highcharts sub-module to see
  79. graphical reports.
  80. 3. Go to "admin/reports/google-analytics-reports/summary" page to see
  81. Google Analytics Summary report.
  82. 4. Go to "admin/structure/block" page and enable "Google Analytics Reports
  83. Summary Block" and/or "Google Analytics Reports Page Block" blocks.
  84. CACHING
  85. -------
  86. Note that Google has a moderately strict Quota Policy https://developers.google
  87. .com/analytics/devguides/reporting/core/v3/limits-quotas#core_reporting. To aid
  88. with this limitation, this module caches query results for a time that you
  89. specify in the admin settings. Our recommendation is at least three days.
  90. CREDITS
  91. -------
  92. * Joel Kitching (jkitching)
  93. * Tony Rasmussen (raspberryman)
  94. * Dylan Tack (grendzy)
  95. * Nickolay Leshchev (Plazik)