Skip to main content

Google Search API

Siesta AI - Google Search mahdollistaa ohjelmallisen verkkohakuun suorittamisen Google Custom Search JSON API:n kautta. Yhteys on vain luku- ja palauttaa jäsennellyn JSON:n tuloksista.

1. Google Search API:n asetukset (käytännön ohje)​

  1. Projekti Google Cloudissa: käytä olemassa olevaa tai luo uusi projekti.
  2. Ota käyttöön Custom Search API: etsi API-kirjastosta "Custom Search API" ja napsauta Enable. Custom Search API aktivointi API-kirjastossa
  3. Luo Programmable Search Engine: avaa https://programmablesearchengine.google.com/ hakukoneiden luettelo ja napsauta Lisää. Hakukoneiden luettelo Programmable Search Enginessä Uuden hakukoneen luominen
  4. Hanki Search Engine ID (cx): hakukoneen tiedoissa avaa Perustiedot-osio ja kopioi Hakukoneen ID. Search Engine ID (cx) kopioiminen
  5. Generoi API-avain: Google Cloud Consolessa -> APIs & Services -> Credentials -> Luo tunnistetiedot -> API-avain. API-avain luominen Tunnistetiedoissa
  6. Avainrajoitukset (suositeltavaa):
    • Sovelluksen rajoitukset: tarpeen mukaan (Ei mitään/Sivustot/IP).
    • API-rajoitukset: Rajoita avainta -> Custom Search API.
  7. Asetukset Siesta AI:ssa:
    • Yhteydet -> Lisää yhteys -> GoogleSearch.
    • Täytä Key (API-avain) ja Cx (Hakukoneen ID) ja valitse Jaettu/Yksityinen.
    • Tallenna napsauttamalla Jatka. GoogleSearch-yhteyden asetukset Siesta AI

2. Asiakirjan tarkoitus​

Tavoitteena on mahdollistaa ohjelmallinen pääsy verkkohakutuloksiin Google Custom Search JSON API:n kautta.

3. Yhteyksien yleiskatsaus​

  • Yhteyden nimi: GoogleSearch
  • Tyyppi: REST API - Google Custom Search JSON API
  • Todennus: API-avain (Google Cloud) + Hakukoneen ID (cx) (OAuth ei ole tarpeen)
  • Scope: vain luku/haku
  • Tuloste: JSON-objekti hakutuloksista
  • Huom.: Kirjoitusoperaatioita ei ole; kaikki kutsut ovat idempotentteja.

Google Custom Search JSON API mahdollistaa ohjelmallisen hakutulosten saamisen Googlelta Programmable Search Engine:n kautta, joka on luotava ja konfiguroitava ennen käyttöä.

4. Yleiset periaatteet​

4.1 Konfigurointi​

  • Hakukoneen ID (cx): oman hakukoneinstanssin tunniste.
  • API-avain: pakollinen parametri valtuutettuihin Google API -kutsuihin.
  • Tuloste: JSON sisältää hakumetadatan ja tulossarjan (otsikko, tiivistelmä, URL, pagemap jne.).

4.2 Kyselysyntaksi​

  • Parametri query (alias q) määrittää haettavan lausekkeen.
  • Voit käyttää edistyneitä operaattoreita kuten site:, intitle: jne. (standardi Google-kyselysyntaksi).

5. API-operaatiot​

5.1 Haku​

Kuvaus: Suorittaa verkkohaku Google Custom Search JSON API:n kautta.
HTTP: GET https://www.googleapis.com/customsearch/v1?key={API_KEY}&cx={SEARCH_ENGINE_ID}&q={query}

ParametriTyyppiPakollinenKuvaus
queryMerkkijonoKylläHaettava lauseke (esim. "AI best practices").

Tuloste

  • Luettelo tuloksista (otsikko, URL, tiivistelmä)
  • Metatietoja tulosten määrästä
  • Mahdolliset muut lohkot (pagemap)

Käyttäytyminen ja rajoitukset

  • Standardivastaus ~10 tulosta sivulla; lisää sivuja start-parametrin kautta (yhteyden ulkopuolella).

Tyypilliset virheet

  • 400 Bad Request - virheellinen kysely
  • 401 Unauthorized - virheellinen API-avain
  • 403 Quota Exceeded - päivittäinen kiintiö ylitetty

6. Turvallisuus ja hallinta​

  • Säilytä API-avain turvallisesti; suosii rajoituksia (verkkotunnukset/IP, rajoitukset Custom Search API:lle).
  • Seuraa kiintiöitä ja kirjaa laskutusta varten.
  • Kirjaa vähintään: query merkkijono, kutsuaika, tulosten määrä, HTTP-status.

7. Käyttöohjeet​

  • Aseta API-avaimen kiertopolitiikka (Rotate key Google Cloud Consolessa).
  • Pidä cx ja API-avain turvallisessa salaisuuksien tallennuksessa; päivitä Yhteys avaimen vaihtuessa.

8. Esimerkki käytöstä​

GET https://www.googleapis.com/customsearch/v1
  ?key=YOUR_API_KEY
  &cx=YOUR_SEARCH_ENGINE_ID
  &q=cloud+infrastructure+best+practices

Lyhennetty JSON:

{
  "queries": { "request": [ { "query": "cloud infrastructure best practices" } ] },
  "items": [
    { "title": "...", "link": "...", "snippet": "..." }
  ]
}