Ten dokument pomoże Ci zapoznać się z interfejsem Custom Search JSON API i jego zastosowaniem.
Zanim rozpoczniesz
Tworzenie wyszukiwarki niestandardowej
Wywołując interfejs API, użytkownik wysyła żądania do istniejącej instancji Wyszukiwarki niestandardowej. Dlatego przed użyciem interfejsu API musisz utworzyć konto w Panelu sterowania. Aby dowiedzieć się więcej o różnych opcjach konfiguracji, zapoznaj się z samouczkiem. Po utworzeniu wyszukiwarki identyfikator wyszukiwarki znajdziesz w sekcji Podstawowe na stronie Przegląd. Jest to parametr cx używany przez interfejs API.
Identyfikowanie aplikacji w Google za pomocą klucza interfejsu API
Interfejs Custom Search JSON API wymaga użycia klucza interfejsu API. Klucz interfejsu API to sposób na identyfikację klienta w Google.
Gdy masz już 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, nie wymaga on kodowania.
Przegląd interfejsów API
Operacje interfejsu API
W interfejsie Custom Search JSON API można wywołać tylko jedną metodę:
| Operacja | Opis | Mapowanie REST HTTP |
|---|---|---|
| list | Zwraca żądane wyniki wyszukiwania z Wyszukiwarki niestandardowej. | GET |
Model danych interfejsu API
Wynikiem zapytania do interfejsu Custom Search JSON API jest obiekt JSON, który zawiera 3 typy danych:
- metadane opisujące żądane wyszukiwanie (i ewentualnie powiązane żądania wyszukiwania);
- Metadane opisujące wyszukiwarkę niestandardową.
- Wyniki wyszukiwania
Więcej informacji znajdziesz w sekcji Dane odpowiedzi w artykule Korzystanie z interfejsu REST.
Model danych jest oparty na specyfikacji OpenSearch 1.1. Oprócz standardowych właściwości OpenSearch interfejs Custom Search JSON API definiuje 2 właściwości niestandardowe i 2 niestandardowe role zapytań:
- Właściwości niestandardowe
cx: identyfikator wyszukiwarki niestandardowej.safe: opis poziomu filtra SafeSearch używanego do filtrowania zwracanych wyników.
- Role niestandardowych zapytań
nextPage: rola wskazująca, że zapytanie może służyć do uzyskania dostępu do następnej logicznej strony wyników (jeśli istnieje).previousPage: rola wskazująca, że zapytanie może służyć do uzyskiwania dostępu do poprzedniej logicznej strony wyników (jeśli istnieje).
Wypróbuj
Aby poeksperymentować i zobaczyć, co potrafi interfejs API, bez pisania kodu, skorzystaj z 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, przejdź do sekcji Korzystanie z REST.