Google Analytic Modules: Difference between revisions
No edit summary |
No edit summary |
||
| (26 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
==About Google | ==About Google Analytics Modules== | ||
WHMCS addon module that allows the clients to see Google | This is a WHMCS addon module that allows the clients to see Google analytics reports through different chart visualizations. The module will allow you to see the data studio that's configured by the admin for a particular client. This module also has the feature regarding Google Analytics 4 (GA4).It is a new property designed for the future of measurement . It collects both website and app data to better understand the customer journey . It uses event-based data instead of session-based. Using GA4 , it helps in d irect integrations to media platforms and drive actions on your website or app | ||
'''Note:''' On July 1, 2023, standard (UA)Universal Analytics properties will no longer process data. You'll be able to see your Universal Analytics reports for a period of time after July 1, 2023. However, new data will only flow into (GA4)Google Analytics 4 properties. | |||
==Requirements== | ==Requirements== | ||
| Line 21: | Line 23: | ||
'''3.''' Click Activate under the "Google Analytics" addon. The addon is now activated within your WHMCS. | '''3.''' Click Activate under the "Google Analytics" addon. The addon is now activated within your WHMCS. | ||
==How to | ==How to setup google analytics module== | ||
'''1.''' To see the reports of google | '''1.''' To see the reports of google analytics, you should have your google credentials. If you don’t have your google credential , then follow the steps from the given link. | ||
Reference link to create Google credentials - | Reference link to create Google credentials - | ||
[https://developers.google.com/identity/gsi/web/guides/get-google-api-clientid/ Link] We have defined the callback URL , Use this link as callback url in your Google Api Console | [https://developers.google.com/identity/gsi/web/guides/get-google-api-clientid/ Link] We have defined the callback URL , Use this link as callback url in your Google Api Console. | ||
[[File:Google Analy 2.png|800px|thumb|center]] | [[File:Google Analy 2.png|800px|thumb|center]] | ||
'''2.''' After getting the google credentials fill the details and tick on Administrator then click Save Changes button. Now this module is ready to use | '''2.''' After getting the google credentials fill the details and tick on Administrator then click on Save Changes button. Now this module is ready to use. | ||
==How to configure the Admin side for Google account connection and Google Analytics report type== | |||
'''1.''' Login to the admin area. | |||
'''2.''' Click on Addon > Google Analytics. | |||
:* This page will show the all client list with status of client’s google connection If the client is connected then it will show a button to Disconnect with Google, It will also show the account list for google analytics reports otherwise it will show a button to Connect with Google. | |||
:* Admin can configure the Report type of google analytics account. | |||
. | |||
:* Admin can configure the account from the account list to show the report on client side. | |||
:* Admin can configure the Data studio of selected client and admin also can update the data studio any time. | |||
[[File:Google Analy 3.png|800px|thumb|center]] | [[File:Google Analy 3.png|800px|thumb|center]] | ||
'''3.''' When admin user will click on Connect with Google button the page will redirect to the google authentication page | '''3.''' When admin user will click on "Connect with Google" button the page will redirect to the google authentication page. | ||
[[File:Google Analy 4.png|800px|thumb|center]] | [[File:Google Analy 4.png|800px|thumb|center]] | ||
'''4.''' After successfully authentication it will redirects to same page with a success message and select the account list option , admin user can set an account from the account list for Google Analytics reporting | '''4.''' After successfully authentication it will redirects to same page with a success message and select the account list option , admin user can set an account from the account list for Google Analytics reporting. | ||
[[File:Google Analy 5.png|800px|thumb|center]] | [[File:Google Analy 5.png|800px|thumb|center]] | ||
| Line 50: | Line 60: | ||
==How to set the Data studio Report== | ==How to set the Data studio Report== | ||
'''1.''' Click the Configure Data Studio button, it will show a popup window, | '''1.''' Click the "Configure Data Studio" button, it will show a popup window, fill the iframe. | ||
'''2.''' Click on the check button to validate the iframe and then click on the submit button | '''2.''' Click on the check button to validate the iframe and then click on the submit button. | ||
:* Also, the Admin | :* Also, the Admin can update existing Data Studio details for a client. | ||
[[File:Google Analy 6.png|800px|thumb|center]] | [[File:Google Analy 6.png|800px|thumb|center]] | ||
| Line 60: | Line 70: | ||
'''Note: Only admin users can set the Data Studio. Data studio will visible to client only if the admin user has set it for the client''' | '''Note: Only admin users can set the Data Studio. Data studio will visible to client only if the admin user has set it for the client''' | ||
==How Admin can set the | ==How Admin can set the Required product list== | ||
'''1.''' Go to client Area menu tab. | |||
'''2.''' Now select the required products you want to select and click on save changes. | |||
[[File:Google Analy 7.png|800px|thumb|center]] | [[File:Google Analy 7.png|800px|thumb|center]] | ||
'''Note: If admin user has not selected any product then google analytics reports is visible to all client otherwise the report will show to only those user who have the service related to the selected products Client has at least one service related to the selected products, only then he can use the google analytics options''' | |||
Admin user can hide the reports for selected clients | ==How to Hide Analytics Report for client== | ||
Admin user can hide the reports for selected clients. | |||
'''1.''' Go to client Area menu tab. | |||
'''2.''' And select the client from the Hide Analytics Report and click on save changes. | |||
[[File:Google Analy 8.png|800px|thumb|center]] | [[File:Google Analy 8.png|800px|thumb|center]] | ||
Admin user can set the menu label and names for visibility on client area | Admin user can set the menu label and names for visibility on client area. | ||
There will be three menus on the clientarea. | |||
1. Analytics | |||
2. Data studio | |||
3. Analytics Setting | |||
You can add a parent menu name for all the options your sub menu will be visible under the parent menu. | |||
[[File:MicrosoftTeams-image (88).png|800px|thumb|center]] | |||
==How the navigation menu works and how client can add icons and change menu names== | |||
Admin can add a parent menu name for all the options your sub menu will be visible under the parent menu. | |||
'''1.''' Admin have to select the menu type of the label , if he had selected the child then admin can add a parent menu name otherwise the label name will be his parent menu name and also for the child menu name. | |||
'''2.''' Admin can add the Menu Label name for the navigation tab | |||
'''3.''' Admin can add the font awesome icon for the navigation | |||
'''4.''' Admin can set the order number for visibility of the navigation | |||
'''5.''' Admin user select the clients if he wants to hide specific menu navigation to particular clients. | |||
'''Note : Admin user can change the these name and label name any time''' | |||
*Case 1: Menu type child | |||
When menu type will be child then there will be option to add parent menu name and then the entered menu label name will be visible under the parent menu name | |||
[[File:Unnamed (88).png|800px|thumb|center]] | |||
The '''output''' will be look like this | |||
[[File:Unnamed goooooogleee.png|800px|thumb|center]] | |||
*Case 2: Menu type parent | |||
When menu type will be parent then there will a single navigation menu on clientarea | |||
[[File:Unnamed (90).png|800px|thumb|center]] | |||
The '''output''' will be look like this | |||
[[File:Unnamed (91).png|800px|thumb|center]] | |||
'''NOTE:''' Admin user can add for all three type navigation all will be work same as above defined. If there is same Parent menu name for all the three options then all the sub menu name will be visible under single parent navigation | |||
Output : If there is same parent name for all three options | |||
[[File:Google Analy 133.png|800px|thumb|center]] | |||
If you have added same parent menu for the three options then all will be under the same parent menu label. | |||
For example, we have same parent menu for all the three option so all menu labels are showing under same parent menu. | |||
[[File:MicrosoftTeams-image (89).png|800px|thumb|center]] | |||
==How client area menu will shown to your clients== | |||
'''1.''' Go to module settings under Addon > Google Analytics in the admin area. | |||
[[File:Google Analy 10.png|800px|thumb|center]] | |||
:* WHMCS user also can connect his account with the google analytics. After connecting the account by ownself he can select the report type and select the account also , but if the google connection has been made by admin user then he will not be able to change the account for reporting. | |||
==Client can see the google analytics report== | |||
:*It will show a google analytics report with four different charts. | |||
By default, it shows the reports of the last 30 days. Clients can easily set the start and end dates from the date range option. | |||
[[File:Google Analy 11.png|800px|thumb|center]] | |||
==Client can connect with his own account with google analytics== | |||
:*If the Client has not connected with the google account it will redirect to the settings page for connecting. | |||
[[File:Google Analy 12.png|800px|thumb|center]] | |||
:* After Successfully connecting with Google, the client can select the account for reporting. | |||
If the client is already connected with google then get the option to Disconnect with google. | |||
==Client can see the data studio== | |||
If Admin user has set Data Studio for a client only then the client can see an option Data Studio under Google Analytics. | |||
[[File:Google Analy | [[File:Google Analy 13.png|800px|thumb|center]] | ||
Latest revision as of 07:31, 9 December 2022
About Google Analytics Modules[edit | edit source]
This is a WHMCS addon module that allows the clients to see Google analytics reports through different chart visualizations. The module will allow you to see the data studio that's configured by the admin for a particular client. This module also has the feature regarding Google Analytics 4 (GA4).It is a new property designed for the future of measurement . It collects both website and app data to better understand the customer journey . It uses event-based data instead of session-based. Using GA4 , it helps in d irect integrations to media platforms and drive actions on your website or app
Note: On July 1, 2023, standard (UA)Universal Analytics properties will no longer process data. You'll be able to see your Universal Analytics reports for a period of time after July 1, 2023. However, new data will only flow into (GA4)Google Analytics 4 properties.
Requirements[edit | edit source]
1. License Key
2. Client ID
3. Secret Key
How to upload the module files[edit | edit source]
1. Download the zip file and extract it under whmcs_installation_dir/.
2. Now login to the WHMCS Admin panel and navigate to Configuration > System Settings > Addon Modules or prior to WHMCS 8.0 Setup > Addon Modules and addon will be listed.
3. Click Activate under the "Google Analytics" addon. The addon is now activated within your WHMCS.
How to setup google analytics module[edit | edit source]
1. To see the reports of google analytics, you should have your google credentials. If you don’t have your google credential , then follow the steps from the given link.
Reference link to create Google credentials - Link We have defined the callback URL , Use this link as callback url in your Google Api Console.
2. After getting the google credentials fill the details and tick on Administrator then click on Save Changes button. Now this module is ready to use.
How to configure the Admin side for Google account connection and Google Analytics report type[edit | edit source]
1. Login to the admin area.
2. Click on Addon > Google Analytics.
- This page will show the all client list with status of client’s google connection If the client is connected then it will show a button to Disconnect with Google, It will also show the account list for google analytics reports otherwise it will show a button to Connect with Google.
- Admin can configure the Report type of google analytics account.
.
- Admin can configure the account from the account list to show the report on client side.
- Admin can configure the Data studio of selected client and admin also can update the data studio any time.
3. When admin user will click on "Connect with Google" button the page will redirect to the google authentication page.
4. After successfully authentication it will redirects to same page with a success message and select the account list option , admin user can set an account from the account list for Google Analytics reporting.
How to set the Data studio Report[edit | edit source]
1. Click the "Configure Data Studio" button, it will show a popup window, fill the iframe.
2. Click on the check button to validate the iframe and then click on the submit button.
- Also, the Admin can update existing Data Studio details for a client.
Note: Only admin users can set the Data Studio. Data studio will visible to client only if the admin user has set it for the client
How Admin can set the Required product list[edit | edit source]
1. Go to client Area menu tab.
2. Now select the required products you want to select and click on save changes.
Note: If admin user has not selected any product then google analytics reports is visible to all client otherwise the report will show to only those user who have the service related to the selected products Client has at least one service related to the selected products, only then he can use the google analytics options
How to Hide Analytics Report for client[edit | edit source]
Admin user can hide the reports for selected clients.
1. Go to client Area menu tab.
2. And select the client from the Hide Analytics Report and click on save changes.
Admin user can set the menu label and names for visibility on client area.
There will be three menus on the clientarea.
1. Analytics
2. Data studio
3. Analytics Setting
You can add a parent menu name for all the options your sub menu will be visible under the parent menu.
.png)
[edit | edit source]
Admin can add a parent menu name for all the options your sub menu will be visible under the parent menu.
1. Admin have to select the menu type of the label , if he had selected the child then admin can add a parent menu name otherwise the label name will be his parent menu name and also for the child menu name.
2. Admin can add the Menu Label name for the navigation tab
3. Admin can add the font awesome icon for the navigation
4. Admin can set the order number for visibility of the navigation
5. Admin user select the clients if he wants to hide specific menu navigation to particular clients.
Note : Admin user can change the these name and label name any time
- Case 1: Menu type child
When menu type will be child then there will be option to add parent menu name and then the entered menu label name will be visible under the parent menu name
.png)
The output will be look like this
- Case 2: Menu type parent
When menu type will be parent then there will a single navigation menu on clientarea
.png)
The output will be look like this
.png)
NOTE: Admin user can add for all three type navigation all will be work same as above defined. If there is same Parent menu name for all the three options then all the sub menu name will be visible under single parent navigation
Output : If there is same parent name for all three options
If you have added same parent menu for the three options then all will be under the same parent menu label. For example, we have same parent menu for all the three option so all menu labels are showing under same parent menu.
.png)
[edit | edit source]
1. Go to module settings under Addon > Google Analytics in the admin area.
- WHMCS user also can connect his account with the google analytics. After connecting the account by ownself he can select the report type and select the account also , but if the google connection has been made by admin user then he will not be able to change the account for reporting.
Client can see the google analytics report[edit | edit source]
- It will show a google analytics report with four different charts.
By default, it shows the reports of the last 30 days. Clients can easily set the start and end dates from the date range option.
Client can connect with his own account with google analytics[edit | edit source]
- If the Client has not connected with the google account it will redirect to the settings page for connecting.
- After Successfully connecting with Google, the client can select the account for reporting.
If the client is already connected with google then get the option to Disconnect with google.
Client can see the data studio[edit | edit source]
If Admin user has set Data Studio for a client only then the client can see an option Data Studio under Google Analytics.
