如何使用PHP客户端进行谷歌自定义搜索引擎简单示例谷歌先决条件一个经过全面评论的示例

我觉得这是我的一个愚蠢的错误,但我不知道如何使用google-api-php-client进行简单的搜索。我的目标是对我的网站的谷歌搜索引擎运行简单的关键字查询。

我已经创建了我的api密钥,一个谷歌搜索引擎并下载了api客户端的一个版本,但是php客户端的Google网站似乎没有任何关于如何使用客户端的文档,到目前为止,我发现的唯一相关示例专门用于搜索Google的图书服务。问题是,该示例意味着不同的搜索服务具有不同的搜索结果类型,并且我找不到有关如何从 中检索结果的任何文档。Google_Service

我想我可以设置一个像这样的简单搜索,但我不知道如何实际检索结果。

include_once __DIR__ . '/vendor/autoload.php';
...
public function __construct($searchTerm) {
    $client = new Google_Client();
    $client->setApplicationName("My_First_Search");
    $client->setDeveloperKey(self::GCSE_API_KEY);
    $service = new Google_Service($client);
    $optParams = array('filter' => $searchTerm);
    $results = $service->???

文档必须在那里,但它不在任何明显的地方.

更新 (1/14/17)

(2017年1月21日更新:实际上,这些文档对我没有多大帮助,但我会把它们留给FYI)

我使用phpdoc为谷歌生成api文档。我做了一个存储库,并将phpdocs和库放在github上phpdocs可以在这里浏览apiclient

所以希望这对某人有所帮助。不幸的是,即使有了文档,我也很难解开正确的用法。我还没有为google apiclient-services软件包生成文档,因为它们很大,但是如果有必要,我可以这样做(取决于github页面上的磁盘限制)。


答案 1

感谢@gennadiy把我放在正确的轨道上。如果没有他用来检索结果的建议,我可能会放弃并去寻找另一个图书馆。幸运的是,这几乎是我使用这个库所需要的一切,所以我认为我已经准备好了。->cse->listCse()

简单示例

执行搜索非常简单;它基本上看起来像这样:

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

$GCSE_API_KEY = "nqwkoigrhe893utnih_gibberish_q2ihrgu9qjnr";
$GCSE_SEARCH_ENGINE_ID = "937592689593725455:msi299dkne4de";

$client = new Google_Client();
$client->setApplicationName("My_App");
$client->setDeveloperKey($GCSE_API_KEY);
$service = new Google_Service_Customsearch($client);
$optParams = array("cx"=>self::GCSE_SEARCH_ENGINE_ID);    
$results = $service->cse->listCse("lol cats", $optParams);

结果对象实现了迭代器,因此我们可以按如下方式循环访问它们:

foreach($results->getItems() as $k=>$item){
    var_dump($item);
}

谷歌先决条件

但是,为了使用此库,您必须先设置一些Google内容。这些东西最终在Google API Client Libraries PHP(Beta)网站上被提及,但你必须点击并挖掘它们,即使这样,你也会错过下面的最后一个:

  1. 您将需要一个自定义搜索引擎。不要对这样一个事实感到困惑,即互联网上对自定义搜索引擎的大多数引用都是为那些尝试进行程序搜索的人提供的。你需要一个,它们很容易在这里设置:https://cse.google.com/cse/all
  2. 您将需要一个谷歌项目。同样,当您知道要去哪里时,设置也很容易:https://console.developers.google.com/apis/dashboard
  3. 您将需要一个 API 密钥(也称为开发人员密钥)。转到此处并创建一个新密钥(如果还没有):https://console.developers.google.com/apis/credentials enter image description here
  4. 您需要为您的项目启用 Google 自定义搜索。此时,您可以向Google查询,但是如果您尚未为项目启用Google自定义搜索,则可能会收到错误响应。转到仪表板,单击蓝色的“启用 API”链接,搜索 Google 自定义搜索并启用它。https://console.developers.google.com/apis/dashboard enter image description here

一个经过全面评论的示例

这是一个比上面的例子更现实的例子。它仍然非常简单,但是以两种不同的方式解释新的东西并带有许多解释性注释总是很好的。

<?php

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

/**
 * Retrieves a simple set of google results for a given plant id.
 */
class GoogleResults implements IteratorAggregate {

    // Create one or more API keys at https://console.developers.google.com/apis/credentials
  const GCSE_API_KEY = "nqwkoigrhe893utnih_gibberish_q2ihrgu9qjnr";

    /* The search engine id is specific to each "custom search engine"
     * you have configured at https://cse.google.com/cse/all     

     * Remember that you must have enabled Custom Search API for the project that
     * contains your API Key.  You can do this at the following url:
     * https://console.developers.google.com/apis/api/customsearch.googleapis.com/overview?project=vegfetch-v01&duration=PT1H    

     * If you fail to enable the Custom Search API before you try to execute a search
     * the exception that is thrown will indicate this.  */
    const GCSE_SEARCH_ENGINE_ID = "937592689593725455:msi299dkne4de";

    // Holds the GoogleService for reuse
    private $service;

    // Holds the optParam for our search engine id
    private $optParamSEID;

    /**
     * Creates a service object for our Google Custom Search.  The API key is 
     * permiently set, but the search engine id may be changed when performing 
     * searches in case you want to search across multiple pre-prepared engines.
     * 
     * @param string $appName       Optional name for this google search
     */
    public function __construct($appName = "My_Search") {

        $client = new Google_Client();

        // application name is an arbitrary name
        $client->setApplicationName($appName);

        // the developer key is the API Key for a specific google project
        $client->setDeveloperKey(self::GCSE_API_KEY);

        // create new service
        $this->service = new Google_Service_Customsearch($client);

        // You must specify a custom search engine.  You can do this either by setting
        // the element "cx" to the search engine id, or by setting the element "cref"
        // to the public url for that search engine.
        // 
        // For a full list of possible params see https://github.com/google/google-api-php-client-services/blob/master/src/Google/Service/Customsearch/Resource/Cse.php
        $this->optParamSEID = array("cx"=>self::GCSE_SEARCH_ENGINE_ID);

  }

    /**
     * A simplistic function to take a search term & search options and return an 
     * array of results.  You may want to 
     * 
     * @param string    $searchTerm     The term you want to search for
     * @param array     $optParams      See: For a full list of possible params see https://github.com/google/google-api-php-client-services/blob/master/src/Google/Service/Customsearch/Resource/Cse.php
     * @return array                                An array of search result items
     */
  public function getSearchResults($searchTerm, $optParams = array()){
        // return array containing search result items
        $items = array();

        // Merge our search engine id into the $optParams
        // If $optParams already specified a 'cx' element, it will replace our default
        $optParams = array_merge($this->optParamSEID, $optParams);

        // set search term & params and execute the query
        $results = $this->service->cse->listCse($searchTerm, $optParams);

        // Since cse inherits from Google_Collections (which implements Iterator)
        // we can loop through the results by using `getItems()`
        foreach($results->getItems() as $k=>$item){
            var_dump($item);
            $item[] = $item;
        }

        return $items;
  }
}

答案 2

您必须不使用 ,但是Google_ServiceGoogle_Service_Customsearch

$service = new Google_Service_Customsearch($client);

然后:

$results = $service->cse->listCse($searchTerm, $optParams);

推荐