Zwraca metadane dotyczące przeprowadzonego wyszukiwania, metadane użyte do wyszukiwania oraz wyniki wyszukiwania. Używa małego zestawu wzorców adresów URL.
Żądanie HTTP
GET https://customsearch.googleapis.com/customsearch/v1/siterestrict
Adres URL używa składni transkodowania gRPC.
Parametry zapytania
| Parametry | |
|---|---|
| c2coff | 
 Włącza lub wyłącza wyszukiwanie w języku chińskim tradycyjnym i uproszczonym. Domyślna wartość tego parametru to 0 (zero), co oznacza, że funkcja jest włączona. Obsługiwane wartości to: 
 | 
| cr | 
 Ogranicza wyniki wyszukiwania do dokumentów pochodzących z określonego kraju. W wartości parametru cr możesz użyć operatorów logicznych. Wyszukiwarka Google określa kraj dokumentu na podstawie analizy: 
 Listę prawidłowych wartości tego parametru znajdziesz na stronie Wartości parametrów krajowych. | 
| cx | 
 Identyfikator Wyszukiwarki niestandardowej, która ma zostać użyta w tym żądaniu. | 
| dateRestrict | 
 Ogranicza wyniki do adresów URL na podstawie daty. Obsługiwane wartości to między innymi: 
 | 
| exactTerms | 
 Określa wyrażenie, które muszą zawierać wszystkie dokumenty w wynikach wyszukiwania. | 
| excludeTerms | 
 Identyfikuje słowo lub wyrażenie, które nie powinno występować w żadnym dokumencie w wynikach wyszukiwania. | 
| fileType | 
 Ogranicza wyniki do plików z określonym rozszerzeniem. Listę typów plików możliwych do zindeksowania przez Google znajdziesz w Centrum pomocy Search Console. | 
| filter | 
 Służy do włączania i wyłączania filtra powielonych treści. 
 Dopuszczalne wartości: 
 | 
| gl | 
 Geolokalizacja użytkownika. 
 | 
| googlehost | 
 Wycofano. W celu uzyskania podobnego efektu użyj parametru  Lokalna domena Google (na przykład google.com, google.de lub google.fr), która ma zostać użyta do wyszukiwania. | 
| highRange | 
 Określa wartość końcową dla zakresu wyszukiwania. 
 | 
| hl | 
 Ustawia język interfejsu użytkownika. 
 | 
| hq | 
 Dodaje określone hasła do zapytania w taki sposób, jakby zostały połączone za pomocą operatora logicznego AND. | 
| imgColorType | 
 Wyświetla obrazy czarno-białe, w skali szarości, przezroczyste lub kolorowe. Dopuszczalne wartości: 
 | 
| imgDominantColor | 
 Zwraca obrazy w określonym kolorze dominującym. Dopuszczalne wartości: 
 | 
| imgSize | 
 Zwraca obrazy o określonym rozmiarze. Dopuszczalne wartości: 
 | 
| imgType | 
 Zwraca obrazy określonego typu. Dopuszczalne wartości: 
 | 
| linkSite | 
 Określa, że wszystkie wyniki wyszukiwania powinny zawierać link do określonego adresu URL. | 
| lowRange | 
 Określa wartość początkową zakresu wyszukiwania. Użyj funkcji  | 
| lr | 
 Ogranicza wyszukiwanie do dokumentów napisanych w określonym języku (np.  Dopuszczalne wartości: 
 | 
| num | 
 Liczba wyników wyszukiwania do zwrócenia. 
 | 
| orTerms | 
 Zawiera dodatkowe wyszukiwane hasła do sprawdzenia w dokumencie. Każdy dokument w wynikach wyszukiwania musi zawierać co najmniej jedno z dodatkowych wyszukiwanych haseł. | 
| q | 
 Zapytanie | 
| relatedSite | 
 Rola wycofana. | 
| rights | 
 Filtry działające na podstawie licencjonowania. Obsługiwane wartości to:  | 
| safe | 
 Poziom bezpieczeństwa wyszukiwania. Dopuszczalne wartości: 
 | 
| searchType | 
 Określa typ wyszukiwania:  Dopuszczalne wartości: 
 | 
| siteSearch | 
 Wskazuje daną witrynę, która zawsze powinna być uwzględniana w wynikach lub z niego wykluczana (patrz parametr  | 
| siteSearchFilter | 
 Określa, czy mają być uwzględniane czy wykluczane wyniki z witryny wymienionej w parametrze  Dopuszczalne wartości: 
 | 
| sort | 
 Wyrażenie sortowania, które ma zostać zastosowane do wyników. Parametr sortowania określa, że wyniki mają być sortowane według określonego wyrażenia, tj. według daty. Przykład: sort=date. | 
| start | 
 Indeks pierwszego wyniku do zwrócenia. Domyślna liczba wyników na stronę to 10, więc  | 
Treść żądania
Treść żądania musi być pusta.
Treść odpowiedzi
W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu Search.
Zakresy autoryzacji
Wymaga następującego zakresu OAuth:
- https://www.googleapis.com/auth/cse
Więcej informacji znajdziesz w artykule Omówienie protokołu OAuth 2.0.