Ответ на запрос пользовательского поиска.
JSON-представление |
---|
{ "kind": string, "url": { "type": string, "template": string }, "queries": { "previousPage": [ { "title": string, "totalResults": string, "searchTerms": string, "count": integer, "startIndex": integer, "startPage": integer, "language": string, "inputEncoding": string, "outputEncoding": string, "safe": string, "cx": string, "sort": string, "filter": string, "gl": string, "cr": string, "googleHost": string, "disableCnTwTranslation": string, "hq": string, "hl": string, "siteSearch": string, "siteSearchFilter": string, "exactTerms": string, "excludeTerms": string, "linkSite": string, "orTerms": string, "relatedSite": string, "dateRestrict": string, "lowRange": string, "highRange": string, "fileType": string, "rights": string, "searchType": string, "imgSize": string, "imgType": string, "imgColorType": string, "imgDominantColor": string } ], "request": [ { "title": string, "totalResults": string, "searchTerms": string, "count": integer, "startIndex": integer, "startPage": integer, "language": string, "inputEncoding": string, "outputEncoding": string, "safe": string, "cx": string, "sort": string, "filter": string, "gl": string, "cr": string, "googleHost": string, "disableCnTwTranslation": string, "hq": string, "hl": string, "siteSearch": string, "siteSearchFilter": string, "exactTerms": string, "excludeTerms": string, "linkSite": string, "orTerms": string, "relatedSite": string, "dateRestrict": string, "lowRange": string, "highRange": string, "fileType": string, "rights": string, "searchType": string, "imgSize": string, "imgType": string, "imgColorType": string, "imgDominantColor": string } ], "nextPage": [ { "title": string, "totalResults": string, "searchTerms": string, "count": integer, "startIndex": integer, "startPage": integer, "language": string, "inputEncoding": string, "outputEncoding": string, "safe": string, "cx": string, "sort": string, "filter": string, "gl": string, "cr": string, "googleHost": string, "disableCnTwTranslation": string, "hq": string, "hl": string, "siteSearch": string, "siteSearchFilter": string, "exactTerms": string, "excludeTerms": string, "linkSite": string, "orTerms": string, "relatedSite": string, "dateRestrict": string, "lowRange": string, "highRange": string, "fileType": string, "rights": string, "searchType": string, "imgSize": string, "imgType": string, "imgColorType": string, "imgDominantColor": string } ] }, "promotions": [ { object ( |
Поля | |
---|---|
kind | Уникальный идентификатор типа текущего объекта. Для этого API это customsearch#search. |
url | Элемент URL-адреса OpenSearch, определяющий шаблон для этого API. |
url.type | Тип MIME шаблона URL-адреса OpenSearch для API JSON пользовательского поиска. |
url.template | Фактический шаблон OpenSearch для этого API. |
queries | Содержит один или несколько наборов метаданных запроса, сгруппированных по имени роли. Возможные имена ролей включают |
queries.previousPage[] | Метаданные, представляющие предыдущую страницу результатов, если применимо. |
queries.previousPage[].title | Описание запроса. |
queries.previousPage[].totalResults | Примерное общее количество результатов поиска. Может быть неточно. |
queries.previousPage[].searchTerms | Условия поиска, введенные пользователем. |
queries.previousPage[].count | Количество результатов поиска, возвращенных в этом наборе. |
queries.previousPage[].startIndex | Индекс текущего набора результатов поиска в общем наборе результатов, где индекс первого результата равен 1. |
queries.previousPage[].startPage | Номер страницы этого набора результатов, где длина страницы задается свойством |
queries.previousPage[].language | Язык результатов поиска. |
queries.previousPage[].inputEncoding | Кодировка символов, поддерживаемая для поисковых запросов. |
queries.previousPage[].outputEncoding | Кодировка символов, поддерживаемая для результатов поиска. |
queries.previousPage[].safe | Указывает уровень безопасного поиска , используемый для фильтрации результатов для взрослых. Это настраиваемое свойство, не определенное в спецификации OpenSearch. Допустимые значения параметров:
|
queries.previousPage[].cx | Идентификатор системы, созданный с помощью панели управления программируемой поисковой системой. Это настраиваемое свойство, не определенное в спецификации OpenSearch. Этот параметр является обязательным . |
queries.previousPage[].sort | Указывает, что результаты должны быть отсортированы в соответствии с указанным выражением. Например, отсортировать по дате. |
queries.previousPage[].filter | Активирует или деактивирует автоматическую фильтрацию результатов поиска Google. Дополнительную информацию о фильтрах результатов поиска Google см. в разделе Автоматическая фильтрация . Допустимые значения для этого параметра:
Примечание . По умолчанию Google применяет фильтрацию ко всем результатам поиска, чтобы улучшить их качество. |
queries.previousPage[].gl | Улучшает результаты поиска, страна происхождения которых соответствует значению параметра. Список допустимых значений см. в разделе Коды стран . Указание значения параметра |
queries.previousPage[].cr | Ограничивает результаты поиска документами, происходящими из определенной страны. Вы можете использовать логические операторы в значении параметра Google WebSearch определяет страну документа, анализируя следующее:
Список допустимых значений для этого параметра см. в разделе «Значения параметра страны (cr)» . |
queries.previousPage[].googleHost | Указывает домен Google (например, google.com, google.de или google.fr), которым должен быть ограничен поиск. |
queries.previousPage[].disableCnTwTranslation | Включает или отключает функцию поиска на упрощенном и традиционном китайском языке . Поддерживаемые значения:
|
queries.previousPage[].hq | Добавляет указанные условия запроса к запросу, как если бы они были объединены логическим оператором |
queries.previousPage[].hl | Указывает язык интерфейса (язык хоста) вашего пользовательского интерфейса. Явная установка этого параметра повышает производительность и качество результатов поиска. Дополнительные сведения см. в разделе «Языки интерфейса» документа «Интернационализация запросов и представления результатов» , а список поддерживаемых языков — в разделе «Поддерживаемые языки интерфейса ». |
queries.previousPage[].siteSearch | Ограничивает результаты URL-адресами с указанного сайта. |
queries.previousPage[].siteSearchFilter | Указывает, включать или исключать результаты с сайта, указанного в параметре
|
queries.previousPage[].exactTerms | Определяет фразу, которую должны содержать все документы в результатах поиска. |
queries.previousPage[].excludeTerms | Определяет слово или фразу, которые не должны появляться ни в каких документах в результатах поиска. |
queries.previousPage[].linkSite | Указывает, что все результаты должны содержать ссылку на определенный URL-адрес. |
queries.previousPage[].orTerms | Предоставляет дополнительные условия поиска для проверки в документе, при этом каждый документ в результатах поиска должен содержать хотя бы один из дополнительных условий поиска. Для этого типа запроса вы также можете использовать логическое ИЛИ . |
queries.previousPage[].relatedSite | Указывает, что все результаты поиска должны представлять собой страницы, связанные с указанным URL-адресом. Значение параметра должно быть URL-адресом. |
queries.previousPage[].dateRestrict | Ограничивает результаты URL-адресами на основе даты. Поддерживаемые значения включают в себя:
|
queries.previousPage[].lowRange | Указывает начальное значение диапазона поиска. Используйте |
queries.previousPage[].highRange | Указывает конечное значение диапазона поиска. Используйте |
queries.previousPage[].fileType | Ограничивает результаты файлами указанного расширения. Типы файлов, поддерживаемые Google, включают:
В будущем могут быть добавлены дополнительные типы файлов. Актуальный список всегда можно найти в FAQ по типам файлов Google. |
queries.previousPage[].rights | Фильтры на основе лицензирования. Поддерживаемые значения включают в себя:
|
queries.previousPage[].searchType | Допустимые значения: |
queries.previousPage[].imgSize | Ограничивает результаты изображениями указанного размера. Поддерживаемые значения:
|
queries.previousPage[].imgType | Ограничивает результаты изображениями указанного типа. Поддерживаемые значения:
|
queries.previousPage[].imgColorType | Ограничивает результаты изображениями указанного цветового типа. Поддерживаемые значения:
|
queries.previousPage[].imgDominantColor | Ограничивает результаты изображениями с определенным доминирующим цветом. Поддерживаемые значения:
|
queries.request[] | Метаданные, представляющие текущий запрос. |
queries.request[].title | Описание запроса. |
queries.request[].totalResults | Примерное общее количество результатов поиска. Может быть неточно. |
queries.request[].searchTerms | Условия поиска, введенные пользователем. |
queries.request[].count | Количество результатов поиска, возвращенных в этом наборе. |
queries.request[].startIndex | Индекс текущего набора результатов поиска в общем наборе результатов, где индекс первого результата равен 1. |
queries.request[].startPage | Номер страницы этого набора результатов, где длина страницы задается свойством |
queries.request[].language | Язык результатов поиска. |
queries.request[].inputEncoding | Кодировка символов, поддерживаемая для поисковых запросов. |
queries.request[].outputEncoding | Кодировка символов, поддерживаемая для результатов поиска. |
queries.request[].safe | Указывает уровень безопасного поиска , используемый для фильтрации результатов для взрослых. Это настраиваемое свойство, не определенное в спецификации OpenSearch. Допустимые значения параметров:
|
queries.request[].cx | Идентификатор системы, созданный с помощью панели управления программируемой поисковой системой. Это настраиваемое свойство, не определенное в спецификации OpenSearch. Этот параметр является обязательным . |
queries.request[].sort | Указывает, что результаты должны быть отсортированы в соответствии с указанным выражением. Например, отсортировать по дате. |
queries.request[].filter | Активирует или деактивирует автоматическую фильтрацию результатов поиска Google. Дополнительную информацию о фильтрах результатов поиска Google см. в разделе Автоматическая фильтрация . Допустимые значения для этого параметра:
Примечание . По умолчанию Google применяет фильтрацию ко всем результатам поиска, чтобы улучшить их качество. |
queries.request[].gl | Улучшает результаты поиска, страна происхождения которых соответствует значению параметра. Список допустимых значений см. в разделе Коды стран . Указание значения параметра |
queries.request[].cr | Ограничивает результаты поиска документами, происходящими из определенной страны. Вы можете использовать логические операторы в значении параметра Google WebSearch определяет страну документа, анализируя следующее:
Список допустимых значений для этого параметра см. в разделе «Значения параметра страны (cr)» . |
queries.request[].googleHost | Указывает домен Google (например, google.com, google.de или google.fr), которым должен быть ограничен поиск. |
queries.request[].disableCnTwTranslation | Включает или отключает функцию поиска на упрощенном и традиционном китайском языке . Поддерживаемые значения:
|
queries.request[].hq | Добавляет указанные условия запроса к запросу, как если бы они были объединены логическим оператором |
queries.request[].hl | Указывает язык интерфейса (язык хоста) вашего пользовательского интерфейса. Явная установка этого параметра повышает производительность и качество результатов поиска. Дополнительные сведения см. в разделе «Языки интерфейса» документа «Интернационализация запросов и представления результатов» , а список поддерживаемых языков — в разделе «Поддерживаемые языки интерфейса ». |
queries.request[].siteSearch | Ограничивает результаты URL-адресами с указанного сайта. |
queries.request[].siteSearchFilter | Указывает, включать или исключать результаты с сайта, указанного в параметре
|
queries.request[].exactTerms | Определяет фразу, которую должны содержать все документы в результатах поиска. |
queries.request[].excludeTerms | Определяет слово или фразу, которые не должны появляться ни в каких документах в результатах поиска. |
queries.request[].linkSite | Указывает, что все результаты должны содержать ссылку на определенный URL-адрес. |
queries.request[].orTerms | Предоставляет дополнительные условия поиска для проверки в документе, при этом каждый документ в результатах поиска должен содержать хотя бы один из дополнительных условий поиска. Для этого типа запроса вы также можете использовать логическое ИЛИ . |
queries.request[].relatedSite | Указывает, что все результаты поиска должны представлять собой страницы, связанные с указанным URL-адресом. Значение параметра должно быть URL-адресом. |
queries.request[].dateRestrict | Ограничивает результаты URL-адресами на основе даты. Поддерживаемые значения включают в себя:
|
queries.request[].lowRange | Указывает начальное значение диапазона поиска. Используйте |
queries.request[].highRange | Указывает конечное значение диапазона поиска. Используйте |
queries.request[].fileType | Ограничивает результаты файлами указанного расширения. Типы файлов, поддерживаемые Google, включают:
В будущем могут быть добавлены дополнительные типы файлов. Актуальный список всегда можно найти в FAQ по типам файлов Google. |
queries.request[].rights | Фильтры на основе лицензирования. Поддерживаемые значения включают в себя:
|
queries.request[].searchType | Допустимые значения: |
queries.request[].imgSize | Ограничивает результаты изображениями указанного размера. Поддерживаемые значения:
|
queries.request[].imgType | Ограничивает результаты изображениями указанного типа. Поддерживаемые значения:
|
queries.request[].imgColorType | Ограничивает результаты изображениями указанного цветового типа. Поддерживаемые значения:
|
queries.request[].imgDominantColor | Ограничивает результаты изображениями с определенным доминирующим цветом. Поддерживаемые значения:
|
queries.nextPage[] | Метаданные, представляющие следующую страницу результатов, если применимо. |
queries.nextPage[].title | Описание запроса. |
queries.nextPage[].totalResults | Примерное общее количество результатов поиска. Может быть неточно. |
queries.nextPage[].searchTerms | Условия поиска, введенные пользователем. |
queries.nextPage[].count | Количество результатов поиска, возвращенных в этом наборе. |
queries.nextPage[].startIndex | Индекс текущего набора результатов поиска в общем наборе результатов, где индекс первого результата равен 1. |
queries.nextPage[].startPage | Номер страницы этого набора результатов, где длина страницы задается свойством |
queries.nextPage[].language | Язык результатов поиска. |
queries.nextPage[].inputEncoding | Кодировка символов, поддерживаемая для поисковых запросов. |
queries.nextPage[].outputEncoding | Кодировка символов, поддерживаемая для результатов поиска. |
queries.nextPage[].safe | Указывает уровень безопасного поиска , используемый для фильтрации результатов для взрослых. Это настраиваемое свойство, не определенное в спецификации OpenSearch. Допустимые значения параметров:
|
queries.nextPage[].cx | Идентификатор системы, созданный с помощью панели управления программируемой поисковой системой. Это настраиваемое свойство, не определенное в спецификации OpenSearch. Этот параметр является обязательным . |
queries.nextPage[].sort | Указывает, что результаты должны быть отсортированы в соответствии с указанным выражением. Например, отсортировать по дате. |
queries.nextPage[].filter | Активирует или деактивирует автоматическую фильтрацию результатов поиска Google. Дополнительную информацию о фильтрах результатов поиска Google см. в разделе Автоматическая фильтрация . Допустимые значения для этого параметра:
Примечание . По умолчанию Google применяет фильтрацию ко всем результатам поиска, чтобы улучшить их качество. |
queries.nextPage[].gl | Улучшает результаты поиска, страна происхождения которых соответствует значению параметра. Список допустимых значений см. в разделе Коды стран . Указание значения параметра |
queries.nextPage[].cr | Ограничивает результаты поиска документами, происходящими из определенной страны. Вы можете использовать логические операторы в значении параметра Google WebSearch определяет страну документа, анализируя следующее:
Список допустимых значений для этого параметра см. в разделе «Значения параметра страны (cr)» . |
queries.nextPage[].googleHost | Указывает домен Google (например, google.com, google.de или google.fr), которым должен быть ограничен поиск. |
queries.nextPage[].disableCnTwTranslation | Включает или отключает функцию поиска на упрощенном и традиционном китайском языке . Поддерживаемые значения:
|
queries.nextPage[].hq | Добавляет указанные условия запроса к запросу, как если бы они были объединены логическим оператором |
queries.nextPage[].hl | Указывает язык интерфейса (язык хоста) вашего пользовательского интерфейса. Явная установка этого параметра повышает производительность и качество результатов поиска. Дополнительные сведения см. в разделе «Языки интерфейса» документа «Интернационализация запросов и представления результатов» , а список поддерживаемых языков — в разделе «Поддерживаемые языки интерфейса ». |
queries.nextPage[].siteSearch | Ограничивает результаты URL-адресами с указанного сайта. |
queries.nextPage[].siteSearchFilter | Указывает, включать или исключать результаты с сайта, указанного в параметре
|
queries.nextPage[].exactTerms | Определяет фразу, которую должны содержать все документы в результатах поиска. |
queries.nextPage[].excludeTerms | Определяет слово или фразу, которые не должны появляться ни в каких документах в результатах поиска. |
queries.nextPage[].linkSite | Указывает, что все результаты должны содержать ссылку на определенный URL-адрес. |
queries.nextPage[].orTerms | Предоставляет дополнительные условия поиска для проверки в документе, при этом каждый документ в результатах поиска должен содержать хотя бы один из дополнительных условий поиска. Для этого типа запроса вы также можете использовать логическое ИЛИ . |
queries.nextPage[].relatedSite | Указывает, что все результаты поиска должны представлять собой страницы, связанные с указанным URL-адресом. Значение параметра должно быть URL-адресом. |
queries.nextPage[].dateRestrict | Ограничивает результаты URL-адресами на основе даты. Поддерживаемые значения включают в себя:
|
queries.nextPage[].lowRange | Указывает начальное значение диапазона поиска. Используйте |
queries.nextPage[].highRange | Указывает конечное значение диапазона поиска. Используйте |
queries.nextPage[].fileType | Ограничивает результаты файлами указанного расширения. Типы файлов, поддерживаемые Google, включают:
В будущем могут быть добавлены дополнительные типы файлов. Актуальный список всегда можно найти в FAQ по типам файлов Google. |
queries.nextPage[].rights | Фильтры на основе лицензирования. Поддерживаемые значения включают в себя:
|
queries.nextPage[].searchType | Допустимые значения: |
queries.nextPage[].imgSize | Ограничивает результаты изображениями указанного размера. Поддерживаемые значения:
|
queries.nextPage[].imgType | Ограничивает результаты изображениями указанного типа. Поддерживаемые значения:
|
queries.nextPage[].imgColorType | Ограничивает результаты изображениями указанного цветового типа. Поддерживаемые значения:
|
queries.nextPage[].imgDominantColor | Ограничивает результаты изображениями с определенным доминирующим цветом. Поддерживаемые значения:
|
promotions[] | Набор промо-акций . Присутствует только в том случае, если в файлах конфигурации системы пользовательского поиска определены какие-либо рекламные акции для данного запроса. |
context | Метаданные и уточнения, связанные с данной поисковой системой, в том числе:
|
searchInformation | Метаданные об этом поиске, включая время поиска и общее количество результатов. |
searchInformation.searchTime | Время, необходимое серверу для возврата результатов поиска. |
searchInformation.formattedSearchTime | Время, необходимое серверу для возврата результатов поиска, отформатированных в соответствии со стилем локали. |
searchInformation.totalResults | Общее количество результатов поиска, возвращаемых запросом. |
searchInformation.formattedTotalResults | Общее количество результатов поиска, отформатированное в соответствии со стилем локали. |
spelling | Инкапсулирует исправленный запрос. |
spelling.correctedQuery | Исправленный запрос. |
spelling.htmlCorrectedQuery | Исправленный запрос, отформатированный в HTML. |
items[] | Текущий набор результатов пользовательского поиска. |
Повышение
Результат продвижения.
JSON-представление |
---|
{ "title": string, "htmlTitle": string, "link": string, "displayLink": string, "bodyLines": [ { "title": string, "htmlTitle": string, "url": string, "link": string } ], "image": { "source": string, "width": integer, "height": integer } } |
Поля | |
---|---|
title | Название акции. |
htmlTitle | Название рекламной акции в формате HTML. |
link | URL-адрес промоакции. |
displayLink | Сокращенная версия URL-адреса результатов поиска, например www.example.com. |
bodyLines[] | Массив блочных объектов для данной акции. |
bodyLines[].title | Текст объекта блока, если он имеет текст. |
bodyLines[].htmlTitle | Текст объекта блока в HTML, если он имеет текст. |
bodyLines[].url | URL-адрес ссылки на объект блокировки, если она есть. |
bodyLines[].link | Текст привязки ссылки объекта блока, если он имеет ссылку. |
image | Изображение, связанное с этой рекламной акцией, если оно есть. |
image.source | URL изображения для этой рекламной ссылки. |
image.width | Ширина изображения в пикселях. |
image.height | Высота изображения в пикселях. |
Результат
Пользовательский результат поиска.
JSON-представление |
---|
{ "kind": string, "title": string, "htmlTitle": string, "link": string, "displayLink": string, "snippet": string, "htmlSnippet": string, "cacheId": string, "formattedUrl": string, "htmlFormattedUrl": string, "pagemap": { object }, "mime": string, "fileFormat": string, "image": { "contextLink": string, "height": integer, "width": integer, "byteSize": integer, "thumbnailLink": string, "thumbnailHeight": integer, "thumbnailWidth": integer }, "labels": [ { "name": string, "displayName": string, "label_with_op": string } ] } |
Поля | |
---|---|
kind | Уникальный идентификатор типа текущего объекта. Для этого API это |
title | Название результата поиска в виде обычного текста. |
htmlTitle | Название результата поиска в формате HTML. |
link | Полный URL-адрес, на который указывает результат поиска, например http://www.example.com/foo/bar . |
displayLink | Сокращенная версия URL-адреса этого результата поиска, например www.example.com. |
snippet | Фрагмент результата поиска в виде обычного текста. |
htmlSnippet | Фрагмент результата поиска в формате HTML. |
cacheId | Указывает идентификатор кэшированной версии результата поиска Google. |
formattedUrl | URL-адрес, отображаемый после фрагмента для каждого результата поиска. |
htmlFormattedUrl | URL-адрес в формате HTML, отображаемый после фрагмента для каждого результата поиска. |
pagemap | Содержит информацию PageMap для этого результата поиска. |
mime | MIME-тип результата поиска. |
fileFormat | Формат файла результатов поиска. |
image | Инкапсулирует всю информацию об изображении, возвращаемую в результатах поиска. |
image.contextLink | URL-адрес, указывающий на веб-страницу, на которой размещено изображение. |
image.height | Высота изображения в пикселях. |
image.width | Ширина изображения в пикселях. |
image.byteSize | Размер изображения в байтах. |
image.thumbnailLink | URL-адрес миниатюры изображения. |
image.thumbnailHeight | Высота миниатюры изображения в пикселях. |
image.thumbnailWidth | Ширина миниатюры изображения в пикселях. |
labels[] | Инкапсулирует всю информацию о метках уточнений. |
labels[].name | Имя метки уточнения, которую можно использовать для уточнения поиска. Не отображайте это в своем пользовательском интерфейсе; вместо этого используйте displayName. |
labels[].displayName | Отображаемое имя метки уточнения. Это имя, которое вы должны отображать в своем пользовательском интерфейсе. |
labels[].label_with_op | Метка уточнения и связанная с ним операция уточнения. |