如何将PHP客户端用于Google自定义搜索引擎

Question

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

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

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

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/21/17：实际上，这些文档并没有帮到我太多，但我会把它们留下仅供参考）

我使用phpdoc为googleapiclient生成api留档。我做了一个回购，把phpdocs和图书馆放在github上。phpdocs在这里可以浏览。

所以希望这会对某人有所帮助。不幸的是，即使有了这些文档，我也很难理解正确的用法。我还没有为GoogleApiclient服务包生成文档，因为它们太大了，但如果需要，我可以这样做（取决于github页面上的磁盘限制）。

Answer 1

listCse（）函数（现在）只接受一个参数——API文档中提到的完整键数组(https://developers.google.com/custom-search/v1/reference/rest/v1/cse/list).

因此-阵列中至少必须包含cx和q密钥。

Answer 2

您必须使用的不是Google\u服务，而是Google\u服务

$service = new Google_Service_Customsearch($client);

然后：

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

Answer 3

感谢@gennadiy让我走上正轨。没有他的建议使用-

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

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);

results对象实现了迭代器，因此我们可以按如下方式对其进行循环：

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

为了使用这个库，你必须先设置一些谷歌的东西。这些东西最终会在谷歌应用编程接口客户端库PHP（测试版）网站上提到，但是你必须点击周围

1. 你需要一个自定义搜索引擎。不要被这样一个事实所迷惑，即互联网上大多数对自定义搜索引擎的引用都是针对那些不试图进行编程搜索的人的。你需要一个，它们很容易在这里设置：https://cse.google.com/cse/all
2. 你需要一个谷歌项目。同样，当你知道去哪里时，设置很容易：https://console.developers.google.com/apis/dashboard
3. 您将需要一个API密钥（又名开发者密钥）。如果您还没有密钥，请转到此处并创建一个新密钥：https://console.developers.google.com/apis/credentials
4. 您需要为您的项目启用谷歌自定义搜索。在这一点上，你可以向谷歌查询，但如果你还没有为你的项目启用谷歌自定义搜索，你可能会得到一个错误的响应。转到仪表板，单击蓝色的Enable API链接，搜索Google Custom Search并启用它。https://console.developers.google.com/apis/dashboard

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

<?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;
  }
}