On the following 2-3 releases we will iterate through some important steps and we’ll be changing the OAuth 2.0 authorization flow. Carefully read the following details and recommendations to avoid future functionality issues.
Please note that these changes will not affect the tracking functionality of the plugin. If you don’t follow the steps bellow, you’ll be probably experiencing reporting issues, meaning that the plugin will not be able to retrieve and display reports inside your WordPress install (frontend reports, backend reports, dashboard reports, and widgets).
To keep GADWP’s API Project credentials confidential, a part of the authorization flow will be handled by a dedicated Endpoint (the GADWP Endpoint). The endpoint is designed to generate access tokens which will be later used by the plugin to request reports from Google Analytics API. With the exception of the authorization flow, all requests will be made, as usual, from your server to Google Analytics API without involving a third-party endpoint or service.
If you are using your own API Project, the plugin won’t make requests to GADWP Endpoint at all. In this case you’ll be using your own client secret which will be stored in your database. When using your own API Project, all authorization requests will be made directly to Google Endpoints and APIs.
The switching process. Steps to follow
From the very begging, even when releasing major versions, we’ve tried to maintain full backwards compatibility. making the upgrade process hassle-free. Driven by the same principle, we’ve decided to make a graduate switch to the new authentication system. Basically, all new installs will use the new authorization flow, while the old plugin installs will be using the old authorization flow.
Phase 1 (current):
During this phase we will be releasing Google Analytics Dashboard for WP v5.2. The upgrade to this version is highly recommended.
On GADWP v5.2:
- new installs and re-installs of the plugin will be using a GADWP Endpoint
- after updating, an already authorized plugin will continue to use the old authorization flow.
During this phase we will be releasing Google Analytics Dashboard for WP v6.0.
On GADWP v6.0:
- all new plugin installs will be using the GADWP Endpoint
- after updating, a plugin using the old authorization flow will be using the GADWP Endpoint
During this phase we will disable the old API Project credentials.
After retiring the old API Project credentials:
- older versions of the plugin (versions lower than v5.2) won’t be able to display reports anymore
- to be able to restore the plugin’s full functionality you’ll have to upgrade to at least GADWP v5.2 and to re-authorize the plugin
- the tracking component of the plugin won’t be affected, no matter the version of the plugin you are using
If you’re experiencing connection issues or SSL errors, while authorizing, please contact your hosting provider and ask them to check the PHP cURL SSL connection to https://gadwp.deconf.com. Common client errors are generated by outdated CA certificates bundles or broken PHP cURL setups.