Personal tools
Namespaces

Variants
Actions

Google Analytics For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Tips)
(→‎About Google Analytics For WHMCS)
 
(104 intermediate revisions by 2 users not shown)
Line 4: Line 4:
 
=About [https://www.modulesgarden.com/products/whmcs/google-analytics Google Analytics For WHMCS]=
 
=About [https://www.modulesgarden.com/products/whmcs/google-analytics Google Analytics For WHMCS]=
 
{|
 
{|
−
|style="padding: 10px 0px 10px 0px;"|'''Google Analytics For WHMCS''' will ena.............
+
|style="padding: 10px 0px 10px 0px;"|'''Google Analytics For WHMCS''' integrates your WHMCS data into Google Analytics, providing deep insights into customer behavior and engagement.<br/> Access a wide range of client activities, from shopping cart actions to account interactions and support ticket changes, all within your Google Analytics account.<br/>
 +
Use this powerful module to constantly monitor your customers' actions and respond to their needs immediately.  
 
|}
 
|}
 
<!--a comment maybe? -->
 
<!--a comment maybe? -->
 
*'''Admin Area Features:'''
 
*'''Admin Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Create/Suspend/Unsuspend/Terminate Account
+
|style="padding: 10px 0px 0px 30px;"|✔ Track WHMCS User Actions:
 
|}
 
|}
−
 
−
*'''General Info:'''
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Requires Google Cloud Partner Program / Reseller Account
+
|style="padding: 0px 0px 0px 45px;"|✔ Ad Conversion
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Authentication And API Calls Utilize OAuth 2.0
+
|style="padding: 0px 0px 0px 45px;"|✔ Cart Viewed
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Multi-Language Support
+
|style="padding: 0px 0px 0px 45px;"|✔ Checkout Started
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.1 Back To PHP 7.4
+
|style="padding: 0px 0px 0px 45px;"|✔ Item Added To Cart
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Themes "Six" And "Twenty-One"
+
|style="padding: 0px 0px 0px 45px;"|✔ Item List Viewed
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.10 Back To WHMCS V8.6
+
|style="padding: 0px 0px 0px 45px;"|✔ Item Removed From Cart
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Requires ionCube Loader V12 Or Later
+
|style="padding: 0px 0px 0px 45px;"|✔ Item Viewed
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Easy [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module Module Upgrade] To [https://www.modulesgarden.com/products/whmcs/google-workspace#open-source-version Open Source Version]
+
|style="padding: 0px 0px 0px 45px;"|✔ Purchase Completed
 
|}
 
|}
−
 
−
=Installation and Authentication=
 
 
{|
 
{|
−
|style="padding: 10px 0px 0px 0px;"|'''This tutorial will show you how to successfully install and authenticate [https://www.modulesgarden.com/products/whmcs/google-analytics Google Analytics For WHMCS.]'''<br />
+
|style="padding: 0px 0px 0px 45px;"|✔ Support Ticket Closed
−
We will guide you step by step through the whole installation and authentication process.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 20px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
+
|style="padding: 0px 0px 0px 45px;"|✔ Support Ticket Opened
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GAN_1.png]]
+
|style="padding: 0px 0px 0px 45px;"|✔ Support Ticket Replied
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 15px;"|'''2. In the downloaded file you might find one or two packages that support different PHP versions.'''<br/>
+
|style="padding: 0px 0px 0px 45px;"|✔ User Logged In
−
In the most recent versions of the module, you will find only one package that supports PHP 7.2 and later.<br/> <!--  If you need a package for the previous versions of PHP, please [https://www.modulesgarden.com/support/ticket/general-support contact our support]. -->
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PHP72_74.png]]
+
|style="padding: 0px 0px 0px 45px;"|✔ User Signed Up
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''3. Extract the package and upload its content into the main WHMCS directory. <br/>
+
|style="padding: 0px 0px 0px 30px;"|✔ View Dashboard Statistics And Graphs:
−
The content of the package to upload should look like this.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GAN_2.png]]
+
|style="padding: 0px 0px 0px 45px;"|✔ Event Statistics
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Google Analytics For WHMCS for the first time, you have to rename the '' 'license_RENAME.php' '' file.'''<br />
+
|style="padding: 0px 0px 0px 45px;"|✔ New Users
−
The file is located in '' 'modules/addons/googleanalytics/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GAN_3.png]]
+
|style="padding: 0px 0px 0px 45px;"|✔ Active Users
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key you have to edit the previously renamed '' 'license.php' '' file.'''<br />
+
|style="padding: 0px 0px 0px 45px;"|✔ Page Views
−
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'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:GAN_4.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ Configure Google Analytics Integration:
 
|}
 
|}
−
 
−
==API Configuration==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''6. Now you have to authenticate the module through setting up the API Access.'''<br />
+
|style="padding: 0px 0px 0px 45px;"|✔ Enable Integration:
−
Create API Access in Google API Console. You can do it here → [https://console.developers.google.com/apis/dashboard https://console.developers.google.com/apis/dashboard]
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''7. After you have logged in, create a new project.'''
+
|style="padding: 0px 0px 0px 60px;"|✔ Choose Data Sending Method:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GAN_5.png]]
+
|style="padding: 0px 0px 0px 75px;"|✔ Requests To API Immediately
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''8. To proceed, go to '' 'Google APIs' '' under the '' 'Overview' '' tab.'''<br />
+
|style="padding: 0px 0px 0px 75px;"|✔ Add Requests To Cron Queue
−
Find '' 'Google Apps Reseller API' '' among the applications.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GAN_6_1.png]]
+
|style="padding: 0px 0px 0px 60px;"|✔ Provide API Secret
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''9. Now, you have to enable '' 'Google Apps Reseller API' '' as shown on the following screen.'''
+
|style="padding: 0px 0px 0px 60px;"|✔ Provide Measurement ID
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GAN_7.png]]
+
|style="padding: 0px 0px 0px 60px;"|✔ Provide Conversion ID And Conversion Label
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''10. Next, search for the '' 'Admin SDK' '' the same way you did it in step 9.'''
+
|style="padding: 0px 0px 0px 60px;"|✔ Enable Debug Mode
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GAN_7_1.png]]
+
|style="padding: 0px 0px 0px 60px;"|✔ Log Errors And Updates
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''11. Enable '' 'Admin SDK' '' API.'''
+
|style="padding: 0px 0px 0px 45px;"|✔ Enable Google Tag Manager Integration
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GA_8.png]]
+
|style="padding: 0px 0px 0px 45px;"|✔ Select Client Properties Sent To Google Analytics
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''12. Finally, open the '' 'Explore and enable API' '' section, the API & Services page should open. Go to '' 'OAuth consent screen' '' under the '' 'Credentials' '' section.<br />
+
|style="padding: 0px 0px 0px 45px;"|✔ Select Client Actions Sent To Google Analytics
−
Afterward, enter the mail address and application name that will be visible during your requests.<br />
+
−
Here is a list of scopes required by the module to work properly:
+
−
*admin.directory.user
+
−
*apps.order
+
−
*apps.order.readonly
+
−
*userinfo.profile<br/>
+
−
Save changes through pressing the '' 'Save' '' button.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GAN_6.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ View And Manage Queue Tasks
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''13. Then, switch to the '' 'Credentials' '' tab and add new credentials .'''
+
|style="padding: 0px 0px 0px 30px;"|✔ View Module Logs
 
|}
 
|}
 +
 +
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:GAN_9.png]]
+
|style="padding: 10px 0px 0px 30px;"|✔ Multi-Language Support
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''14. After you have done that, tick '' 'Web application'. '''''<br />
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports Google Analytics 4
−
Next, enter your website URL into the '' 'Authorized JavaScript origins' '' field and correct path to '' 'oauth_callback.php' '' into the '' 'Authorized redirect URI' '' field.<br />
+
−
Confirm changes by pressing '' 'Create'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:GAN_10.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.2 Back To PHP 8.1
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''15. Well done! Now that you have filled in all the necessary details, you can proceed to authenticate Google Apps.'''
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.12 Back To WHMCS V8.9
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:GAN_11.png]]
+
|style="padding: 0px 0px 0px 30px;"|✔ Requires ionCube Loader V14 Or Later
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 30px;"|✔ Easy [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module Module Upgrade] To [https://www.modulesgarden.com/products/whmcs/google-analytics#open-source-version Open Source Version]
 
|}
 
|}
  
−
<!-- nie ma produktów ani CA
+
=Installation=
−
==Product Configuration==
+
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'''16. In order to create and configure a product, go to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services'.'''''<br />
+
|style="padding: 10px 0px 0px 15px;"|'''This tutorial will show you how to successfully install and authenticate [https://www.modulesgarden.com/products/whmcs/google-analytics Google Analytics For WHMCS].'''<br />
−
Click on '' 'Create a New Group'.''
+
We will guide you step by step through the whole installation and authentication process.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GAN_12.png]]
+
|style="padding: 20px 0px 20px 15px;"|'''1. Log in to our client area and download the module.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''17. Enter your product group name and press '' 'Save Changes'.'''''
+
|style="padding: 0px 0px 20px 25px;"|[[File:GAN_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GAN_13.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''2. Extract the package and upload its content into the main WHMCS directory. <br/>
 +
The content of the package to upload should look like this.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''18. Now, create a new product for your GoogleApps.'''<br/>
+
|style="padding: 0px 0px 20px 25px;"|[[File:GAN_2.png]]
−
To do so, first click on '' 'Create a New Product'.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GAM_14.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''3. When you install Google Analytics For WHMCS for the first time, you have to rename the '' 'license_RENAME.php' '' file.'''<br />
 +
The file is located in '' 'modules/addons/GoogleAnalytics/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''19. Choose the desired product type and product group from the dropdown menus and enter a new name of your products. Press '' 'Continue'. ''
+
|style="padding: 0px 0px 20px 25px;"|[[File:GAN_3.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GAN_15.png]]
+
|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key you have to edit the previously renamed '' 'license.php' '' file.'''<br />
 +
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'. ''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''20. Go to '' 'Module Settings' '' of your product and choose '' 'G Suite' '' from the '' 'Module Name' '' dropdown menu.'''<br/>
+
|style="padding: 0px 0px 25px 25px;"|[[File:GAN_4.png]]
−
After choosing the module, make sure to click on the ''''Save Changes'''' button.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GAN_16.png]]
+
|style="padding: 0px 0px 30px 15px;"|'''5. 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.<br/>
 +
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=
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''21. Enter your previously obtained '' 'Client ID' as well as 'Client Secret' '' and make sure that '' 'Callback URL' '' is correct.<br/>
+
|style="padding: 10px 0px 20px 15px;"|'''6. Log in to [https://analytics.google.com/analytics/web/?authuser=0#/| Google Analytics] and create an account for your website if you have not already.'''
−
Then, press '' 'Grant access with Google account'. '''''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GAN_17.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:GAN_4_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''22. You will be redirected to the page with a permission request if the data you entered is correct. Press the '' 'Allow access' '' button.'''
+
|style="padding: 0px 0px 15px 15px;"|'''7. Copy the '' 'Measurement ID' '' and '' 'API Secret' ''.'''<br/>
 +
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'.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GAN_18.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:GAN_5.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''23. That is it. You will be now redirected to your WHMCS and you will see the following screen.'''<br />
+
|style="padding: 0px 0px 20px 15px;"|'''8. Paste them in under '' 'Configuration' '' → '' 'General Settings'.'''''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GAN_19.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:GAN_6_1.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''24. Now, let us move to 'Custom Fields'. Fields with '' 'GoogleApps Domain' '', '' 'GoogleApps PurchaseOrderID' '' , '' 'GoogleApps Alternate Email', 'Mailbox Name' 'GSuiteSubscriptionId' '' and '' 'GSuiteDealCode' '' variables are added automatically.'''
+
|style="padding: 0px 0px 20px 15px;"|'''9. Go to '' 'Property details' '' and find the '' 'Property ID' ''.'''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:GAN_20.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:GAN_7.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|'''10. Copy it into the respective field under '' 'Dashboard' ''.'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:GAN_7_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|'''11. Visit [https://developers.google.com/analytics/devguides/reporting/data/v1/quickstart-client-libraries#step_1_enable_the_api| Google Analytics Developer Site] and click on '' 'Click on Enable the Google Analytics Data API v1'.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:GA_8.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|'''12. Download your '' 'credentails.json' '' file and paste its contents into the Credentials field.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:GA_9.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|'''13. Find <code>client_email</code> and copy the address.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:GA_10.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|'''14. Go back to [https://analytics.google.com/| Google Analytics]. Navigate to '' 'Admin' '' → '' 'Account' '' → '' 'Account access management' '' and use the copied email to create a new user.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:GA_11.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''15. 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.''' <br/>
 +
Only selected actions will be displayed on the dashboard.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:GA_12.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|'''You have successfully installed Google Analytics For WHMCS and connected it with the Google Analytics platform.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:GA_12_1.png]]
 
|}
 
|}
−
-->
 
  
 
=Configuration and Management=
 
=Configuration and Management=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 0px;"|Configuration and management of Google Workspace For WHMCS is very intuitive. Read the below sections to see how easy it is.
+
|style="padding: 10px 0px 30px 15px;"|'''With the connection between the Google Analytics For WHMCS module and Google Analytics established, the basic functionality is already active.'''<br/> 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. <br/> See the instructions below for more details on the module's configuration and management.<br/>
 +
'''''Note:''' It might take the Google Analytics API about a day to send the updated data back to WHMCS.''
 
|}
 
|}
−
==Basic Configuration==
+
==Advanced Configuration==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Let us begin the process of module .....
+
|style="padding: 10px 0px 15px 15px;"|'''Under the '' 'Configuration' '' tab you will be able to specify additional details regarding the module's functionality.'''<br/>
 +
First, focus on '' 'General Settings'.''
 +
*'''Data Sending Method''' - choose how the data is sent to Google Analytics. You can either send API requests immediately or use the cron queue system, potentially reducing the load on WHMCS.<br/> The cron itself can be found in the [[#Queue|Queue]] tab.
 +
*'''Conversion ID''' - 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.<br/> You can find it in the conversion settings in Google Ads. Copy it and paste it with the ''' 'AW-' prefix'''! Otherwise, an error will occur. More information on how to find it in the [[#Tips|Tips]] section.
 +
*'''Conversion Label''' - 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.<br/> You can configure it in the conversion settings in Google Ads to better understand the effectiveness of your ad campaigns. More information on how to find it in the [[#Tips|Tips]] section.
 +
*'''Debug Mode''' - allows you to preview the content and queries directly in Google Analytics in the DebugView 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 in the '' 'Logs' '' tab of the module.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:GAN_xxx.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:GAN_13.png]]
 
|}
 
|}
−
http://git.mglocal/whmcs-products/google-analytics/-/issues/32
 
−
 
−
The API secret key is used to identify your account. You will be asked to provide one to connect to some of our services like the Google Sheets Add-on and the API functionalities. You can find your API secret key in the API page on your dashboard. You can also create new API keys in the same section if necessary.";
 
−
 
−
A measurement ID in Google Analytics is a unique identifier for a web data stream (which is a website registered within Google Analytics). The format of a measurement ID in Google Analytics 4 is 'G-' followed by a combination of numbers and letters.";
 
−
 
−
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 .";
 
−
 
−
The "Conversion ID" is a unique identifier assigned to a specific conversion action in Google Ads. It is used to track and report 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.';
 
−
 
−
The "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 Informations allows you to monitor queries sent to Google Analytics and view their content and possible errors.';
 
−
 
−
To determine a Google Analytics 4 property Id you need to visit Google Analytics, select Admin, the Property and then property Settings. If the Property Settings shows a numeric "PROPERTY ID" such as "123...", this is the numeric Id of your Google Analytics 4 property.';
 
−
 
−
<!--
 
−
==Configurable Options==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|In order to automatically generate configurable options, simply press the button marked on the screen. <br/>
+
|style="padding: 0px 0px 15px 15px;"|'''Moreover, you may integrate Google Tags Manager with Google Analytics For WHMCS.'''<br/>
 +
To do so, provide the Container ID. You will find it by logging in to your Google Tag Manager account and opening a container.<br/> In the top right corner (next to the Submit and Preview buttons) you'll see some short text that starts with '' 'GTM-','' which is your Container ID.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:GAN_xx.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:GAN_14.png]]
 
|}
 
|}
−
-->
 
  
 
==Dashboard==
 
==Dashboard==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Let us check your new product on the product page in admin area. It should look like on the screen below.<br />
+
|style="padding: 10px 0px 15px 15px;"|'''This section provides a comprehensive overview of your website traffic and client actions, offering valuable insights into user behavior and engagement on your site.'''<br/>
 +
The dashboard includes:
 +
*'''Event Statistics Graph''' - illustrating various actions your clients perform on your website.
 +
*'''New Users Graph''' - showing the number of your new clients.
 +
*'''Active Users Graph''' - displaying the number of active user visits.
 +
*'''Page Views Graph''' -  representing the general traffic on the website.
 +
*'''Event Statistics Table''' - highlighting client actions just as the graph, but in the form of a table.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:GAN_xxx.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:GAN_15.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|You can change the scope of each dashboard element by clicking on the '' 'Change Settings' '' icon next to it.<br/>
 +
For '' 'Event Statistics' '' pick the events that are of interest to you, separate selections can be made for the graph and the table.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:GAN_16.png]]
 
|}
 
|}
  
 
==Logs==
 
