GitHub - magesuite/google-customer-reviews

In order to comply with legal requirements this module introduces a google reviews e-mail consent on the success page. When placing an order, a user can see a modal that asks for consent for google reviews. There is also a google reviews logo displayed:

Installation

This module is optional.

composer require "creativestyle/magesuite-google-customer-reviews" ^1.0.0

Admin settings

Admin settings can be found in Stores -> Configuration -> MageSuite -> Google Customer Review

General settings:

Field	Options	Comment

Field	Options	Comment
Merchant ID

Badge settings:

Field	Options	Comment

Field	Options	Comment
Enabled	Yes/No
Position	Bottom Right Bottom Left Inline

Opt-in setting:

Field	Option	Comment

Field	Option	Comment
Enabled	Yes/No
Delivery time in days
GTIN Attribute

Backend

In progress

Frontend

Integration of google reviews snippet

The integration of the opt-in function is important for Google Customer Reviews. The program and surveys will only be offered on the website if it completed this step. By integrating the opt-in feature, Google can show the Google Customer Reviews opt-in option on a website and send surveys to customers who have signed up for the program.

Read through the Google Customer Reviews guidelines in advance to see if you meet the integration requirements for the opt-in feature:

Your shopping cart and payment pages must be hosted on the same domain
The confirmation page must be hosted on your own domain
<!DOCTYPE HTML> must be added to the top of each web page

Once verified, follow the integration instructions to add the code snippet below to the order confirmation page and adjust the variables as needed. Integrating the snippet is required for Google to show the opt-in for Google Customer Reviews in the shop.

Integration of google reviews logo

Indicate with the logo that the shop participates in the Google Customer Reviews program and includes the seller rating on your website.

First, paste the code snippet at the bottom of any page on your website and adjust the variables as needed. Then, check that the logo and associated text are displayed on your website as expected. Note: If there are no seller ratings, the message "No rating available" will be displayed.

Magesuite integration

In checkout_onepage_success.xml reviews-survey block is included:

<referenceContainer name="before.body.end">
    <block class="MageSuite\GoogleCustomerReviews\Block\Survey" name="magesuite.google_customer_reviews.survey" template="MageSuite_GoogleCustomerReviews::survey.phtml">
        <arguments>
            <argument name="view_model" xsi:type="object">MageSuite\GoogleCustomerReviews\ViewModel\Survey</argument>
        </arguments>
    </block>
</referenceContainer>

The badge block is included on every page (default.xml):

<referenceContainer name="before.body.end">
    <block name="magesuite.google_customer_reviews.badge" template="MageSuite_GoogleCustomerReviews::badge.phtml">
        <arguments>
            <argument name="view_model" xsi:type="object">MageSuite\GoogleCustomerReviews\ViewModel\Badge</argument>
        </arguments>
    </block>
</referenceContainer>

MageSuite Developer Documentation

GoogleCustomerReviews (optional)