omnireview/tripadvisor

Tripadvisor for omnisense/omnireview: a location's rating, its bubbles, its number of reviews, up to five reviews and the link to write one, through the Tripadvisor Content API (v1). The gateway calls:

The base address is the constant TripadvisorGateway::URL. The Content API has no sandbox. Replying and inviting are not in the Content API.

Installation

composer require omnireview/tripadvisor

Requires PHP 8.2, omnisense/omnireview (1.x) and symfony/http-client (6.4, 7 or 8). In a Symfony application with OmnireviewBundle, the factory is registered as soon as the package is installed.

Credentials

• A Content API key, from the Tripadvisor Developer portal, restricted to the site's domains (then set referer) or to the server's addresses.
• The location ID of the establishment (the d1234567 of its Tripadvisor address, without the d): it may be kept.

Options

Place fields read: id (the location ID).

Capabilities

capabilities()->gives(): rating, reviews, write-url.

Behaviour

Details. rating() and writeUrl() read the location's /details in the gateway's language, asked once per location and language for the gateway's lifetime (a PHP process, or a request in a long-running worker): a widget's rating and write link are one call.

Rating. value is rating, count num_reviews, url web_url, image rating_image_url (the bubbles, to show from Tripadvisor's address).

Reviews. limit = $limit between 1 and 5, language the call's or the option's. Each review: id, rating, text, title, language (lang), author (user.username), authorPhoto (user.avatar.small, else thumbnail), publishedAt (published_date), url (the review's page), reply from owner_response (text, published_date), translated from is_machine_translated, image the review's own bubbles (rating_image_url). No authorUrl.

Write link. The write_review of the details; a location without one is a ProviderException (The location gives no write_review link.).

Every call sends Accept: application/json, the Referer when set, a 10-second timeout.

Terms (terms()), from the Content API's display requirements (tripadvisor-content-api.readme.io/reference/display-requirements), read on 2026-10-08:

and in rules: the Tripadvisor logo (Ollie) with a rating, at least 20 pixels high, and the bubbles the API gives, at least 55 pixels wide, served from Tripadvisor's addresses - never stored nor drawn anew; a traveller's review quoted within quotation marks, with its date, as "a Tripadvisor traveler review"; the month and year of any ranking cited; the location ID may be kept. The core's widget shows the bubbles when given and names Tripadvisor in words, with data-nosnippet; the logo and the page's <meta name="robots" content="noindex"> are the application's.

Example

<?php

require __DIR__.'/vendor/autoload.php';

use Omnireview\Model\Place;
use Omnireview\Tripadvisor\TripadvisorGatewayFactory;
use Symfony\Component\HttpClient\HttpClient;

$tripadvisor = (new TripadvisorGatewayFactory(HttpClient::create()))->create([
    'api_key' => getenv('TRIPADVISOR_KEY'),
    'language' => 'fr',
    'referer' => 'https://www.maison-erable.example/',
]);

$location = new Place('1234567');
$rating = $tripadvisor->rating($location);
printf("%.1f from %d reviews - %s\n<img src=\"%s\" width=\"55\">\n", $rating->value, $rating->count, $rating->url, $rating->image);
foreach ($tripadvisor->reviews($location, 5) as $review) {
    printf("\"%s\" - %s, %s (a Tripadvisor traveler review)\n", $review->title, $review->author, $review->publishedAt?->format('F Y'));
}
echo $tripadvisor->writeUrl($location), "\n";      // no second call: the details are kept

Not run live (no key). In Symfony:

omnireview:
    gateways:
        tripadvisor:
            factory: tripadvisor
            options:
                api_key: '%env(TRIPADVISOR_KEY)%'
                language: fr
                referer: 'https://www.maison-erable.example/'

{% if omnireview_terms('tripadvisor').noIndex %}<meta name="robots" content="noindex">{% endif %}
{{ omnireview_widget('tripadvisor', location_id) }}

Errors

Verified, and not

Tested offline (Tests/TripadvisorGatewayTest.php, on MockHttpClient): the rating with its bubbles and the write link from one details call, the query (key, language) and the Referer; the reviews with limit=5, their reply, author, title, date and own bubbles; the terms (noIndex, cacheFor null); a 401 as an InvalidKeyException. The answers in Tests/Fixtures are written from the Content API's reference (/details, /reviews, the error body).

Not verified: no call was made to Tripadvisor - no key. The Caching Policy was not read.

Responsibility

An independent, unofficial client, not affiliated with Tripadvisor LLC. Whoever runs it complies with the Content API's terms (Content API terms of use): see the README's Responsibility section.