https://github.com/oveleon/contao-google-recommendation-bundle

This bundle imports Google reviews into the contao-recommendation-bundle
https://github.com/oveleon/contao-google-recommendation-bundle

contao contao-bundle google rating recommendation reviews

Last synced: 22 days ago
JSON representation

This bundle imports Google reviews into the contao-recommendation-bundle

• Host: GitHub
• URL: https://github.com/oveleon/contao-google-recommendation-bundle
• Owner: oveleon
• License: mit
• Created: 2019-09-23T07:14:20.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-02-22T08:02:08.000Z (about 1 year ago)
• Last Synced: 2025-03-20T16:49:09.034Z (about 1 month ago)
• Topics: contao, contao-bundle, google, rating, recommendation, reviews
• Language: PHP
• Homepage:
• Size: 76.2 KB
• Stars: 5
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
Contao Google Recommendation Bundle

Syncs your latest google reviews into the contao recommendation bundle.



    

    

    






---

> Working with **Contao 4.13** and **Contao 5.1** (PHP ^8.1)

---

This plugin adds the possibility to synchronize your Google reviews into your recommendation archives.

+ [Features](#features)

+ [Installation](#installation)

    + [Composer](#via-composer)

    + [Contao Manager](#via-contao-manager)

+ [Setup](#setup)

    + [Contao Recommendation Bundle](#contao-recommendation-bundle)

    + [Archive settings](#archive-settings)

    + [Syncing with Google](#synchronization)

        + [Limitations of sync](#limitations)

+ [Google](#google)

+ [Styled Reviews](#example)

## Features

- Able to synchronize your google reviews into a recommendation archive

- Able to choose the sync language for your google reviews

- Cache invalidation after import

- Automatic import once every 24 hours

- Manual synchronization for one or all archives

- Error logging

## Installation

### Via composer

```

composer require oveleon/contao-google-recommendation-bundle

```

### Via contao-manager

```

Search for contao google recommendation bundle and add it to your extensions.

```

After installing the contao-google-recommendation-bundle, you need to run a **contao install**.

## Setup

This bundle adds new fields to [Contao Recommendation Bundle](https://github.com/oveleon/contao-recommendation-bundle).

### Contao Recommendation Bundle

For a full setup, please look [here](https://github.com/oveleon/contao-recommendation-bundle/blob/master/README.md).

### Archive settings

  

    Google Reviews

  

  

    Option

    Description

  

  

    Sync with Google

    Activate to enable synchronization with Google API

  

  

    Google API Token

    Your Google API Token. More information on Google: Using API keys

  

  

    Google Places ID

    Your Google Place ID. More information on Google: Place IDs

  

  

    Language

    Here you can select the imported language for your reviews. More information on Google: Language Support

  

![Admin View: Recommendation Reader](https://www.oveleon.de/share/github-assets/contao-google-recommendation-bundle/recommendationGoogleArchive.jpg)

### Synchronization

All archives with enabled synchronization will update once every 24 hours. You are able to trigger the synchronization for each archive or for all archives.

![Admin View: Recommendation Sync](https://www.oveleon.de/share/github-assets/contao-google-recommendation-bundle/recommendationListSync.jpg)

#### Limitations

1. Currently, the Google API only allows to retrieve the last 5 reviews. This should be sufficient for daily synchronization, but does not allow an initial import of all available ratings.

2. The extension currently only allows the import of reviews with an entered text. If there is no text vavailable, the importer will skip the review.

### Google

You may encounter issues regarding using the *Google Places API* so follow the following steps to enable it and allow the usage of the API-Key:

| Error message                                                   | Solution                                                                                         |

|-----------------------------------------------------------------|--------------------------------------------------------------------------------------------------|

| API keys with referer restrictions cannot be used with this API | Enable the google places API: https://developers.google.com/maps/documentation/javascript/places |

| You must enable Billing...                                      | Enable billing for your Google Account                                                           |

Also make sure that your API-Key for the Places-API is usable by your server (IP-Address) and do not lock it to a URL (The cronjob doesn't work via URL but the IP).

For billing issues, make sure that you have to verify your payment method via https://payments.google.com/gp/w/home/paymentmethods as well.

> Any issues regarding setting up the Google API will be closed without an answer. Please read the google docs.

### Example

An example how to style your reviews on your website

![Admin View: Recommendation Example](https://www.oveleon.de/share/github-assets/contao-google-recommendation-bundle/recommendationExample.png)