Ten dokument pomoże Ci zapoznać się z interfejsem Custom Search JSON API i jego zastosowaniami.
Zanim rozpoczniesz
Tworzenie wyszukiwarki niestandardowej
Wywołując interfejs API, użytkownik wysyła żądania do istniejącej instancji programowej wyszukiwarki. Dlatego przed użyciem interfejsu API musisz utworzyć go w Panelu sterowania . Aby dowiedzieć się więcej o różnych opcjach konfiguracji, zapoznaj się z tym samouczkiem. Po utworzeniu identyfikator wyszukiwarki znajdziesz w sekcji Podstawowe na stronie Przegląd. Jest to parametr cxuż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 uzyskasz klucz interfejsu API, Twoja aplikacja będzie mogła dołączać parametr zapytania key=yourAPIKey do adresów URL wszystkich żądań. Klucz interfejsu API można bezpiecznie umieszczać w adresach URL, więc nie trzeba go kodować.
Przegląd interfejsów API
Operacje interfejsu API
W interfejsie Custom Search JSON API można wywołać tylko 1 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 rodzaje 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 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 bezpiecznego wyszukiwania do filtrowania zwróconych wyników.
- Role zapytań niestandardowych
nextPage: rola, która wskazuje, że zapytanie może służyć do uzyskiwania dostępu do następnej logicznej strony wyników (jeśli taka istnieje).previousPage: rola wskazująca, że zapytanie może służyć do uzyskiwania dostępu do poprzedniej logicznej strony wyników (jeśli taka istnieje).
Wypróbuj
Aby wypróbować interfejs API i sprawdzić, co potrafi, 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 korzystać z interfejsu API za pomocą żądań HTTP, przejdź do sekcji Korzystanie z interfejsu REST.