Skip to content

This is a Python program to generate a .json file with n results Google Search about a specific word.

Notifications You must be signed in to change notification settings

caiogranero/google-custom-search-api-python

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 

Repository files navigation

google-custom-search-api-python

  • About
  • Install Google API
  • The Code
  • Parameters
  • The JSON output
  • For more info

About

This is a Python program to generate a .json file with n page results Google Search about a specific word.

Install Google API

$ pip install --upgrade google-api-python-client

The Code

__author__ = 'Caio Granero'

import json

from googleapiclient.discovery import build

def getService():
    service = build("customsearch", "v1",
            developerKey="AIzaSyDxpJfGwM9KzeTFlKa-_Z-wEgI1sKMcKKo")

    return service

def main():

    pageLimit = 4
    service = getService()
    startIndex = 1
    response = []

    for nPage in range(0, pageLimit):
        print "Reading page number:",nPage+1

        response.append(service.cse().list(
            q='Temer Golpista', #Search words
            cx='001132580745589424302:jbscnf14_dw',  #CSE Key
            lr='lang_pt', #Search language
            start=startIndex
        ).execute())

        startIndex = response[nPage].get("queries").get("nextPage")[0].get("startIndex")

    with open('data.json', 'w') as outfile:
        json.dump(response, outfile)

main()

Parameters

Args:
  q: string, Query (required)
  dateRestrict: string, Specifies all search results are from a time period
  hl: string, Sets the user interface language.
  orTerms: string, 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
  highRange: string, Creates a range in form as_nlo value..as_nhi value and attempts to append it to query
  num: integer, Number of search results to return
  cr: string, Country restrict(s).
  imgType: string, Returns images of a type, which can be one of: clipart, face, lineart, news, and photo.
    Allowed values
      clipart - clipart
      face - face
      lineart - lineart
      news - news
      photo - photo
  relatedSite: string, Specifies that all search results should be pages that are related to the specified URL
  filter: string, Controls turning on or off the duplicate content filter.
    Allowed values
      0 - Turns off duplicate content filter.
      1 - Turns on duplicate content filter.
  gl: string, Geolocation of end user.
  searchType: string, Specifies the search type: image.
    Allowed values
      image - custom image search
  fileType: string, Returns images of a specified type. Some of the allowed values are: bmp, gif, png, jpg, svg, pdf, ...
  start: integer, The index of the first result to return
  imgDominantColor: string, Returns images of a specific dominant color: yellow, green, teal, blue, purple, pink, white, gray, black and brown.
    Allowed values
      black - black
      blue - blue
      brown - brown
      gray - gray
      green - green
      pink - pink
      purple - purple
      teal - teal
      white - white
      yellow - yellow
  lr: string, The language restriction for the search results
    Allowed values
      lang_ar - Arabic
      lang_bg - Bulgarian
      lang_ca - Catalan
      lang_cs - Czech
      lang_da - Danish
      lang_de - German
      lang_el - Greek
      lang_en - English
      lang_es - Spanish
      lang_et - Estonian
      lang_fi - Finnish
      lang_fr - French
      lang_hr - Croatian
      lang_hu - Hungarian
      lang_id - Indonesian
      lang_is - Icelandic
      lang_it - Italian
      lang_iw - Hebrew
      lang_ja - Japanese
      lang_ko - Korean
      lang_lt - Lithuanian
      lang_lv - Latvian
      lang_nl - Dutch
      lang_no - Norwegian
      lang_pl - Polish
      lang_pt - Portuguese
      lang_ro - Romanian
      lang_ru - Russian
      lang_sk - Slovak
      lang_sl - Slovenian
      lang_sr - Serbian
      lang_sv - Swedish
      lang_tr - Turkish
      lang_zh-CN - Chinese (Simplified)
      lang_zh-TW - Chinese (Traditional)
  siteSearch: string, Specifies all search results should be pages from a given site
  cref: string, The URL of a linked custom search engine
  sort: string, The sort expression to apply to the results
  hq: string, Appends the extra query terms to the query.
  c2coff: string, Turns off the translation between zh-CN and zh-TW.
  googlehost: string, The local Google domain to use to perform the search.
  safe: string, Search safety level
    Allowed values
      high - Enables highest level of safe search filtering.
      medium - Enables moderate safe search filtering.
      off - Disables safe search filtering.
  exactTerms: string, Identifies a phrase that all documents in the search results must contain
  lowRange: string, Creates a range in form as_nlo value..as_nhi value and attempts to append it to query
  imgSize: string, Returns images of a specified size, where size can be one of: icon, small, medium, large, xlarge, xxlarge, and huge.
    Allowed values
      huge - huge
      icon - icon
      large - large
      medium - medium
      small - small
      xlarge - xlarge
      xxlarge - xxlarge
  imgColorType: string, Returns black and white, grayscale, or color images: mono, gray, and color.
    Allowed values
      color - color
      gray - gray
      mono - mono
  rights: string, Filters based on licensing. Supported values include: cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived and combinations of these.
  excludeTerms: string, Identifies a word or phrase that should not appear in any documents in the search results
  linkSite: string, Specifies that all search results should contain a link to a particular URL
  cx: string, The custom search engine ID to scope this search query
  siteSearchFilter: string, Controls whether to include or exclude results from the site named in the as_sitesearch parameter
    Allowed values
      e - exclude
      i - include