==Logs==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Let us check your new product on the product page in admin area. It should look like on the screen below.<br />
+
|style="padding: 10px 0px 20px 15px;"|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.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:GAN_xxx.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:GAN_17.png]]
 
|}
 
|}
−
==Queue==
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Let us check your new product on the product page in admin area. It should look like on the screen below.<br />
+
|style="padding: 0px 0px 20px 15px;"|Multiple logs can be deleted at once with the mass action function.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:GAN_xxx.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:GAN_18.png]]
 
|}
 
|}
−
<!-- nie ma
 
−
==Client Area==
 
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|This is how the module will be displayed in the client area. Google Workspace For WHMCS also allows your customers to quickly access Google account services.
+
|style="padding: 0px 0px 20px 15px;"|Moreover additional actions include deleting specific logs, exporting the logs into a '' '.csv' '' file and setting up the auto prune system.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:GAN_xx.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:GAN_19.png]]
 
|}
 
|}
  
−
==Update of Existing Customers==
+
==Queue==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|You can link existing customer accounts by filling in the Custom Fields: '' 'GoogleApps Domain' '' and '' 'GoogleApps PurchaseOrderID'. ''<br />
+
|style="padding: 10px 0px 15px 15px;"|'''If you are using the '' 'Add Requests to Cron Queue' '' Data Sensing Method, the '' 'Queue' '' section is where the requests can be managed.'''<br/>
−
After your customers order a new subscription, they should insert their primary Google account domain name in the '' 'GoogleApps Domain' '' field.<br />
+
You will find the information on the cron itself at the top of this section.
−
Then, the new subscription will be added to that account.<br />
+
−
If you want to manually create an order for an existing subscription, in addition to the above steps, you need to find '' 'Purchase Order ID' '' (usually on the invoice).<br />
+
−
Copy the ID and paste it to the '' 'GoogleApps PurchaseOrderID'' ' field.<br />
+
−
Afterward, '''do not''' run the create command but just press the '' 'Save Changes' '' button. You can also change the status to '' 'Active'. ''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:GAN_xx.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:GAN_20.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|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.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:GAN_21.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|Multiple tasks can be deleted at once via the mass selection feature.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:GAN_22.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|The auto prune system can be set up to automatically delete tasks after a specified time.<br/>
 +
