Personal tools
Namespaces

Variants
Actions

Google Analytics For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Advanced Configuration)
(→‎About Google Analytics For WHMCS)
Line 10: Line 10:
 
*'''Admin Area Features:'''
 
*'''Admin Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Track WHMCS User Actions With Google Analytics Integration:
+
|style="padding: 10px 0px 0px 30px;"|✔ Track WHMCS User Actions:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Add To Cart
+
|style="padding: 0px 0px 0px 45px;"|✔ Ad Conversion
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Ads Conversion
+
|style="padding: 0px 0px 0px 45px;"|✔ Cart Viewed
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Begin Checkout
+
|style="padding: 0px 0px 0px 45px;"|✔ Checkout Started
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Log in
+
|style="padding: 0px 0px 0px 45px;"|✔ Item Added To Cart
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Purchase
+
|style="padding: 0px 0px 0px 45px;"|✔ Item List Viewed
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Remove From Cart
+
|style="padding: 0px 0px 0px 45px;"|✔ Item Removed From Cart
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Sign Up
+
|style="padding: 0px 0px 0px 45px;"|✔ Item Viewed
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Ticket Close
+
|style="padding: 0px 0px 0px 45px;"|✔ Purchase Completed
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Ticket Open
+
|style="padding: 0px 0px 0px 45px;"|✔ Support Ticket Closed
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Ticket Reply
+
|style="padding: 0px 0px 0px 45px;"|✔ Support Ticket Opened
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View Cart
+
|style="padding: 0px 0px 0px 45px;"|✔ Support Ticket Replied
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View Item
+
|style="padding: 0px 0px 0px 45px;"|✔ User Logged In
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ View Item List
+
|style="padding: 0px 0px 0px 45px;"|✔ User Signed Up
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ View Dashboard Statistics:
+
|style="padding: 0px 0px 0px 30px;"|✔ View Dashboard Statistics And Graphs:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Events Statistics
+
|style="padding: 0px 0px 0px 45px;"|✔ Event Statistics
 
|}
 
|}
 
{|
 
{|
Line 94: Line 94:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 60px;"|✔ Log Errors And Information
+
|style="padding: 0px 0px 0px 60px;"|✔ Log Errors And Updates
 
|}
 
|}
 
{|
 
{|
Line 100: Line 100:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|✔ Select Client Properties Send To Google Analytics
+
|style="padding: 0px 0px 0px 45px;"|✔ Select Client Properties Sent To Google Analytics
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 45px;"|✔ Select Client Actions Sent To Google Analytics
 
|}
 
|}
 
{|
 
{|

Revision as of 11:21, 10 July 2024

Contents

About Google Analytics For WHMCS

Google Analytics For WHMCS integrates your WHMCS data into Google Analytics, providing deep insights into customer behavior and engagement.
Access a wide range of client activities, from shopping cart actions to account interactions and support ticket changes, all within your Google Analytics account.

Use this powerful module to unlock actionable insights!

  • Admin Area Features:
✔ Track WHMCS User Actions:
✔ Ad Conversion
✔ Cart Viewed
✔ Checkout Started
✔ Item Added To Cart
✔ Item List Viewed
✔ Item Removed From Cart
✔ Item Viewed
✔ Purchase Completed
✔ Support Ticket Closed
✔ Support Ticket Opened
✔ Support Ticket Replied
✔ User Logged In
✔ User Signed Up
✔ View Dashboard Statistics And Graphs:
✔ Event Statistics
✔ New Users
✔ Active Users
✔ Page Views
✔ Configure Google Analytics Integration:
✔ Enable Integration:
✔ Choose Data Sending Method:
✔ Requests To API Immediately
✔ Add Requests To Cron Queue
✔ Provide API Secret
✔ Provide Measurement ID
✔ Provide Conversion ID And Conversion Label
✔ Enable Debug Mode
✔ Log Errors And Updates
✔ Enable Google Tag Manager Integration
✔ Select Client Properties Sent To Google Analytics
✔ Select Client Actions Sent To Google Analytics
✔ View And Manage Queue Tasks
✔ View Module Logs
  • General Info:
✔ Multi-Language Support
✔ Supports Google Analytics 4
✔ Supports PHP 8.1 Back To PHP 7.4
✔ Supports WHMCS V8.10 Back To WHMCS V8.8
✔ Requires ionCube Loader V12 Or Later
✔ Easy Module Upgrade To Open Source Version

Installation

This tutorial will show you how to successfully install and authenticate Google Analytics For WHMCS.

We will guide you step by step through the whole installation and authentication process.

1. Log in to our client area and download the module.
GAN 1.png
2. In the downloaded file you might find one or two packages that support different PHP versions.

In the most recent versions of the module, you will find only one package that supports PHP 7.2 and later.

PHP72 74.png
3. Extract the package and upload its content into the main WHMCS directory.

The content of the package to upload should look like this.

GAN 2.png
4. When you install Google Analytics For WHMCS for the first time, you have to rename the 'license_RENAME.php' file.

The file is located in 'modules/addons/googleanalytics/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

GAN 3.png
5. In order to configure your license key you have to edit the previously renamed 'license.php' file.

Enter your license key between the quotation marks as presented on the following screen. You can find your license key in our client area → 'My Products'.

GAN 4.png
6. Optionally, add a cron job as shown below (5-minute intervals are recommended). 
php -q /your_whmcs/modules/addons/GoogleAnalytics/cron/cron.php queue

This cron makes sure data is sent automatically when using the 'Add Requests to Cron Queue' Data Sending Method.
Do not forget to replace 'your_whmcs' with your WHMCS root location. The cron can also be executed every single minute to perform the action more often.

Connection and API Configuration

7. Log in to Google Analytics and create an account for your website if you have not already.
GAN 4 1.png
8. Copy the 'Measurement ID' and 'API Secret' .

The web stream details page should open automatically, if it does not, you can find it under 'Admin' → 'Property Settings' → 'Data collection and modification' → 'Data Streams'.

GAN 5.png
9. Paste them in under 'Configuration' → 'General Settings'.
GAN 6 1.png
10. Go to 'Property details' and find the 'Property ID' .
GAN 7.png
11. Copy it into the respective field under 'Dashboard' .
GAN 7 1.png
12. Visit Google Analytics Developer Site and click on 'Click on Enable the Google Analytics Data API v1'.
GA 8.png
13. Download your 'credentails.json' file and paste its contents into the Credentials field.
GA 9.png
14. Find client_email and copy the address.
GA 10.png
15. Go back to Google Analytics. Navigate to 'Admin' → 'Account' → 'Account access management' and use the copied email to create a new user.
GA 11.png
16. The last step is to enable the integration, select what user customer data and which actions you want the module to send to Google Analytics, and submit the configuration.

Only selected actions will be displayed on the dashboard.

GA 12.png

Configuration and Management

With the connection between the Google Analytics For WHMCS module and Google Analytics established, the basic functionality is already active.
You will be able to see your WHMCS data in the Google Analytics panel, and the module's dashboard will provide crucial information at a glance without needing to leave the WHMCS environment.
See the instructions below for more details on the module's configuration and management.

Note: It might take the Google Analytics API about a day to send the updated data back to WHMCS.

Advanced Configuration

Under the 'Configuration' tab you will be able to specify additional details regarding the module's functionality.

First, focus 'General Settings'.

  • Data Sending Method -
  • Conversion ID - is a unique identifier assigned to a specific conversion action in Google Ads. It tracks and reports activities that lead to achieving conversion goals, such as purchases, sign-ups, or other valuable interactions. You can find it in the conversion settings in Google Ads.
  • Conversion Label - is a unique tag assigned to a specific conversion action in Google Ads. It allows for more detailed categorization and tracking of different types of conversions, such as various products or services. You can configure it in the conversion settings in Google Ads to better understand the effectiveness of your ad campaigns.
  • Debug Mode - allows you to preview the content and queries directly in Google Analytics in the Debug View tab without passing them to reports.
  • Log Errors and Updates - allows you to monitor queries sent to Google Analytics and view their content and possible errors.
File:GAN xxx.png 
You can log in to your Google Tag Manager account and open a container. In the top right corner (next to the Submit and Preview buttons) you'll see some short text that starts with GTM- and then contains some letters/numbers. That's your Google Tag Manager .";

Dashboard

Let us check your new product on the product page in admin area. It should look like on the screen below.
File:GAN xxx.png

Logs

All errors and module activity can be found in the 'Logs' section. You can view the details of each log or delete it by using the action buttons.
File:GAN xxx.png
Multiple logs can be deleted at once with the mass action function.
File:GAN xxx.png
Moreover additional actions include deleting specific logs, exporting the logs into a '.csv' file and settings up the auto prune system.
File:GAN xxx.png

Queue

If you are using the 'Add Requests to Cron Queue' Data Sensing Method, the 'Queue' section is where the requests can be managed.

You will find the information on the cron itself at the top of this section.

File:GAN xxx.png
The list of the queued requests can be viewed, inspected, and managed manually. Use the action buttons to see each request's details, manually run it, or delete it.
File:GAN xxx.png
Multiple tasks can be deleted at once via the mass selection feature.
File:GAN xxx.png
The auto prune system can be set up to automatically delete tasks after a specified time.

This feature can be found under additional actions.

File:GAN xxx.png

Tips

1. The module requires a G Suite Reseller account. To check the current status of your Google Reseller account, navigate to the following site: Google Cloud Partner Portal.
There, you can verify the status and request partner authorization if necessary. 
http://git.mglocal/whmcs-products/google-analytics/-/issues/21

Update Instructions

An essential guidance through the process of updating the module is offered here.

Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.
Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.

Upgrade Guide

Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?
There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.

Opt for the Open Source version of your Google Workspace For WHMCS module to unlock these benefits.
Simply click on either the Get Source Code or Upgrade To Lifetime button found on the product's page in our client area to complete the one-step upgrade process, with a dedicated discount already applied.

Follow a comprehensive guide covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Google_Analytics_For_WHMCS&oldid=69291"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
cPanel Modules
General
FAQ
Community