Method: cse.list

Возвращает метаданные о выполненном поиске, метаданные о системе, используемой для поиска, и результаты поиска.

HTTP-запрос

GET https://customsearch.googleapis.com/customsearch/v1

URL-адрес использует синтаксис транскодирования gRPC .

Параметры запроса

Параметры
c2coff

string

Включает или отключает упрощенный и традиционный китайский поиск .

Значение по умолчанию для этого параметра — 0 (ноль), что означает, что функция включена. Поддерживаемые значения:

  • 1 : Отключено

  • 0 : Включено (по умолчанию)

cr

string

Ограничивает результаты поиска документами, происходящими из определенной страны. Вы можете использовать логические операторы в значении параметра cr.

Поиск Google определяет страну документа, анализируя:

  • домен верхнего уровня (TLD) URL-адреса документа

  • географическое расположение IP-адреса веб-сервера

Список допустимых значений для этого параметра см. на странице «Значения параметров страны» .

cx

string

Идентификатор программируемой поисковой системы, который будет использоваться для этого запроса.

dateRestrict

string

Ограничивает результаты URL-адресами на основе даты. Поддерживаемые значения включают в себя:

  • d[number] : запрашивает результаты за указанное количество прошлых дней.

  • w[number] : запрашивает результаты за указанное количество прошлых недель.

  • m[number] : запрашивает результаты за указанное количество прошлых месяцев.

  • y[number] : запрашивает результаты за указанное количество прошлых лет.

exactTerms

string

Определяет фразу, которую должны содержать все документы в результатах поиска.

excludeTerms

string

Определяет слово или фразу, которые не должны появляться ни в каких документах в результатах поиска.

fileType

string

Ограничивает результаты файлами указанного расширения. Список типов файлов, индексируемых Google, можно найти в Справочном центре Search Console.

filter

string

Управляет включением или отключением фильтра дублированного контента.

  • Дополнительную информацию о фильтрах результатов поиска Google см. в разделе Автоматическая фильтрация . Обратите внимание, что фильтрация переполнения хостов применяется только к поиску по нескольким сайтам.

  • По умолчанию Google применяет фильтрацию ко всем результатам поиска, чтобы улучшить их качество.

Приемлемые значения:

  • 0 : отключает фильтр дублированного контента.

  • 1 : включает фильтр дублированного контента.

gl

string

Геолокация конечного пользователя.

  • Значение параметра gl представляет собой двухбуквенный код страны. Параметр gl повышает качество результатов поиска, страна происхождения которых соответствует значению параметра. Список допустимых значений см. на странице «Коды стран» .

  • Указание значения параметра gl должно привести к более релевантным результатам. Это особенно актуально для международных клиентов и, еще более конкретно, для клиентов в англоязычных странах, за исключением США.

googlehost

string

Устарело . Используйте параметр gl для аналогичного эффекта.

Локальный домен Google (например, google.com, google.de или google.fr), который будет использоваться для поиска.

highRange

string

Указывает конечное значение диапазона поиска.

  • Используйте lowRange и highRange , чтобы добавить к запросу инклюзивный диапазон поиска lowRange...highRange .
hl

string

Устанавливает язык пользовательского интерфейса.

hq

string

Добавляет указанные условия запроса к запросу, как если бы они были объединены логическим оператором И.

imgColorType

enum ( ImgColorType )

Возвращает черно-белые, полутоновые, прозрачные или цветные изображения. Приемлемые значения:

  • "color"

  • "gray"

  • "mono" : черно-белый

  • "trans" : прозрачный фон

imgDominantColor

enum ( ImgDominantColor )

Возвращает изображения определенного доминирующего цвета. Приемлемые значения:

  • "black"

  • "blue"

  • "brown"

  • "gray"

  • "green"

  • "orange"

  • "pink"

  • "purple"

  • "red"

  • "teal"

  • "white"

  • "yellow"

imgSize

enum ( ImgSize )

Возвращает изображения указанного размера. Приемлемые значения:

  • "huge"

  • "icon"

  • "large"

  • "medium"

  • "small"

  • "xlarge"

  • "xxlarge"

imgType

enum ( ImgType )

Возвращает изображения определенного типа. Приемлемые значения:

  • "clipart"

  • "face"

  • "lineart"

  • "stock"

  • "photo"

  • "animated"

lowRange

string

Указывает начальное значение диапазона поиска. Используйте lowRange и highRange , чтобы добавить к запросу инклюзивный диапазон поиска lowRange...highRange .

lr

string

Ограничивает поиск документами, написанными на определенном языке (например, lr=lang_ja ).

Приемлемые значения:

  • "lang_ar" : арабский

  • "lang_bg" : болгарский

  • "lang_ca" : каталанский

  • "lang_cs" : чешский

  • "lang_da" : датский

  • "lang_de" : немецкий

  • "lang_el" : греческий

  • "lang_en" : английский

  • "lang_es" : испанский

  • "lang_et" : эстонский

  • "lang_fi" : финский

  • "lang_fr" : французский

  • "lang_hr" : хорватский

  • "lang_hu" : венгерский

  • "lang_id" : индонезийский

  • "lang_is" : исландский

  • "lang_it" : итальянский

  • "lang_iw" : иврит

  • "lang_ja" : японский

  • "lang_ko" : корейский

  • "lang_lt" : литовский

  • "lang_lv" : латышский

  • "lang_nl" : голландский

  • "lang_no" : норвежский

  • "lang_pl" : польский

  • "lang_pt" : португальский

  • "lang_ro" : румынский

  • "lang_ru" : русский

  • "lang_sk" : словацкий

  • "lang_sl" : словенский

  • "lang_sr" : сербский

  • "lang_sv" : шведский

  • "lang_tr" : турецкий

  • "lang_zh-CN" : китайский (упрощенный).

  • "lang_zh-TW" : китайский (традиционный).

num

integer

Количество возвращаемых результатов поиска.

  • Допустимые значения — целые числа от 1 до 10 включительно.
orTerms

string

Предоставляет дополнительные условия поиска для проверки в документе, при этом каждый документ в результатах поиска должен содержать хотя бы один из дополнительных условий поиска.

q

string

Запрос

relatedSite
(deprecated)

string

Устарело.

rights

string

Фильтры на основе лицензирования. Поддерживаемые значения включают: cc_publicdomain , cc_attribute , cc_sharealike , cc_noncommercial , cc_nonderived и их комбинации. См. типичные комбинации .

safe

enum ( Safe )

Уровень безопасности поиска. Приемлемые значения:

  • "active" : включает фильтрацию безопасного поиска.

  • "off" : отключает фильтрацию безопасного поиска. (по умолчанию)

searchType

enum ( SearchType )

Указывает тип поиска: image . Если не указано, результаты ограничиваются веб-страницами.

Приемлемые значения:

  • "image" : пользовательский поиск изображений.
siteSearchFilter

enum ( SiteSearchFilter )

Определяет, включать или исключать результаты с сайта, указанного в параметре siteSearch .

Приемлемые значения:

  • "e" : исключить

  • "i" : включить

sort

string

Выражение сортировки, применяемое к результатам. Параметр sort указывает, что результаты сортируются в соответствии с указанным выражением, т. е. сортируются по дате. Пример: сортировка=дата .

start

integer ( uint32 format)

Индекс первого возвращаемого результата. По умолчанию количество результатов на странице равно 10, поэтому &start=11 будет начинаться в верхней части второй страницы результатов. Примечание . JSON API никогда не вернет более 100 результатов, даже если запросу соответствует более 100 документов, поэтому установка суммы start + num в число больше 100 приведет к ошибке. Также обратите внимание, что максимальное значение num равно 10.

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

В случае успеха тело ответа содержит экземпляр Search .

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/cse

Дополнительную информацию см. в обзоре OAuth 2.0 .