Web Search API, REST: WebSearchAsync.Search

Field

Description

query

SearchQuery

Required field. Search query.

sortSpec

SortSpec

The rules for sorting search results that define the sequence of the returned search results.

groupSpec

GroupSpec

Grouping settings that are used to group documents from a single domain into a container.

maxPassages

string (int64)

The maximum number of passages that can be used when generating a document snippet.

Acceptable values are 1 to 5, inclusive.

region

string

ID of the search country or region that impacts the document ranking rules.

The maximum string length in characters is 100.

l10n

enum (Localization)

The notification language for a search response.

• LOCALIZATION_RU: Russian (default value)
• LOCALIZATION_UK: Ukrainian
• LOCALIZATION_BE: Belarusian
• LOCALIZATION_KK: Kazakh
• LOCALIZATION_TR: Turkish
• LOCALIZATION_EN: English

folderId

string

ID of the folder.

The maximum string length in characters is 50.

responseFormat

enum (Format)

Search results format.

• FORMAT_XML: XML format (default value)
• FORMAT_HTML: HTML format

userAgent

string

User-Agent request header value.

The maximum string length in characters is 300.

metadata

SearchMetadata

Search flags

period

enum (Period)

Get results for the certain period

• PERIOD_ALL_TIME: All time
• PERIOD_DAY: Last 24 hours
• PERIOD_2_WEEKS: Last 2 weeks
• PERIOD_MONTH: Last month

Field

Description

searchType

enum (SearchType)

Required field. Search type that determines the domain name that will be used for the search queries.

• SEARCH_TYPE_RU: Russian search type (default), yandex.ru search domain name will be used.
• SEARCH_TYPE_TR: Turkish search type, yandex.tr search domain name will be used.
• SEARCH_TYPE_COM: International search type, yandex.com search domain name will be used.
• SEARCH_TYPE_KK: Kazakh search type, yandex.kz search domain name will be used.
• SEARCH_TYPE_BE: Belarusian search type, yandex.by search domain name will be used.
• SEARCH_TYPE_UZ: Uzbek search type, yandex.uz search domain name will be used.

queryText

string

Required field. Search query text

The maximum string length in characters is 400.

familyMode

enum (FamilyMode)

Rule for filtering search results and determines whether any documents should be excluded.

• FAMILY_MODE_NONE: Filtering is disabled. Search results include any documents regardless of their contents.
• FAMILY_MODE_MODERATE: Moderate filter (default value). Documents of the Adult category are excluded from search results
  unless a query is explicitly made for searching resources of this category.
• FAMILY_MODE_STRICT: Regardless of a search query, documents of the Adult category
  and those with profanity are excluded from search results.

page

string (int64)

The number of a requested page with search results

The minimum value is 0.

fixTypoMode

enum (FixTypoMode)

Typos autocorrections mode

• FIX_TYPO_MODE_ON: Automatically correct typos (default value).
• FIX_TYPO_MODE_OFF: Autocorrection is off.

Field

Description

sortMode

enum (SortMode)

Documents sorting mode.

• SORT_MODE_BY_RELEVANCE: Sort documents by relevance (default value).
• SORT_MODE_BY_TIME: Sort documents by update time.

sortOrder

enum (SortOrder)

Documents sorting order.

• SORT_ORDER_ASC: Reverse order from oldest to most recent.
• SORT_ORDER_DESC: Direct order from most recent to oldest (default).

Field

Description

groupMode

enum (GroupMode)

Grouping method.

• GROUP_MODE_FLAT: Flat grouping. Each group contains a single document.
• GROUP_MODE_DEEP: Grouping by domain. Each group contains documents from one domain.

groupsOnPage

string (int64)

Maximum number of groups that can be returned per page with search results.

Acceptable values are 1 to 100, inclusive.

docsInGroup

string (int64)

Maximum number of documents that can be returned per group.

Acceptable values are 1 to 3, inclusive.

Field

Description

fields

object (map<string, string>)

Search flags, key:value pairs.
No more than 64.
The maximum string length in characters for each value is 63.
Each value must match the regular expression [-_0-9a-z]*.
The string length in characters for each key must be 1-63.
Each key must match the regular expression [a-z][-_0-9a-z]*.

No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]*. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]*.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done

boolean

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

object

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

WebSearchResponse

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.

Field

Description

rawData

string (bytes)

Required field. Search results, either in XML or HTML format depending on the request settings.