gabrielfs7 / google-trends

src/Search/InterestByRegionSearch.php

<?php declare(strict_types=1);

namespace GSoares\GoogleTrends\Search;

use GSoares\GoogleTrends\Error\GoogleTrendsException;
use GSoares\GoogleTrends\Result\InterestByRegionCollection;
use GSoares\GoogleTrends\Result\InterestByRegionResult;
use GSoares\GoogleTrends\Result\ResultCollectionInterface;

/**
 * @author Gabriel Felipe Soares <gabrielfs7@gmail.com>
 */
class InterestByRegionSearch implements SearchInterface
{
    private const SEARCH_URL = 'https://trends.google.com/trends/api/widgetdata/comparedgeo';

    /**
     * @var ExploreSearch
     */
    protected $exploreSearch;

    /**
     * @var SearchRequest
     */
    protected $searchRequest;

    public function __construct(ExploreSearch $exploreSearch = null, SearchRequest $searchRequest = null)
    {
        $this->searchRequest = $searchRequest ?: new SearchRequest();
        $this->exploreSearch = $exploreSearch ?: new ExploreSearch($this->searchRequest);
    }

    /**
     * @param SearchFilter $searchFilter
     *
     * @return InterestByRegionCollection
     *
     * @throws GoogleTrendsException
     */
    public function search(SearchFilter $searchFilter): ResultCollectionInterface
    {
        $token = $this->exploreSearch
            ->search($searchFilter)
            ->getInterestByRegionResult()
            ->getToken();

        $searchUrl = $this->buildQuery($searchFilter->withToken($token));

        $responseDecoded = $this->searchRequest->search($searchUrl);

        if (!isset($responseDecoded['default']['geoMapData'])) {
            throw new GoogleTrendsException(
                sprintf(
                    'Invalid google response body "%s"...',
                    substr(var_export($responseDecoded, true), 100)
                )
            );
        }

        $results = [];

        foreach ($responseDecoded['default']['geoMapData'] ?? [] as $row) {
            if (!isset($row['geoCode'], $row['geoName'], $row['value'], $row['maxValueIndex'])) {
                throw new GoogleTrendsException(
                    sprintf(
                        'Google compared geo list does not contain all keys. Only has: %s',
                        implode(', ', array_keys($row))
                    )
                );
            }

            $results[] = new InterestByRegionResult(
                $row['geoCode'],
                $row['geoName'],
                (int)($row['value'][0] ?? 0),
                (int)$row['maxValueIndex'],
                (bool)($row['hasData'] ?? false)
            );
        }

        return new InterestByRegionCollection($searchUrl, ...$results);
    }

    private function buildQuery(SearchFilter $searchFilter): string
    {
        $request = [
            'geo' => [
                'country' => $searchFilter->getLocation(),
            ],
            'comparisonItem' => [
                [
                    'time' => $searchFilter->getTime(),
                ],
            ],
            'resolution' => 'REGION',
            'locale' => $searchFilter->getLanguage(),

The method GSoares\GoogleTrends\Search\SearchFilter::getLanguage() has been deprecated with message: Will be removed, cause other languages do not work as filter. We should utilize only location

            'requestOptions' => [
                'property' => '',
                'backend' => 'IZG',
                'category' => $searchFilter->getCategory(),
            ]
        ];

        if (!empty($searchFilter->getSearchTerm())) {
            $request['comparisonItem'][0]['complexKeywordsRestriction'] = [
                'keyword' => [
                    [
                        'type' => 'BROAD',
                        'value' => $searchFilter->getSearchTerm(),
                    ],
                ],
            ];
        }

        $query = [
            'hl' => $searchFilter->getLanguage(),

The method GSoares\GoogleTrends\Search\SearchFilter::getLanguage() has been deprecated with message: Will be removed, cause other languages do not work as filter. We should utilize only location

            'tz' => '-60',
            'req' => json_encode($request),
            'token' => $searchFilter->getToken()
        ];

        $queryString = str_replace(
            [
                '%3A',
                '%2C',
                '%2B'
            ],
            [
                ':',
                ',',
                '+',
            ],
            http_build_query($query)
        );

        return self::SEARCH_URL . '?' . $queryString;
    }
}