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 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.
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:
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).
[[["Łatwo zrozumieć","easyToUnderstand","thumb-up"],["Rozwiązało to mój problem","solvedMyProblem","thumb-up"],["Inne","otherUp","thumb-up"]],[["Brak potrzebnych mi informacji","missingTheInformationINeed","thumb-down"],["Zbyt skomplikowane / zbyt wiele czynności do wykonania","tooComplicatedTooManySteps","thumb-down"],["Nieaktualne treści","outOfDate","thumb-down"],["Problem z tłumaczeniem","translationIssue","thumb-down"],["Problem z przykładami/kodem","samplesCodeIssue","thumb-down"],["Inne","otherDown","thumb-down"]],["Ostatnia aktualizacja: 2025-08-31 UTC."],[[["\u003cp\u003eThis guide introduces the Custom Search JSON API and provides instructions for its use.\u003c/p\u003e\n"],["\u003cp\u003eBefore using the API, you need to create a Programmable Search Engine and obtain an API key.\u003c/p\u003e\n"],["\u003cp\u003eThe API allows you to retrieve search results from your Programmable Search Engine using a single \u003ccode\u003elist\u003c/code\u003e operation.\u003c/p\u003e\n"],["\u003cp\u003eThe API returns results in JSON format containing search metadata, engine details, and the search results themselves.\u003c/p\u003e\n"],["\u003cp\u003eYou can experiment with the API using the provided "Try this API" tool or learn more through detailed documentation and examples.\u003c/p\u003e\n"]]],[],null,["# Custom Search JSON API: Introduction\n\nThis document will help you to get familiar with Custom Search JSON API and its usage.\n\nBefore you start\n----------------\n\n### Create Programmable Search Engine\n\nBy calling the API user issues requests against an existing instance of\nProgrammable Search Engine.\nTherefore, before using the API, you need to create one in the\n[Control Panel](https://programmablesearchengine.google.com/controlpanel/create)\n. Follow the [tutorial](/custom-search/docs/tutorial/creatingcse)\nto learn more about different configuration options.\nOnce it is created, you can find the **Search Engine ID** in the **Overview**\npage's **Basic** section. This is the `cx` parameter used by the API.\n\n### Identify your application to Google with API key\n\nCustom Search JSON API requires the use of an API key. An API key is a way to identify your client to Google.\n\n- [Programmable Search Engine](https://cse.google.com/) (free edition) users: Get a Key\n\nAfter you have an API key, your application can append the query parameter\n`key=yourAPIKey` to all request URLs. The API key is safe for embedding in URLs,\nit doesn't need any encoding.\n\nAPI overview\n------------\n\n### API operations\n\nThere is only one method to invoke in the Custom Search JSON API:\n\n| Operation | Description | REST HTTP mapping |\n|------------------------------------------------------|-------------------------------------------------------------------------|-------------------|\n| [list](/custom-search/v1/reference/rest/v1/cse/list) | Returns the requested search results from a Programmable Search Engine. | `GET` |\n\n### API data model\n\nThe result of a search query to the Custom Search JSON API is a JSON object that includes three types of data:\n\n- Metadata describing the requested search (and, possibly, related search requests)\n- Metadata describing the Programmable Search Engine\n- Search results\n\nSee the Response data section of [Using REST](/custom-search/v1/using_rest#response_data) for more details.\n\nThe data model is based on the OpenSearch 1.1 Specification. In addition to the standard OpenSearch properties, the Custom Search JSON API defines two custom properties and two custom query roles:\n\n- Custom properties\n - `cx`: The identifier of the Programmable Search Engine.\n - `safe`: A description of the safe search level for filtering the returned results.\n- Custom query roles\n - `nextPage`: A role that indicates the query can be used to access the next logical page of results, if any.\n - `previousPage`: A role that indicates the query can be used to access the previous logical page of results, if any.\n\nTry it\n------\n\nTo play around and see what the API can do, without writing any code, visit the\n[\"Try this API\" tool](/custom-search/v1/reference/rest/v1/cse/list?apix=true).\n\nFor a full description of parameters visit the\n[cse.list reference](/custom-search/v1/reference/rest/v1/cse/list).\n\nTo learn how to use the API via HTTP requests, continue to\n[Using REST](/custom-search/v1/using_rest)."]]
