Interfejs API JSON wyszukiwarki niestandardowej: wprowadzenie

Zadbaj o dobrą organizację dzięki kolekcji Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.

Ten dokument pomoże Ci zapoznać się z interfejsem API usługi Twoja wyszukiwarka w formacie JSON i jego wykorzystywaniem.

Zanim rozpoczniesz

Tworzenie wyszukiwarki niestandardowej

Po wywołaniu przez użytkownika interfejsu API żądania dotyczące istniejącego wystąpienia Wyszukiwarki niestandardowej. Dlatego przed użyciem interfejsu API musisz utworzyć go w panelu sterowania. Więcej informacji o różnych opcjach konfiguracji znajdziesz w samouczku. Po jego utworzeniu identyfikator wyszukiwarki znajdziesz w panelu Konfiguracja i Podstawowe informacje o identyfikatorze wyszukiwarki w panelu sterowania. Jest to parametr cx używany przez interfejs API.

Identyfikowanie aplikacji w Google za pomocą klucza interfejsu API

Interfejs API JSON wyszukiwarki niestandardowej wymaga użycia klucza interfejsu API. Klucz interfejsu API służy do identyfikowania klienta w Google.

Gdy masz klucz interfejsu API, Twoja aplikacja może dołączać parametr zapytania key=yourAPIKey do wszystkich adresów URL żądań. Klucz API można bezpiecznie umieszczać w adresach URL, więc nie trzeba go kodować.

Przegląd interfejsów API

Operacje API

W niestandardowym interfejsie API JSON wyszukiwarki możesz wywołać tylko jedną metodę:

Operacja Opis Mapowanie HTTP REST
list Zwraca żądane wyniki wyszukiwania z Wyszukiwarki niestandardowej. GET

Model danych interfejsu API

Wynikiem wyszukiwanego hasła do interfejsu API JSON wyszukiwarki niestandardowej jest obiekt JSON zawierający 3 typy danych:

  • Metadane opisujące żądane wyszukiwanie (lub prawdopodobnie podobne wyszukiwania)
  • Metadane dotyczące Wyszukiwarki niestandardowej
  • Wyniki wyszukiwania

Więcej informacji znajdziesz w sekcji „Data odpowiedzi” w artykule Korzystanie z REST.

Model danych wykorzystuje specyfikację OpenSearch 1.1. Oprócz standardowych właściwości OpenSearch interfejs API usługi Twoja wyszukiwarka definiuje 2 właściwości niestandardowe i 2 niestandardowe role zapytania:

  • Właściwości niestandardowe
    • cx: identyfikator Wyszukiwarki niestandardowej.
    • safe: opis poziomu safesearch dla filtrowania zwróconych 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 taka jest).
    • previousPage: rola, która wskazuje, że zapytanie może zostać użyte do uzyskania dostępu do poprzedniej strony logicznej wyników (jeśli taka jest).

Wypróbuj

Aby sprawdzić, co interfejs API może zrobić, nie musisz pisać żadnego kodu, użyj "Try this API".

Pełny opis parametrów znajdziesz w przewodniku po cse.list.

Aby dowiedzieć się, jak korzystać z interfejsu API za pomocą żądań HTTP, przejdź do sekcji Korzystanie z REST.