com.vk.api.sdk.queries.adsweb

Class AdswebGetAdUnitsQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<AdswebGetAdUnitsQuery,GetAdUnitsResponse>

com.vk.api.sdk.queries.adsweb.AdswebGetAdUnitsQuery

public class AdswebGetAdUnitsQuery
extends AbstractQueryBuilder<AdswebGetAdUnitsQuery,GetAdUnitsResponse>

Query for Adsweb.getAdUnits method

Constructor Summary

Constructors

Constructor and Description
AdswebGetAdUnitsQuery(VkApiClient client, UserActor actor) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters
AdswebGetAdUnitsQuery(VkApiClient client, UserActor actor, java.lang.Integer officeId) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters

Method Summary

Modifier and Type	Method and Description
AdswebGetAdUnitsQuery	adUnitsIds(java.lang.String value) Set ad units ids
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
AdswebGetAdUnitsQuery	fields(java.lang.String value) Set fields
protected AdswebGetAdUnitsQuery	getThis() Get reference to this object
AdswebGetAdUnitsQuery	limit(java.lang.Integer value) Set limit
AdswebGetAdUnitsQuery	officeId(java.lang.Integer value) Set office id
AdswebGetAdUnitsQuery	offset(java.lang.Integer value) Set offset
AdswebGetAdUnitsQuery	sitesIds(java.lang.String value) Set sites ids

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

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

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

addHeader, addHeaders, execute, executeAsRaw, executeAsString, executeAsStringWithReturningFullInfo, executeTypeable, executeTypeableWithoutRetry, executeWithoutRetry, getClient, getCookie, getGson, getHeaders, getResponseClass, getUrl, setCookie, setCookies, setHeaders, setHeaders

Methods inherited from class java.lang.Object

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

Constructor Detail

AdswebGetAdUnitsQuery

public AdswebGetAdUnitsQuery(VkApiClient client,
                             UserActor actor,
                             java.lang.Integer officeId)

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

Parameters:

client - VK API client

actor - actor with access token

officeId - value of "office id" parameter.

AdswebGetAdUnitsQuery

public AdswebGetAdUnitsQuery(VkApiClient client,
                             UserActor actor)

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

Parameters:

client - VK API client

actor - actor with access token

Method Detail

officeId

public AdswebGetAdUnitsQuery officeId(java.lang.Integer value)

Set office id

Parameters:

value - value of "office id" parameter.

Returns:

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

sitesIds

public AdswebGetAdUnitsQuery sitesIds(java.lang.String value)

Set sites ids

Parameters:

value - value of "sites ids" parameter.

Returns:

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

adUnitsIds

public AdswebGetAdUnitsQuery adUnitsIds(java.lang.String value)

Set ad units ids

Parameters:

value - value of "ad units ids" parameter.

Returns:

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

fields

public AdswebGetAdUnitsQuery fields(java.lang.String value)

Set fields

Parameters:

value - value of "fields" parameter.

Returns:

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

limit

public AdswebGetAdUnitsQuery limit(java.lang.Integer value)

Set limit

Parameters:

value - value of "limit" parameter. Minimum is 0.

Returns:

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

offset

public AdswebGetAdUnitsQuery offset(java.lang.Integer value)

Set offset

Parameters:

value - value of "offset" parameter. Minimum is 0. By default 0.

Returns:

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

getThis

protected AdswebGetAdUnitsQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<AdswebGetAdUnitsQuery,GetAdUnitsResponse>

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<AdswebGetAdUnitsQuery,GetAdUnitsResponse>

Returns:

list of names