google custom search api 申请注册 cx key

旧城等待， 2021-09-07 06:10 285阅读 0赞

**目录**

1.建立Custom Search Engine

2.到API key网站 获取 api key

3.测试 api key 搜索

4.搜索参数列表

--------------------

### 1.建立Custom Search Engine ###

得到search engine ID,必须先建立 Custom Search Engine。

我们连到Custom Search Engine control panel 建立Search Engine。

[https://cse.google.com/cse/all][https_cse.google.com_cse_all]

![https://ithelp.ithome.com.tw/upload/images/20191002/20112182dNLjRH1S9x.jpg][https_ithelp.ithome.com.tw_upload_images_20191002_20112182dNLjRH1S9x.jpg]

取得Search Engine ID , 把值复制下来

![https://ithelp.ithome.com.tw/upload/images/20191003/201121829KqU5grMDU.jpg][https_ithelp.ithome.com.tw_upload_images_20191003_201121829KqU5grMDU.jpg]

### 2.到API key网站 获取 api key ###

[https://developers.google.com/custom-search/v1/overview][https_developers.google.com_custom-search_v1_overview]

![https://ithelp.ithome.com.tw/upload/images/20191002/201121829e8XOtVVWY.jpg][https_ithelp.ithome.com.tw_upload_images_20191002_201121829e8XOtVVWY.jpg]

取得API key

![https://ithelp.ithome.com.tw/upload/images/20191002/20112182N3h97G8NBS.jpg][https_ithelp.ithome.com.tw_upload_images_20191002_20112182N3h97G8NBS.jpg]

![https://ithelp.ithome.com.tw/upload/images/20191003/20112182QRTLnS2xQ3.jpg][https_ithelp.ithome.com.tw_upload_images_20191003_20112182QRTLnS2xQ3.jpg]

### **3.测试 api key 搜索** ###

有了search engine ID & API key，我们将可采用以下网址搜寻Google 上丰富资料。

网址至少要包含以下三个参数:

key: API key

cx: search engine ID

q: 搜寻的文字

接下来我们就可以在浏览器输入要查询的资料,之后就可以在App中放入查询的API

get 搜索 实例：

[https://www.googleapis.com/customsearch/v1?key=INSERT\_YOUR\_API\_KEY&cx=017576662512468239146:omuauf\_lfve&q=lectures][https_www.googleapis.com_customsearch_v1_key_INSERT_YOUR_API_KEY_cx_017576662512468239146_omuauf_lfve_q_lectures]

其中 [INSERT\_YOUR\_API\_KEY][https_www.googleapis.com_customsearch_v1_key_INSERT_YOUR_API_KEY_cx_017576662512468239146_omuauf_lfve_q_lectures] 换成自己 api key

![https://ithelp.ithome.com.tw/upload/images/20191003/20112182xa7YuJlBLM.jpg][https_ithelp.ithome.com.tw_upload_images_20191003_20112182xa7YuJlBLM.jpg]

### 4.搜索参数列表 ###

原文链接:[https://developers.google.com/custom-search/v1/reference/rest/v1/cse/list][https_developers.google.com_custom-search_v1_reference_rest_v1_cse_list]

<table> 
 <thead> 
 <tr> 
 <th colspan="2">Parameters</th> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td style="width:147px;"><code>c2coff</code></td> 
 <td> <code>string</code> Enables or disables&nbsp;<a href="https://developers.google.com/custom-search/docs/xml_results#chineseSearch" rel="nofollow">Simplified and Traditional Chinese Search</a>. The default value for this parameter is 0 (zero), meaning that the feature is enabled. Supported values are: 
 <ul> 
 <li> <code>1</code>: Disabled </li> 
 <li> <code>0</code>: Enabled (default) </li> 
 </ul></td> 
 </tr> 
 <tr> 
 <td style="width:147px;"><code>cr</code></td> 
 <td> <code>string</code> Restricts search results to documents originating in a particular country. You may use&nbsp;<a href="https://developers.google.com/custom-search/docs/xml_results_appendices#booleanOperators" rel="nofollow">Boolean operators</a>&nbsp;in the cr parameter's value. Google Search determines the country of a document by analyzing: 
 <ul> 
 <li> the top-level domain (TLD) of the document's URL </li> 
 <li> the geographic location of the Web server's IP address </li> 
 </ul>See the&nbsp;<a href="https://developers.google.com/custom-search/docs/xml_results_appendices#countryCollections" rel="nofollow">Country Parameter Values</a>&nbsp;page for a list of valid values for this parameter. </td> 
 </tr> 
 <tr> 
 <td style="width:147px;"><code>cx</code></td> 
 <td> <code>string</code> The Programmable Search Engine ID to use for this request. </td> 
 </tr> 
 <tr> 
 <td style="width:147px;"><code>dateRestrict</code></td> 
 <td> <code>string</code> Restricts results to URLs based on date. Supported values include: 
 <ul> 
 <li> <code>d[number]</code>: requests results from the specified number of past days. </li> 
 <li> <code>w[number]</code>: requests results from the specified number of past weeks. </li> 
 <li> <code>m[number]</code>: requests results from the specified number of past months. </li> 
 <li> <code>y[number]</code>: requests results from the specified number of past years. </li> 
 </ul></td> 
 </tr> 
 <tr> 
 <td style="width:147px;"><code>exactTerms</code></td> 
 <td> <code>string</code> Identifies a phrase that all documents in the search results must contain. </td> 
 </tr> 
 <tr> 
 <td style="width:147px;"><code>excludeTerms</code></td> 
 <td> <code>string</code> Identifies a word or phrase that should not appear in any documents in the search results. </td> 
 </tr> 
 <tr> 
 <td style="width:147px;"><code>fileType</code></td> 
 <td> <code>string</code> Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console&nbsp;<a href="https://support.google.com/webmasters/answer/35287" rel="nofollow">Help Center</a>. </td> 
 </tr> 
 <tr> 
 <td style="width:147px;"><code>filter</code></td> 
 <td> <code>string</code> Controls turning on or off the duplicate content filter. 
 <ul> 
 <li> See&nbsp;<a href="https://developers.google.com/custom-search/docs/xml_results#automaticFiltering" rel="nofollow">Automatic Filtering</a>&nbsp;for more information about Google's search results filters. Note that host crowding filtering applies only to multi-site searches. </li> 
 <li> By default, Google applies filtering to all search results to improve the quality of those results. </li> 
 </ul>Acceptable values are: 
 <ul> 
 <li> <code>0</code>: Turns off duplicate content filter. </li> 
 <li> <code>1</code>: Turns on duplicate content filter. </li> 
 </ul></td> 
 </tr> 
 <tr> 
 <td style="width:147px;"><code>gl</code></td> 
 <td> <code>string</code> Geolocation of end user. 
 <ul> 
 <li> The&nbsp;<code>gl</code>&nbsp;parameter value is a two-letter country code. The&nbsp;<code>gl</code>&nbsp;parameter boosts search results whose country of origin matches the parameter value. See the&nbsp;<a href="https://developers.google.com/custom-search/docs/xml_results_appendices#countryCodes" rel="nofollow">Country Codes</a>&nbsp;page for a list of valid values. </li> 
 <li> Specifying a&nbsp;<code>gl</code>&nbsp;parameter value should lead to more relevant results. This is particularly true for international customers and, even more specifically, for customers in English- speaking countries other than the United States. </li> 
 </ul></td> 
 </tr> 
 <tr> 
 <td style="width:147px;"><code>googlehost</code></td> 
 <td> <code>string</code> Deprecated. Use the&nbsp;<code>gl</code>&nbsp;parameter for a similar effect. The local Google domain (for example, google.com, google.de, or google.fr) to use to perform the search. </td> 
 </tr> 
 <tr> 
 <td style="width:147px;"><code>highRange</code></td> 
 <td> <code>string</code> Specifies the ending value for a search range. 
 <ul> 
 <li>Use&nbsp;<code>lowRange</code>&nbsp;and&nbsp;<code>highRange</code>&nbsp;to append an inclusive search range of&nbsp;<code>lowRange...highRange</code>&nbsp;to the query.</li> 
 </ul></td> 
 </tr> 
 <tr> 
 <td style="width:147px;"><code>hl</code></td> 
 <td> <code>string</code> Sets the user interface language. 
 <ul> 
 <li> Explicitly setting this parameter improves the performance and the quality of your search results. </li> 
 <li> See the&nbsp;<a href="https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages" rel="nofollow">Interface Languages</a>&nbsp;section of&nbsp;<a href="https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing" rel="nofollow">Internationalizing Queries and Results Presentation</a>&nbsp;for more information, and (Supported Interface Languages)[https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages] for a list of supported languages. </li> 
 </ul></td> 
 </tr> 
 <tr> 
 <td style="width:147px;"><code>hq</code></td> 
 <td> <code>string</code> Appends the specified query terms to the query, as if they were combined with a logical AND operator. </td> 
 </tr> 
 <tr> 
 <td style="width:147px;"><code>imgColorType</code></td> 
 <td> <code>enum (<code><a href="https://developers.google.com/custom-search/v1/reference/rest/v1/ImgColorType" rel="nofollow">ImgColorType</a></code>)</code> Returns black and white, grayscale, transparent, or color images. Acceptable values are: 
 <ul> 
 <li> <code>"color"</code> </li> 
 <li> <code>"gray"</code> </li> 
 <li> <code>"mono"</code>: black and white </li> 
 <li> <code>"trans"</code>: transparent background </li> 
 </ul></td> 
 </tr> 
 <tr> 
 <td style="width:147px;"><code>imgDominantColor</code></td> 
 <td> <code>enum (<code><a href="https://developers.google.com/custom-search/v1/reference/rest/v1/ImgDominantColor" rel="nofollow">ImgDominantColor</a></code>)</code> Returns images of a specific dominant color. Acceptable values are: 
 <ul> 
 <li> <code>"black"</code> </li> 
 <li> <code>"blue"</code> </li> 
 <li> <code>"brown"</code> </li> 
 <li> <code>"gray"</code> </li> 
 <li> <code>"green"</code> </li> 
 <li> <code>"orange"</code> </li> 
 <li> <code>"pink"</code> </li> 
 <li> <code>"purple"</code> </li> 
 <li> <code>"red"</code> </li> 
 <li> <code>"teal"</code> </li> 
 <li> <code>"white"</code> </li> 
 <li> <code>"yellow"</code> </li> 
 </ul></td> 
 </tr> 
 <tr> 
 <td style="width:147px;"><code>imgSize</code></td> 
 <td> <code>enum (<code><a href="https://developers.google.com/custom-search/v1/reference/rest/v1/ImgSize" rel="nofollow">ImgSize</a></code>)</code> Returns images of a specified size. Acceptable values are: 
 <ul> 
 <li> <code>"huge"</code> </li> 
 <li> <code>"icon"</code> </li> 
 <li> <code>"large"</code> </li> 
 <li> <code>"medium"</code> </li> 
 <li> <code>"small"</code> </li> 
 <li> <code>"xlarge"</code> </li> 
 <li> <code>"xxlarge"</code> </li> 
 </ul></td> 
 </tr> 
 <tr> 
 <td style="width:147px;"><code>imgType</code></td> 
 <td> <code>enum (<code><a href="https://developers.google.com/custom-search/v1/reference/rest/v1/ImgType" rel="nofollow">ImgType</a></code>)</code> Returns images of a type. Acceptable values are: 
 <ul> 
 <li> <code>"clipart"</code> </li> 
 <li> <code>"face"</code> </li> 
 <li> <code>"lineart"</code> </li> 
 <li> <code>"stock"</code> </li> 
 <li> <code>"photo"</code> </li> 
 <li> <code>"animated"</code> </li> 
 </ul></td> 
 </tr> 
 <tr> 
 <td style="width:147px;"><code>linkSite</code></td> 
 <td> <code>string</code> Specifies that all search results should contain a link to a particular URL. </td> 
 </tr> 
 <tr> 
 <td style="width:147px;"><code>lowRange</code></td> 
 <td> <code>string</code> Specifies the starting value for a search range. Use&nbsp;<code>lowRange</code>&nbsp;and&nbsp;<code>highRange</code>&nbsp;to append an inclusive search range of&nbsp;<code>lowRange...highRange</code>&nbsp;to the query. </td> 
 </tr> 
 <tr> 
 <td style="width:147px;"><code>lr</code></td> 
 <td> <code>string</code> Restricts the search to documents written in a particular language (e.g.,&nbsp;<code>lr=lang_ja</code>). Acceptable values are: 
 <ul> 
 <li> <code>"lang_ar"</code>: Arabic </li> 
 <li> <code>"lang_bg"</code>: Bulgarian </li> 
 <li> <code>"lang_ca"</code>: Catalan </li> 
 <li> <code>"lang_cs"</code>: Czech </li> 
 <li> <code>"lang_da"</code>: Danish </li> 
 <li> <code>"lang_de"</code>: German </li> 
 <li> <code>"lang_el"</code>: Greek </li> 
 <li> <code>"lang_en"</code>: English </li> 
 <li> <code>"lang_es"</code>: Spanish </li> 
 <li> <code>"lang_et"</code>: Estonian </li> 
 <li> <code>"lang_fi"</code>: Finnish </li> 
 <li> <code>"lang_fr"</code>: French </li> 
 <li> <code>"lang_hr"</code>: Croatian </li> 
 <li> <code>"lang_hu"</code>: Hungarian </li> 
 <li> <code>"lang_id"</code>: Indonesian </li> 
 <li> <code>"lang_is"</code>: Icelandic </li> 
 <li> <code>"lang_it"</code>: Italian </li> 
 <li> <code>"lang_iw"</code>: Hebrew </li> 
 <li> <code>"lang_ja"</code>: Japanese </li> 
 <li> <code>"lang_ko"</code>: Korean </li> 
 <li> <code>"lang_lt"</code>: Lithuanian </li> 
 <li> <code>"lang_lv"</code>: Latvian </li> 
 <li> <code>"lang_nl"</code>: Dutch </li> 
 <li> <code>"lang_no"</code>: Norwegian </li> 
 <li> <code>"lang_pl"</code>: Polish </li> 
 <li> <code>"lang_pt"</code>: Portuguese </li> 
 <li> <code>"lang_ro"</code>: Romanian </li> 
 <li> <code>"lang_ru"</code>: Russian </li> 
 <li> <code>"lang_sk"</code>: Slovak </li> 
 <li> <code>"lang_sl"</code>: Slovenian </li> 
 <li> <code>"lang_sr"</code>: Serbian </li> 
 <li> <code>"lang_sv"</code>: Swedish </li> 
 <li> <code>"lang_tr"</code>: Turkish </li> 
 <li> <code>"lang_zh-CN"</code>: Chinese (Simplified) </li> 
 <li> <code>"lang_zh-TW"</code>: Chinese (Traditional) </li> 
 </ul></td> 
 </tr> 
 <tr> 
 <td style="width:147px;"><code>num</code></td> 
 <td> <code>integer</code> Number of search results to return. 
 <ul> 
 <li>Valid values are integers between 1 and 10, inclusive.</li> 
 </ul></td> 
 </tr> 
 <tr> 
 <td style="width:147px;"><code>orTerms</code></td> 
 <td> <code>string</code> Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms. </td> 
 </tr> 
 <tr> 
 <td style="width:147px;"><code>q</code></td> 
 <td> <code>string</code> Query </td> 
 </tr> 
 <tr> 
 <td style="width:147px;"><code>relatedSite</code></td> 
 <td> <code>string</code> Specifies that all search results should be pages that are related to the specified URL. </td> 
 </tr> 
 <tr> 
 <td style="width:147px;"><code>rights</code></td> 
 <td> <code>string</code> Filters based on licensing. Supported values include:&nbsp;<code>cc_publicdomain</code>,&nbsp;<code>cc_attribute</code>,&nbsp;<code>cc_sharealike</code>,&nbsp;<code>cc_noncommercial</code>,&nbsp;<code>cc_nonderived</code>&nbsp;and combinations of these. See&nbsp;<a href="https://wiki.creativecommons.org/wiki/CC_Search_integration" rel="nofollow">typical combinations</a>. </td> 
 </tr> 
 <tr> 
 <td style="width:147px;"><code>safe</code></td> 
 <td> <code>enum (<code><a href="https://developers.google.com/custom-search/v1/reference/rest/v1/Safe" rel="nofollow">Safe</a></code>)</code> Search safety level. Acceptable values are: 
 <ul> 
 <li> <code>"active"</code>: Enables SafeSearch filtering. </li> 
 <li> <code>"off"</code>: Disables SafeSearch filtering. (default) </li> 
 </ul></td> 
 </tr> 
 <tr> 
 <td style="width:147px;"><code>searchType</code></td> 
 <td> <code>enum (<code><a href="https://developers.google.com/custom-search/v1/reference/rest/v1/SearchType" rel="nofollow">SearchType</a></code>)</code> Specifies the search type:&nbsp;<code>image</code>. If unspecified, results are limited to webpages. Acceptable values are: 
 <ul> 
 <li><code>"image"</code>: custom image search.</li> 
 </ul></td> 
 </tr> 
 <tr> 
 <td style="width:147px;"><code>siteSearch</code></td> 
 <td> <code>string</code> Specifies a given site which should always be included or excluded from results (see&nbsp;<code>siteSearchFilter</code>&nbsp;parameter, below). </td> 
 </tr> 
 <tr> 
 <td style="width:147px;"><code>siteSearchFilter</code></td> 
 <td> <code>enum (<code><a href="https://developers.google.com/custom-search/v1/reference/rest/v1/SiteSearchFilter" rel="nofollow">SiteSearchFilter</a></code>)</code> Controls whether to include or exclude results from the site named in the&nbsp;<code>siteSearch</code>&nbsp;parameter. Acceptable values are: 
 <ul> 
 <li> <code>"e"</code>: exclude </li> 
 <li> <code>"i"</code>: include </li> 
 </ul></td> 
 </tr> 
 <tr> 
 <td style="width:147px;"><code>sort</code></td> 
 <td> <code>string</code> The sort expression to apply to the results. The sort parameter specifies that the results be sorted according to the specified expression i.e. sort by date.&nbsp;<a href="https://developers.google.com/custom-search/docs/structured_search#sort-by-attribute" rel="nofollow">Example: sort=date</a>. </td> 
 </tr> 
 <tr> 
 <td style="width:147px;"><code>start</code></td> 
 <td> <code>integer (<a href="https://developers.google.com/discovery/v1/type-format" rel="nofollow">uint32</a>&nbsp;format)</code> The index of the first result to return. The default number of results per page is 10, so&nbsp;<code>&amp;start=11</code>&nbsp;would start at the top of the second page of results.&nbsp;Note: The JSON API will never return more than 100 results, even if more than 100 documents match the query, so setting the sum of&nbsp;<code>start + num</code>&nbsp;to a number greater than 100 will produce an error. Also note that the maximum value for&nbsp;<code>num</code>&nbsp;is 10. </td> 
 </tr> 
 </tbody> 
</table>

[https_cse.google.com_cse_all]: https://cse.google.com/cse/all
[https_ithelp.ithome.com.tw_upload_images_20191002_20112182dNLjRH1S9x.jpg]: /images/20210728/7cba1f99a8424bc18555918de4bf7ed9.png
[https_ithelp.ithome.com.tw_upload_images_20191003_201121829KqU5grMDU.jpg]: /images/20210728/ac13c166a6c549859da224e8e233e9ea.png
[https_developers.google.com_custom-search_v1_overview]: https://developers.google.com/custom-search/v1/overview
[https_ithelp.ithome.com.tw_upload_images_20191002_201121829e8XOtVVWY.jpg]: /images/20210728/11e424b320404b7db973bf2920f52eaa.png
[https_ithelp.ithome.com.tw_upload_images_20191002_20112182N3h97G8NBS.jpg]: /images/20210728/f48941fe845844429201a40df05e6201.png
[https_ithelp.ithome.com.tw_upload_images_20191003_20112182QRTLnS2xQ3.jpg]: /images/20210728/df18eaeeaa3a42528ceadc03c47ec4f6.png
[https_www.googleapis.com_customsearch_v1_key_INSERT_YOUR_API_KEY_cx_017576662512468239146_omuauf_lfve_q_lectures]: https://www.googleapis.com/customsearch/v1?key=INSERT_YOUR_API_KEY&cx=017576662512468239146:omuauf_lfve&q=lectures
[https_ithelp.ithome.com.tw_upload_images_20191003_20112182xa7YuJlBLM.jpg]: /images/20210728/1100851810294ad6b2988fdb25c739b4.png
[https_developers.google.com_custom-search_v1_reference_rest_v1_cse_list]: https://developers.google.com/custom-search/v1/reference/rest/v1/cse/list