Bu belge, Custom Search JSON API ve kullanımı hakkında bilgi edinmenize yardımcı olacaktır.
Başlamadan önce
Programlanabilir Arama Motoru Oluşturun
API kullanıcısını çağırarak, mevcut bir Programlanabilir Arama Motoru örneğine yönelik istekler gönderir.
Bu nedenle, API'yi kullanmadan önce Kontrol Paneli'nde bir API oluşturmanız gerekir. Farklı yapılandırma seçenekleri hakkında daha fazla bilgi edinmek için eğiticiyi izleyin.
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.
Uygulamanızı API anahtarıyla Google'a tanımlayın
Custom Search JSON API için API anahtarı kullanılması gerekir. API anahtarı, istemcinizi Google'a tanıtmanın bir yoludur.
- Programlanabilir Arama Motoru (ücretsiz sürüm) kullanıcıları: Anahtar Alın
Bir API anahtarınız olduktan sonra uygulamanız key=yourAPIKey sorgu parametresini tüm istek URL'lerine ekleyebilir. API anahtarı, URL'lere yerleştirmek için güvenlidir ve herhangi bir kodlamaya ihtiyaç duymaz.
API'ye genel bakış
API işlemleri
Custom Search JSON API'de çağırmak için 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 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 veri
- Arama sonuçları
Daha ayrıntılı bilgi için REST'i kullanma başlıklı makalenin Yanıt verileri bölümüne bakın.
Veri modeli OpenSearch 1.1 spesifikasyonuna dayanır. Standart OpenSearch özelliklerine ek olarak, Custom Search JSON API 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 kullanılan güvenli arama düzeyinin açıklaması.
- Özel sorgu rolleri
nextPage: Sorgunun, varsa bir sonraki mantıksal sonuç 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.
Deneyin
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 aracılığıyla nasıl kullanacağınızı öğrenmek için REST'i kullanma bölümüne gidin.