Bu belge, Custom Search JSON API ve kullanımı hakkında bilgi edinmenize yardımcı olacaktır.
Başlamadan önce
Programlanabilir Arama Motoru oluşturma
API'yi çağıran kullanıcı, Programlanabilir Arama Motoru'nun mevcut bir örneğine karşı istekte bulunur. Bu nedenle, API'yi kullanmadan önce Denetim
Paneli'nde bir tane oluşturmanız gerekir . Farklı yapılandırma seçenekleri hakkında daha fazla bilgi edinmek için eğitimi inceleyin. 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ıyla uygulamanızı Google'a tanıtma
Custom Search JSON API'nin kullanılabilmesi için API anahtarı gerekir. API anahtarı, istemcinizi Google'a tanımlamanın bir yoludur.
API anahtarınız olduktan sonra uygulamanız, sorgu parametresini key=yourAPIKey tüm istek URL'lerine ekleyebilir. API anahtarı, URL'lere yerleştirme için güvenlidir ve herhangi bir kodlama gerektirmez.
API'ye genel bakış
API işlemleri
Custom Search JSON API'de yalnızca bir yöntem çağrılabilir:
| İş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 yapılan 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 kullanma bölümündeki Yanıt verileri bölümüne bakın.
Veri modeli, OpenSearch 1.1 Spesifikasyonu'na dayanmaktadır. Custom Search JSON API, standart OpenSearch özelliklerine ek olarak iki özel özellik ve iki özel sorgu rolü tanımlar:
- Özel özellikler
cx: Programlanabilir Arama Motoru'nun tanımlayıcısı.safe: Döndürülen sonuçları filtrelemek için 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ı ziyaret edin.
API'yi HTTP istekleri üzerinden nasıl kullanacağınızı öğrenmek için REST'i Kullanma bölümüne geçin.