This feature can be found under additional actions.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:GAN_23.png]]
 
|}
 
|}
−
-->
 
  
 
=Tips=
 
=Tips=
 
{|
 
{|
−
|style="padding: 10px 0px 5px 15px;"|1. The module requires a G Suite Reseller account. To check the current status of your Google Reseller account, navigate to the following site: [https://partners.cloud.google.com/home Google Cloud Partner Portal].<br/> There, you can verify the status and request partner authorization if necessary.
+
|style="padding: 10px 0px 5px 15px;"|1. Once you turn the debug mode in the addon on, you will be able to track all API requests sent to Google Analytics under '' 'Admin' '' → '' 'Data display' '' → '' 'DebugView'.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 5px 15px;"|2. You may use these requests to create custom definitions under '' 'Admin' '' → '' 'Data display' '' → '' 'Custom definitions'.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|3. Follow these instructions to find your Google Ads [[#Advanced_Configuration|'''Conversion ID''']] and [[#Advanced_Configuration|'''Conversion Label''']]:
 +
*Sign in to your Google Ads account.
 +
*Go to '' 'Goals' '' → '' 'Conversions'.''
 +
*Select the name of the conversion that you want to use or create a new one.
 +
*Expand the tab for Tag setup to view the tag details.
 +
*Select Use Google Tag Manager.
 +
*Copy the Conversion ID and Conversion Label.
 
|}
 
|}
−
http://git.mglocal/whmcs-products/google-analytics/-/issues/21
 
  
 
=Update Instructions=
 
=Update Instructions=
Line 309: Line 362:
 
|style="padding: 10px 0px 30px 15px;"|Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?<br/> 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.<br/>
 
|style="padding: 10px 0px 30px 15px;"|Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?<br/> 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.<br/>
  
−
Opt for the [https://www.modulesgarden.com/products/whmcs/google-workspace#open-source-version Open Source version] of your Google Workspace For WHMCS module to unlock these benefits.<br/> 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.<br/>  
+
Opt for the [https://www.modulesgarden.com/products/whmcs/google-analytics#open-source-version Open Source version] of your Google Analytics For WHMCS module to unlock these benefits.<br/> 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.<br/>  
  
 
Follow a [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module 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.  
 
Follow a [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module 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.  
Line 316: Line 369:
 
=Common Problems=
 
=Common Problems=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
+
|style="padding: 10px 0px 10px 15px;"|'''1. When you have problems with connection, check whether your SELinux or firewall does not block ports.'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|2. Google Analytics API calculates the value of an event without including tax, so if the value seems off, make sure you keep this in mind.
 
|}
 
|}

Latest revision as of 11:43, 3 April 2025

Contents

[edit] 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 constantly monitor your customers' actions and respond to their needs immediately.

  • 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.2 Back To PHP 8.1
✔ Supports WHMCS V8.12 Back To WHMCS V8.9
✔ Requires ionCube Loader V14 Or Later
✔ Easy Module Upgrade To Open Source Version

[edit] 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. 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
3. 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
4. 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
5. 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.

[edit] Connection and API Configuration

6. Log in to Google Analytics and create an account for your website if you have not already.
GAN 4 1.png
7. 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
8. Paste them in under 'Configuration' → 'General Settings'.
GAN 6 1.png
9. Go to 'Property details' and find the 'Property ID' .
GAN 7.png
10. Copy it into the respective field under 'Dashboard' .
GAN 7 1.png
11. Visit Google Analytics Developer Site and click on 'Click on Enable the Google Analytics Data API v1'.
GA 8.png
12. Download your 'credentails.json' file and paste its contents into the Credentials field.
GA 9.png
13. Find client_email and copy the address.
GA 10.png
14. 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
15. 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
You have successfully installed Google Analytics For WHMCS and connected it with the Google Analytics platform.
GA 12 1.png

[edit] 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.

[edit] Advanced Configuration

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

First, focus on 'General Settings'.

  • Data Sending Method - choose how the data is sent to Google Analytics. You can either send API requests immediately or use the cron queue system, potentially reducing the load on WHMCS.
    The cron itself can be found in the Queue tab.
  • Conversion ID - 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. Copy it and paste it with the 'AW-' prefix! Otherwise, an error will occur. More information on how to find it in the Tips section.
  • Conversion Label - 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. More information on how to find it in the Tips section.
  • Debug Mode - allows you to preview the content and queries directly in Google Analytics in the DebugView 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 in the 'Logs' tab of the module.
GAN 13.png
Moreover, you may integrate Google Tags Manager with Google Analytics For WHMCS.

To do so, provide the Container ID. You will find it by logging in to your Google Tag Manager account and opening a container.
In the top right corner (next to the Submit and Preview buttons) you'll see some short text that starts with 'GTM-', which is your Container ID.

GAN 14.png

[edit] Dashboard

This section provides a comprehensive overview of your website traffic and client actions, offering valuable insights into user behavior and engagement on your site.

The dashboard includes:

  • Event Statistics Graph - illustrating various actions your clients perform on your website.
  • New Users Graph - showing the number of your new clients.
  • Active Users Graph - displaying the number of active user visits.
  • Page Views Graph - representing the general traffic on the website.
  • Event Statistics Table - highlighting client actions just as the graph, but in the form of a table.
GAN 15.png
You can change the scope of each dashboard element by clicking on the 'Change Settings' icon next to it.

For 'Event Statistics' pick the events that are of interest to you, separate selections can be made for the graph and the table.

GAN 16.png

[edit] 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.
GAN 17.png
Multiple logs can be deleted at once with the mass action function.
GAN 18.png
Moreover additional actions include deleting specific logs, exporting the logs into a '.csv' file and setting up the auto prune system.
GAN 19.png

[edit] 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.

GAN 20.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.
GAN 21.png
Multiple tasks can be deleted at once via the mass selection feature.
GAN 22.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.

GAN 23.png

[edit] Tips

1. Once you turn the debug mode in the addon on, you will be able to track all API requests sent to Google Analytics under 'Admin' → 'Data display' → 'DebugView'.
2. You may use these requests to create custom definitions under 'Admin' → 'Data display' → 'Custom definitions'.
3. Follow these instructions to find your Google Ads Conversion ID and Conversion Label:
  • Sign in to your Google Ads account.
  • Go to 'Goals' → 'Conversions'.
  • Select the name of the conversion that you want to use or create a new one.
  • Expand the tab for Tag setup to view the tag details.
  • Select Use Google Tag Manager.
  • Copy the Conversion ID and Conversion Label.

[edit] 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.

[edit] 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 Analytics 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.

[edit] Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. Google Analytics API calculates the value of an event without including tax, so if the value seems off, make sure you keep this in mind.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Google_Analytics_For_WHMCS&oldid=75404"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
cPanel Modules
General
FAQ
Community