Ten dokument pomoże Ci zapoznać się z interfejsem API Custom Search JSON i jego użyciem.
Zanim rozpoczniesz
Tworzenie wyszukiwarki niestandardowej
Po wywołaniu przez użytkownika interfejsu API żądania do istniejącej instancji Wyszukiwarki niestandardowej.
Zanim zaczniesz korzystać z interfejsu API, musisz utworzyć taki interfejs w panelu sterowania. Przeczytaj samouczek, aby dowiedzieć się więcej o różnych opcjach konfiguracji.
Po utworzeniu identyfikator wyszukiwarki możesz znaleźć 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 API Custom Search JSON wymaga użycia klucza interfejsu API. Klucz interfejsu API służy do identyfikacji klienta w Google.
- Użytkownicy bezpłatnej wyszukiwarki: Pobierz klucz
Gdy uzyskasz klucz interfejsu API, Twoja aplikacja może dołączać parametry zapytania key=yourAPIKey do wszystkich adresów URL żądań. Klucz interfejsu API można bezpiecznie umieścić w adresach URL bez konieczności 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 HTTP REST |
|---|---|---|
| list | Zwraca żądane wyniki wyszukiwania z Wyszukiwarki niestandardowej. | GET |
Model danych interfejsu API
Wynikiem zapytania do interfejsu Custom Search JSON API jest obiekt JSON zawierający 3 typy danych:
- metadane opisujące żądane wyszukiwanie (ewentualnie powiązane żądania wyszukiwania);
- Metadane opisujące wyszukiwarkę niestandardową
- Wyniki wyszukiwania
Więcej informacji znajdziesz w sekcji Dane odpowiedzi w artykule Korzystanie z 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 zapytania:
- Właściwości niestandardowe
cx: identyfikator Wyszukiwarki niestandardowej.safe: opis bezpiecznego poziomu filtrowania służący do filtrowania zwracanych wyników.
- Niestandardowe role zapytania
nextPage: rola, która wskazuje, że zapytanie może zostać użyte do uzyskania dostępu do następnej logicznej strony wyników (jeśli istnieje).previousPage: rola, która wskazuje, że zapytanie może zostać użyte do uzyskania dostępu do poprzedniej logicznej strony wyników (jeśli taka jest).
Wypróbuj
Aby poznać funkcje interfejsu API bez konieczności pisania kodu, skorzystaj z narzędzia „Wypróbuj ten interfejs API”.
Pełny opis parametrów znajdziesz w materiałach referencyjnych.
Aby dowiedzieć się, jak korzystać z tego interfejsu API w przypadku żądań HTTP, przejdź do sekcji Korzystanie z REST.