Package com.vk.api.sdk.queries.ads

Class AdsGetSuggestionsQuery

java.lang.Object

com.vk.api.sdk.client.ApiRequest<R>

com.vk.api.sdk.client.AbstractQueryBuilder<AdsGetSuggestionsQuery,java.util.List<GetSuggestionsResponse>>

com.vk.api.sdk.queries.ads.AdsGetSuggestionsQuery

public class AdsGetSuggestionsQuery
extends AbstractQueryBuilder<AdsGetSuggestionsQuery,java.util.List<GetSuggestionsResponse>>

Query for Ads.getSuggestions method

Constructor Summary

Constructors

Constructor	Description
AdsGetSuggestionsQuery(VkApiClient client, UserActor actor, GetSuggestionsSection section)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters

Method Summary

Modifier and Type	Method	Description
AdsGetSuggestionsQuery	cities(java.lang.String value)	IDs of cities where objects are searched in, separated with a comma.
AdsGetSuggestionsQuery	country(java.lang.Integer value)	ID of the country objects are searched in.
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
protected AdsGetSuggestionsQuery	getThis()	Get reference to this object
AdsGetSuggestionsQuery	ids(java.lang.String value)	Objects IDs separated by commas.
AdsGetSuggestionsQuery	lang(GetSuggestionsLang value)	Language of the returned string values.
AdsGetSuggestionsQuery	q(java.lang.String value)	Filter-line of the request (for countries, regions, cities, streets, schools, interests, positions).
protected AdsGetSuggestionsQuery	section(GetSuggestionsSection value)	Section, suggestions are retrieved in.

Methods inherited from class com.vk.api.sdk.client.AbstractQueryBuilder

accessToken, build, captchaKey, captchaSid, clientSecret, confirm, getBody, getMethod, getParams, lang, toString, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, unsafeParam, version

Methods inherited from class com.vk.api.sdk.client.ApiRequest

execute, executeAsRaw, executeAsString, getClient, getGson, getHeaders, getResponseClass, getUrl, setHeaders

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AdsGetSuggestionsQuery

public AdsGetSuggestionsQuery(VkApiClient client,
                              UserActor actor,
                              GetSuggestionsSection section)

Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters

Parameters:

client - VK API client

actor - actor with access token

section - value of "section" parameter.

Method Detail

section

protected AdsGetSuggestionsQuery section(GetSuggestionsSection value)

Section, suggestions are retrieved in. Available values: *countries — request of a list of countries. If q is not set or blank, a short list of countries is shown. Otherwise, a full list of countries is shown. *regions — requested list of regions. 'country' parameter is required. *cities — requested list of cities. 'country' parameter is required. *districts — requested list of districts. 'cities' parameter is required. *stations — requested list of subway stations. 'cities' parameter is required. *streets — requested list of streets. 'cities' parameter is required. *schools — requested list of educational organizations. 'cities' parameter is required. *interests — requested list of interests. *positions — requested list of positions (professions). *group_types — requested list of group types. *religions — requested list of religious commitments. *browsers — requested list of browsers and mobile devices.

Parameters:

value - value of "section" parameter.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

ids

public AdsGetSuggestionsQuery ids(java.lang.String value)

Objects IDs separated by commas. If the parameter is passed, 'q, country, cities' should not be passed.

Parameters:

value - value of "ids" parameter.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

q

public AdsGetSuggestionsQuery q(java.lang.String value)

Filter-line of the request (for countries, regions, cities, streets, schools, interests, positions).

Parameters:

value - value of "q" parameter.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

country

public AdsGetSuggestionsQuery country(java.lang.Integer value)

ID of the country objects are searched in.

Parameters:

value - value of "country" parameter.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

cities

public AdsGetSuggestionsQuery cities(java.lang.String value)

IDs of cities where objects are searched in, separated with a comma.

Parameters:

value - value of "cities" parameter.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

lang

public AdsGetSuggestionsQuery lang(GetSuggestionsLang value)

Language of the returned string values. Supported languages: *ru — Russian,, *ua — Ukrainian,, *en — English.

Parameters:

value - value of "lang" parameter.

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

getThis

protected AdsGetSuggestionsQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<AdsGetSuggestionsQuery,java.util.List<GetSuggestionsResponse>>

Returns:

a reference to this AbstractQueryBuilder object to fulfill the "Builder" pattern.

essentialKeys

protected java.util.List<java.lang.String> essentialKeys()

Description copied from class: AbstractQueryBuilder

Get list of required parameter names

Specified by:

essentialKeys in class AbstractQueryBuilder<AdsGetSuggestionsQuery,java.util.List<GetSuggestionsResponse>>

Returns:

list of names