oveleon/contao-google-recommendation-bundle

Google Places API integration for Contao Recommendation Bundle

1.3.0 2023-06-01 17:48 UTC

Requires

• php: ^8.1
• contao/core-bundle: ^4.13 || ^5.1
• oveleon/contao-recommendation-bundle: ^1.3

Requires (Dev)

• contao/manager-plugin: ^2.3.1
• contao/test-case: ^5.1
• phpunit/phpunit: ^9.5
• symfony/http-client: ^5.4 || ^6.0
• symfony/phpunit-bridge: ^5.4 || ^6.0

Conflicts

• contao/core: *
• contao/manager-plugin: <2.0 || >=3.0

MIT

• Oveleon
• Sebastian Zoglowek
• Fabian Ekert

• contao
• google-recommendation-bundle

README

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
• Installation
  • Composer
  • Contao Manager
• Setup
  • Contao Recommendation Bundle
  • Archive settings
  • Syncing with Google
    • Limitations of sync
• Google
• Styled Reviews

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.

Contao Recommendation Bundle

For a full setup, please look here.

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

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.

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