Personal tools
Namespaces

Variants
Actions

Google Analytics For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(Undo revision 69215 by Szymon Kaczmarski (talk))
(Undo revision 69214 by Szymon Kaczmarski (talk))
Line 146: Line 146:
 
{|
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:GAN_11.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:GAN_11.png]]
 +
|}
 +
 +
==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 />
 +
Click on '' 'Create a New Group'.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:GAN_12.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|'''17. Enter your product group name and press '' 'Save Changes'.'''''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:GAN_13.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|'''18. Now, create a new product for your GoogleApps.'''<br/>
 +
To do so, first click on '' 'Create a New Product'.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:GAM_14.png]]
 +
|}
 +
{|
 +
|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_15.png]]
 +
|}
 +
{|
 +
|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/>
 +
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 20px 15px;"|'''21. Enter your previously obtained '' 'Client ID' as well as 'Client Secret' '' and make sure that '' 'Callback URL' '' is correct.<br/>
 +
Then, press '' 'Grant access with Google account'. '''''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:GAN_17.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 20px 25px;"|[[File:GAN_18.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 25px;"|[[File:GAN_19.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 30px 25px;"|[[File:GAN_20.png]]
 
|}
 
|}
  

Revision as of 14:24, 8 July 2024

Contents

About Google Analytics For WHMCS

Google Analytics For WHMCS will ena.............
  • Admin Area Features:
✔ Create/Suspend/Unsuspend/Terminate Account
  • General Info:
✔ Requires Google Cloud Partner Program / Reseller Account
✔ Authentication And API Calls Utilize OAuth 2.0
✔ Multi-Language Support
✔ Supports PHP 8.1 Back To PHP 7.4
✔ Supports WHMCS Themes "Six" And "Twenty-One"
✔ Supports WHMCS V8.10 Back To WHMCS V8.6
✔ Requires ionCube Loader V12 Or Later
✔ Easy Module Upgrade To Open Source Version

Installation and Authentication

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

API Configuration

6. Now you have to authenticate the module through setting up the API Access.

Create API Access in Google API Console. You can do it here → https://console.developers.google.com/apis/dashboard

7. After you have logged in, create a new project.
GAN 5.png
8. To proceed, go to 'Google APIs' under the 'Overview' tab.

Find 'Google Apps Reseller API' among the applications.

GAN 6 1.png
9. Now, you have to enable 'Google Apps Reseller API' as shown on the following screen.
GAN 7.png
10. Next, search for the 'Admin SDK' the same way you did it in step 9.
GAN 7 1.png
11. Enable 'Admin SDK' API.
GA 8.png
12. Finally, open the 'Explore and enable API' section, the API & Services page should open. Go to 'OAuth consent screen' under the 'Credentials' section.

Afterward, enter the mail address and application name that will be visible during your requests.
Here is a list of scopes required by the module to work properly:

  • admin.directory.user
  • apps.order
  • apps.order.readonly
  • userinfo.profile

Save changes through pressing the 'Save' button.

File:GAN 6.png
13. Then, switch to the 'Credentials' tab and add new credentials .
File:GAN 9.png
14. After you have done that, tick 'Web application'.

Next, enter your website URL into the 'Authorized JavaScript origins' field and correct path to 'oauth_callback.php' into the 'Authorized redirect URI' field.
Confirm changes by pressing 'Create'.

File:GAN 10.png
15. Well done! Now that you have filled in all the necessary details, you can proceed to authenticate Google Apps.
File:GAN 11.png

Product Configuration

16. In order to create and configure a product, go to 'Setup' → 'Products/Services' → 'Products/Services'.

Click on 'Create a New Group'.

File:GAN 12.png
17. Enter your product group name and press 'Save Changes'.
GAN 13.png
18. Now, create a new product for your GoogleApps.

To do so, first click on 'Create a New Product'.

File:GAM 14.png
19. Choose the desired product type and product group from the dropdown menus and enter a new name of your products. Press 'Continue'.
GAN 15.png
20. Go to 'Module Settings' of your product and choose 'G Suite' from the 'Module Name' dropdown menu.

After choosing the module, make sure to click on the 'Save Changes' button.

GAN 16.png
21. Enter your previously obtained 'Client ID' as well as 'Client Secret' and make sure that 'Callback URL' is correct.

Then, press 'Grant access with Google account'.

GAN 17.png
22. You will be redirected to the page with a permission request if the data you entered is correct. Press the 'Allow access' button.
GAN 18.png
23. That is it. You will be now redirected to your WHMCS and you will see the following screen.
GAN 19.png
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.
GAN 20.png

Configuration and Management

Configuration and management of Google Workspace For WHMCS is very intuitive. Read the below sections to see how easy it is.

Basic Configuration

Let us begin the process of module .....
File:GAN xxx.png


Configurable Options

In order to automatically generate configurable options, simply press the button marked on the screen.
File:GAN xx.png

Admin Area

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

Client Area

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.
File:GAN xx.png

Update of Existing Customers

You can link existing customer accounts by filling in the Custom Fields: 'GoogleApps Domain' and 'GoogleApps PurchaseOrderID'.

After your customers order a new subscription, they should insert their primary Google account domain name in the 'GoogleApps Domain' field.
Then, the new subscription will be added to that account.
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).
Copy the ID and paste it to the 'GoogleApps PurchaseOrderID ' field.
Afterward, do not run the create command but just press the 'Save Changes' button. You can also change the status to 'Active'.

File:GAN xx.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.

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=69217"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
cPanel Modules
General
FAQ
Community