Skip to content

Commit 2555e3e

Browse files
author
lman-odoo
committed
[IMP] website/analytics: add warning
task-4853660 closes #14055 X-original-commit: e02f376 Signed-off-by: Larissa Manderfeld (lman) <lman@odoo.com>
1 parent 5aa9ce8 commit 2555e3e

File tree

1 file changed

+33
-22
lines changed

1 file changed

+33
-22
lines changed

content/applications/websites/website/reporting/analytics.rst

Lines changed: 33 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,18 @@ Plausible.io
1818
============
1919

2020
Odoo hosts its own Plausible.io server and provides a free and ready-to-use Plausible.io
21-
solution for **Odoo Online** databases that use the odoo.com domain. Odoo automatically creates and sets up
22-
your account. Start using it by going to :menuselection:`Website --> Reporting --> Analytics`.
21+
solution for **Odoo Online** databases that use the odoo.com domain. Odoo automatically creates and
22+
sets up your account. Start using it by going to :menuselection:`Website --> Reporting -->
23+
Analytics`.
2324

2425
.. note::
25-
- If you use a custom :doc:`domain name <../configuration/domain_names>` (e.g., `example.com`), you need to
26-
create your own Plausible.io account and subscription.
26+
- If you use a custom :doc:`domain name <../configuration/domain_names>` (e.g., `example.com`),
27+
you need to create your own Plausible.io account and subscription.
2728
- **If you already have a Plausible.io account** and you want to connect it to your Odoo Online
2829
database, you must create two `ir.config.parameters` to use Plausible.io's servers. To do so,
2930
enable the :ref:`developer mode <developer-mode>` and go to :menuselection:`General Settings -->
30-
Technical --> System Parameters`. Click :guilabel:`New` and fill in the following :guilabel:`Key`
31-
and :guilabel:`Value` fields:
31+
Technical --> System Parameters`. Click :guilabel:`New` and fill in the following
32+
:guilabel:`Key` and :guilabel:`Value` fields:
3233

3334
.. list-table::
3435
:header-rows: 1
@@ -42,25 +43,33 @@ your account. Start using it by going to :menuselection:`Website --> Reporting -
4243

4344
Then, follow the steps below to connect your existing account with Plausible.io servers.
4445

46+
.. warning::
47+
Deactivating the free Plausible.io account linked to your **Odoo Online** database
48+
will also invalidate the existing keys, making them unusable. As a result, new
49+
keys will be generated, and all historical data linked to the old keys will be lost. If you
50+
plan to deactivate the account, it is recommended to back up your data locally beforehand.
51+
4552
If your database is hosted on **Odoo.sh** or **On-premise**, or if you wish to use your own
4653
Plausible.io account, proceed as follows:
4754

4855
#. Create or sign in to a Plausible.io account using the following link: `<https://plausible.io/register>`_.
49-
#. If you are creating a new account, go through the registration and activation steps. On the :guilabel:`Add website
50-
info` page, add the :guilabel:`Domain` of your website without including `www` (e.g.,
51-
`example.odoo.com`) and change the :guilabel:`Reporting Timezone`, if necessary. Click
52-
:guilabel:`Install Plausible` to proceed to the next step. Ignore the :guilabel:`Manual installation`
53-
instructions and click :guilabel:`Start collecting data`.
56+
#. If you are creating a new account, go through the registration and activation steps.
57+
On the :guilabel:`Add website info` page, add the :guilabel:`Domain` of your website without
58+
including `www` (e.g., `example.odoo.com`) and change the :guilabel:`Reporting Timezone`,
59+
if necessary. Click :guilabel:`Install Plausible` to proceed to the next step. Ignore the
60+
:guilabel:`Manual installation` instructions and click :guilabel:`Start collecting data`.
5461
#. Once done, click the Plausible.io logo in the upper-left part of the page to access your `list of
55-
websites <https://plausible.io/sites>`_, then click the :icon:`fa-ellipsis-v` (:guilabel:`ellipsis`) icon next to the
56-
website and select :icon:`fa-cog` :guilabel:`Settings` from the drop-down menu.
62+
websites <https://plausible.io/sites>`_, then click the :icon:`fa-ellipsis-v`
63+
(:guilabel:`ellipsis`) icon next to the website and select :icon:`fa-cog` :guilabel:`Settings`
64+
from the drop-down menu.
5765

