Ten dokument pomoże Ci zapoznać się z interfejsem Custom Search JSON API i jego wykorzystaniem.
Zanim zaczniesz
Tworzenie Wyszukiwarki niestandardowej
Poprzez wywołanie interfejsu API użytkownik wysyła żądania do istniejącej instancji Wyszukiwarki niestandardowej.
Zanim użyjesz tego interfejsu API, musisz go utworzyć w panelu sterowania. Z samouczka dowiesz się więcej o różnych opcjach konfiguracji.
Po utworzeniu identyfikator wyszukiwarki znajdziesz go na stronie Przegląd w sekcji Podstawowe. To parametr cx używany przez interfejs API.
Zidentyfikuj aplikację dla Google za pomocą klucza interfejsu API
Interfejs Custom Search JSON API wymaga użycia klucza API. Klucz interfejsu API to sposób na zidentyfikowanie klienta dla Google.
- Użytkownicy Wyszukiwarki niestandardowej (wersja bezpłatna): uzyskaj klucz
Gdy uzyskasz klucz interfejsu API, Twoja aplikacja może dołączać parametr zapytania key=yourAPIKey do wszystkich adresów URL żądań. Klucz interfejsu API można bezpiecznie umieszczać w adresach URL i nie wymaga kodowania.
Przegląd interfejsów API
Operacje API
W interfejsie Custom Search JSON API dostępna jest tylko jedna metoda:
| Operacja | Opis | Mapowanie HTTP REST |
|---|---|---|
| list | Zwraca żądane wyniki wyszukiwania z Wyszukiwarki niestandardowej. | GET |
Model danych API
Wynikiem wyszukiwania w interfejsie Custom Search JSON API jest obiekt JSON zawierający 3 typy danych:
- Metadane opisujące żądane wyszukiwanie (i ewentualnie podobne żądania wyszukiwania)
- Metadane opisujące wyszukiwarkę Wyszukiwarki niestandardowej
- Wyniki wyszukiwania
Więcej informacji znajdziesz w sekcji Dane odpowiedzi w artykule Używanie REST.
Model danych jest oparty na specyfikacji OpenSearch 1.1. Oprócz standardowych właściwości OpenSearch interfejs Custom Search JSON API definiuje dwie właściwości niestandardowe i dwie niestandardowe role w zapytaniu:
- Właściwości niestandardowe
cx: identyfikator Wyszukiwarki niestandardowej.safe: opis poziomu filtra SafeSearch do filtrowania zwróconych wyników.
- Niestandardowe role w zapytaniu
nextPage: rola wskazująca, że zapytanie może zostać użyte do uzyskania dostępu do następnej logicznej strony wyników (jeśli istnieje).previousPage: rola wskazująca zapytanie, umożliwia dostęp do poprzedniej logicznej strony wyników (jeśli istnieje).
Wypróbuj
Jeśli chcesz wypróbować różne funkcje interfejsu API bez konieczności pisania kodu, zajrzyj do narzędzia „Wypróbuj ten interfejs API”.
Pełny opis parametrów znajdziesz w dokumentacji CSe.list.
Aby dowiedzieć się, jak używać interfejsu API za pomocą żądań HTTP, przeczytaj artykuł o używaniu REST.