Custom Search JSON API: Giriş

Bu doküman, Custom Search JSON API ve kullanımı hakkında bilgi edinmenize yardımcı olacaktır.

Başlamadan önce

Programlanabilir Arama Motoru oluşturma

Kullanıcı, API'yi çağırarak mevcut bir Programlanabilir Arama Motoru örneği için istekte bulunur. Bu nedenle, API'yi kullanmadan önce Denetim Masası'nda bir API anahtarı oluşturmanız gerekir. Farklı yapılandırma seçenekleri hakkında daha fazla bilgi edinmek için eğitimi takip edin. Oluşturulduktan sonra Arama Motoru Kimliği'ni Genel Bakış sayfasının Temel bölümünde bulabilirsiniz. Bu, API tarafından kullanılan cx parametresidir.

API anahtarı ile uygulamanızı Google'a tanıtma

Custom Search JSON API, bir API anahtarının kullanılmasını gerektirir. API anahtarı, istemcinizi Google'a tanıtmanın bir yoludur.

API anahtarınız olduktan sonra uygulamanız, tüm istek URL'lerine key=yourAPIKey sorgu parametresini ekleyebilir. API anahtarı, URL'lere yerleştirilmek için güvenlidir ve kodlama gerektirmez.

API'ye genel bakış

API işlemleri

Custom Search JSON API'de çağrılacak tek bir yöntem vardır:

İşlem Açıklama REST HTTP eşlemesi
list Programlanabilir Arama Motoru'ndan istenen arama sonuçlarını döndürür. GET

API veri modeli

Custom Search JSON API'ye gönderilen bir arama sorgusunun sonucu, üç tür veri içeren bir JSON nesnesidir:

  • İstenen aramayı (ve muhtemelen ilgili arama isteklerini) açıklayan meta veriler
  • Programlanabilir Arama Motoru'nu açıklayan meta veriler
  • Arama sonuçları

Daha fazla bilgi için REST'i kullanma başlıklı makalenin "Yanıt verileri" bölümüne bakın.

Veri modeli, OpenSearch 1.1 spesifikasyonunu temel alır. Custom Search JSON API, standart OpenSearch özelliklerine ek olarak iki özel özellik ve iki özel sorgu rolü tanımlar:

  • Özel mülkler
    • cx: Programlanabilir Arama Motoru'nun tanımlayıcısı.
    • safe: Döndürülen sonuçları filtrelemek için kullanılan Güvenli Arama düzeyinin açıklaması.
  • Özel sorgu rolleri
    • nextPage: Sorgunun, varsa sonuçların bir sonraki mantıksal sayfasına erişmek için kullanılabileceğini belirten bir rol.
    • previousPage: Sorgunun, varsa önceki mantıksal sonuç sayfasına erişmek için kullanılabileceğini belirten bir rol.

Dene

Kod yazmadan API'nin neler yapabileceğini görmek için "Bu API'yi deneyin" aracını ziyaret edin.

Parametrelerin tam açıklaması için cse.list referansını inceleyin.

API'yi HTTP istekleri aracılığıyla nasıl kullanacağınızı öğrenmek için REST'i kullanma bölümüne geçin.