5866
.. image:: analytics/plausible-gear-icon-settings.png
5967
:alt: Click the gear icon in the list of websites.
6068

6169
#. In the sidebar, select :guilabel:`Visibility`, then click :guilabel:`Add Shared link`.
62-
#. Enter a :guilabel:`Name`, leave the :guilabel:`Password (optional)` field empty, as the Plausible analytics
63-
dashboard integration in Odoo does not support it, then click :guilabel:`Create shared link`.
70+
#. Enter a :guilabel:`Name`, leave the :guilabel:`Password (optional)` field empty, as the Plausible
71+
analytics dashboard integration in Odoo does not support it, then click :guilabel:`Create
72+
shared link`.
6473

6574
#. Copy the shared link.
6675

@@ -75,7 +84,8 @@ Plausible.io account, proceed as follows:
7584
If you have :doc:`multiple websites <../configuration/multi_website>`, add your websites to your
7685
Plausible.io account by going to `<https://plausible.io/sites>`_ and clicking :guilabel:`+ Add
7786
Website`. In Odoo, in the **Website settings**, make sure to select the website in the
78-
:guilabel:`Settings of Website` field at the top of the page before pasting the :guilabel:`Shared link`.
87+
:guilabel:`Settings of Website` field at the top of the page before pasting the
88+
:guilabel:`Shared link`.
7989

8090
.. note::
8191
Odoo automatically pushes two custom goals: `Lead Generation` and `Shop`.
@@ -93,9 +103,9 @@ To follow your Odoo website's traffic with Google Analytics:
93103
#. Create or sign in to a Google account using the following link: `<https://analytics.google.com>`_.
94104
#. - If you are setting up Google Analytics for the first time, click :guilabel:`Start measuring`
95105
and go through the account creation step.
96-
- If you already have a Google Analytics account, sign in and click the :icon:`fa-cog` icon in the
97-
bottom-left corner of the page to access the **Admin** page. Then, click :guilabel:`+ Create` and select
98-
:guilabel:`Property` from the drop-down menu.
106+
- If you already have a Google Analytics account, sign in and click the :icon:`fa-cog` icon
107+
in the bottom-left corner of the page to access the **Admin** page. Then, click
108+
:guilabel:`+ Create` and select :guilabel:`Property` from the drop-down menu.
99109

100110
#. Complete the next steps: `property creation <https://support.google.com/analytics/answer/9304153?hl=en/&visit_id=638278591144564289-3612494643&rd=2#property>`_,
101111
business details and business objectives.
@@ -119,7 +129,8 @@ To follow your Odoo website's traffic with Google Analytics:
119129
If you have :doc:`multiple websites <../configuration/multi_website>` with separate domains, it
120130
is recommended to create `one property <https://support.google.com/analytics/answer/9304153?hl=en/&visit_id=638278591144564289-3612494643&rd=2#property>`_
121131
per domain. In Odoo, in the **Website settings**, make sure to select the website in the
122-
:guilabel:`Settings of Website` field at the top of the page before pasting the :guilabel:`Measurement ID`.
132+
:guilabel:`Settings of Website` field at the top of the page before pasting the
133+
:guilabel:`Measurement ID`.
123134

124135
.. seealso::
125136
`Google documentation on setting up Analytics for a website
@@ -136,8 +147,8 @@ app, directly through the code injector.
136147

137148
.. note::
138149
:abbr:`GTM (Google Tag Manager)` is not an analytics tool and does not offer reporting features;
139-
it is used to collect data and works alongside Google Analytics to provide more detailed insights.
140-
In order to use GTM properly, it is recommended to configure Google Analytics as well.
150+
it is used to collect data and works alongside Google Analytics to provide more detailed
151+
insights. In order to use GTM properly, it is recommended to configure Google Analytics as well.
141152

142153
For more information refer to the `documentation on linking Google Analytics and
143154
Google Tag Manager <https://support.google.com/tagmanager/answer/9442095?hl=en>`_.

0 commit comments

Comments
 (0)