Documentation

hasSearchVolume

Generates an approximate forecast of impressions for the specified keywords and regions, broken down by device type. Used when selecting keywords.

Restrictions

Each advertiser can send a maximum of 20 requests every 60 seconds to the Reports service.

Request

Request structure in JSON format:

{
  "method": "hasSearchVolume",
  "params": { 
    "SelectionCriteria
[no-highlight[

The keywords and regions to get a forecast for.

Required

Yes

]no-highlight]
": { /* HasSearchVolumeSelectionCriteria */ "Keywords
[no-highlight[

Keywords. From 1 to 10,000 items in the array. Duplicate strings are not allowed.

A keyword may contain operators.

The maximum length of a keyword is 4096 characters. The “!” operator before a negative keyword is not counted in the keyword length (the sequence “-!” is considered one character).

Maximum of 7 words per keyword, not counting stop words and negative keywords. Each word can have up to 35 characters, not counting the minus sign before a negative keyword.

Required

Yes

]no-highlight]
": [(string), ... ], /* required */ "RegionIds
[no-highlight[

IDs of regions where ad impressions are enabled or disabled.

The ID 0 specifies to display ads in all regions.

A minus sign before a region ID disables impressions in this region. For example, [1,-219] indicates to display for Moscow and the entire Moscow area, except Chernogolovka. Minus regions can‘t be used if 0 is set. The array must not consist of only minus regions.

To get the list of regions, use the method Dictionaries.get.

Required

Yes

]no-highlight]
": [(long), ... ] /* required */ }, /* required */ "FieldNames
[no-highlight[

The names of parameters to get.

Required

Yes

]no-highlight]
": [( "Keyword" | "RegionIds" | "AllDevices" | "MobilePhones" | "Tablets" | "Desktops" ), ... ] /* required */ } }

Parameters are described below.

Parameter Type Description Required
params structure (for JSON) / HasSearchVolumeRequest (for SOAP)
SelectionCriteria HasSearchVolumeSelectionCriteria

The keywords and regions to get a forecast for.

Yes
FieldNames array of HasSearchVolumeFieldEnum

The names of parameters to get.

Yes
HasSearchVolumeSelectionCriteria structure
Keywords array of string

Keywords. From 1 to 10,000 items in the array. Duplicate strings are not allowed.

A keyword may contain operators.

The maximum length of a keyword is 4096 characters. The “!” operator before a negative keyword is not counted in the keyword length (the sequence “-!” is considered one character).

Maximum of 7 words per keyword, not counting stop words and negative keywords. Each word can have up to 35 characters, not counting the minus sign before a negative keyword.

Yes
RegionIds array of long

IDs of regions where ad impressions are enabled or disabled.

The ID 0 specifies to display ads in all regions.

A minus sign before a region ID disables impressions in this region. For example, [1,-219] indicates to display for Moscow and the entire Moscow area, except Chernogolovka. Minus regions can't be used if 0 is set. The array must not consist of only minus regions.

To get the list of regions, use the method Dictionaries
[no-highlight[

This service is for getting reference data: regions, time zones, currency exchange rates, metro stations, restrictions on parameter values, and other information.

More Dictionaries

]no-highlight]
.get
[no-highlight[

Returns reference data: regions, time zones, currency exchange rates, metro stations, restrictions on parameter values, ad exchanges (SSPs), and other information.

More get

]no-highlight]
.
Yes

Response

Response structure in JSON format:

{
  "result": { 
    "HasSearchVolumeResults
[no-highlight[

Forecast of impressions.

]no-highlight]
": [{ /* HasSearchVolumeItem */ "Keyword
[no-highlight[

The keyword from the request.

]no-highlight]
": (strng), "RegionIds
[no-highlight[

Region IDs from the request.

]no-highlight]
": [(long), ... ], "AllDevices
[no-highlight[

Whether there are impressions.

]no-highlight]
": ( YES | NO ), "MobilePhones
[no-highlight[

Whether there are impressions on mobile phones.

]no-highlight]
": ( YES | NO ), "Tablets
[no-highlight[

Whether there are impressions on tablets.

]no-highlight]
": ( YES | NO ), "Desktops
[no-highlight[

Whether there are impressions on desktop browsers.

]no-highlight]
": ( YES | NO ) }, ... ], } }

Parameters are described below.

Parameter Type Description
result structure (for JSON) / HasSearchVolumeResponse (for SOAP)
HasSearchVolumeResults array of HasSearchVolumeItemForecast of impressions.
HasSearchVolumeItem structure
Keyword stringThe keyword from the request.
RegionIds array of longRegion IDs from the request.
AllDevices YesNoEnumWhether there are impressions.
MobilePhones YesNoEnumWhether there are impressions on mobile phones.
Tablets YesNoEnumWhether there are impressions on tablets.
Desktops YesNoEnumWhether there are impressions on desktop browsers.