The JSON output

{
"promotions": [
  {
    "title": "A String",
    "displayLink": "A String",
    "htmlTitle": "A String",
    "link": "A String",
    "bodyLines": [
      {
        "url": "A String",
        "htmlTitle": "A String",
        "link": "A String",
        "title": "A String",
      },
    ],
    "image": {
      "source": "A String",
      "width": 42,
      "height": 42,
    },
  },
],
"kind": "customsearch#search",
"url": {
  "type": "application/json",
  "template": "https://www.googleapis.com/customsearch/v1?q={searchTerms}&num={count?}&start={startIndex?}&lr={language?}&safe={safe?}&cx={cx?}&cref={cref?}&sort={sort?}&filter={filter?}&gl={gl?}&cr={cr?}&googlehost={googleHost?}&c2coff={disableCnTwTranslation?}&hq={hq?}&hl={hl?}&siteSearch={siteSearch?}&siteSearchFilter={siteSearchFilter?}&exactTerms={exactTerms?}&excludeTerms={excludeTerms?}&linkSite={linkSite?}&orTerms={orTerms?}&relatedSite={relatedSite?}&dateRestrict={dateRestrict?}&lowRange={lowRange?}&highRange={highRange?}&searchType={searchType}&fileType={fileType?}&rights={rights?}&imgSize={imgSize?}&imgType={imgType?}&imgColorType={imgColorType?}&imgDominantColor={imgDominantColor?}&alt=json",
},
"items": [
  {
    "snippet": "A String",
    "kind": "customsearch#result",
    "labels": [
      {
        "label_with_op": "A String",
        "displayName": "A String",
        "name": "A String",
      },
    ],
    "title": "A String",
    "displayLink": "A String",
    "cacheId": "A String",
    "formattedUrl": "A String",
    "htmlFormattedUrl": "A String",
    "pagemap": {
      "a_key": [
        {
          "a_key": "",
        },
      ],
    },
    "htmlTitle": "A String",
    "htmlSnippet": "A String",
    "link": "A String",
    "image": {
      "thumbnailWidth": 42,
      "byteSize": 42,
      "height": 42,
      "width": 42,
      "contextLink": "A String",
      "thumbnailLink": "A String",
      "thumbnailHeight": 42,
    },
    "mime": "A String",
    "fileFormat": "A String",
  },
],
"context": {
  "facets": [
    [
      {
        "label_with_op": "A String",
        "anchor": "A String",
        "label": "A String",
      },
    ],
  ],
  "title": "A String",
},
"queries": {
  "a_key": [
    {
      "sort": "A String",
      "hl": "A String",
      "orTerms": "A String",
      "highRange": "A String",
      "cx": "A String",
      "startPage": 42,
      "disableCnTwTranslation": "A String",
      "cr": "A String",
      "imgType": "A String",
      "gl": "A String",
      "relatedSite": "A String",
      "searchType": "A String",
      "title": "A String",
      "googleHost": "A String",
      "fileType": "A String",
      "imgDominantColor": "A String",
      "siteSearch": "A String",
      "cref": "A String",
      "dateRestrict": "A String",
      "safe": "A String",
      "outputEncoding": "A String",
      "hq": "A String",
      "searchTerms": "A String",
      "exactTerms": "A String",
      "language": "A String",
      "inputEncoding": "A String",
      "totalResults": "A String",
      "lowRange": "A String",
      "count": 42,
      "imgSize": "A String",
      "imgColorType": "A String",
      "rights": "A String",
      "startIndex": 42,
      "excludeTerms": "A String",
      "filter": "A String",
      "linkSite": "A String",
      "siteSearchFilter": "A String",
    },
  ],
},
"spelling": {
  "correctedQuery": "A String",
  "htmlCorrectedQuery": "A String",
},
"searchInformation": {
  "formattedSearchTime": "A String",
  "formattedTotalResults": "A String",
  "totalResults": "A String",
  "searchTime": 3.14,
},

}

For more info:

API Documents

Get Your Goole API Key

Get Your Custom Search Engine Key

About API Install

About the API

About

This is a Python program to generate a .json file with n results Google Search about a specific word.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages