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

Class AdsGetPostsReachQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<AdsGetPostsReachQuery,java.util.List<GetPostsReachResponse>>

com.vk.api.sdk.queries.ads.AdsGetPostsReachQuery

public class AdsGetPostsReachQuery
extends AbstractQueryBuilder<AdsGetPostsReachQuery,java.util.List<GetPostsReachResponse>>

Query for Ads.getPostsReach method

Constructor Summary

Constructors

Constructor	Description
AdsGetPostsReachQuery(VkApiClient client, UserActor actor, int accountId, GetPostsReachIdsType idsType, java.lang.String ids)	Creates a AbstractQueryBuilder instance that can be used to build api request with various parameters

Method Summary

Modifier and Type	Method	Description
protected AdsGetPostsReachQuery	accountId(int value)	Advertising account ID.
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
protected AdsGetPostsReachQuery	getThis()	Get reference to this object
protected AdsGetPostsReachQuery	ids(java.lang.String value)	IDs requested ads or campaigns, separated with a comma, depending on the value set in 'ids_type'.
protected AdsGetPostsReachQuery	idsType(GetPostsReachIdsType value)	Type of requested objects listed in 'ids' parameter: *ad — ads,, *campaign — campaigns.

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

AdsGetPostsReachQuery

public AdsGetPostsReachQuery(VkApiClient client,
                             UserActor actor,
                             int accountId,
                             GetPostsReachIdsType idsType,
                             java.lang.String ids)

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

accountId - value of "account id" parameter.

idsType - value of "ids type" parameter.

ids - value of "ids" parameter.

Method Detail

accountId

protected AdsGetPostsReachQuery accountId(int value)

Advertising account ID.

Parameters:

value - value of "account id" parameter.

Returns:

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

idsType

protected AdsGetPostsReachQuery idsType(GetPostsReachIdsType value)

Type of requested objects listed in 'ids' parameter: *ad — ads,, *campaign — campaigns.

Parameters:

value - value of "ids type" parameter.

Returns:

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

ids

protected AdsGetPostsReachQuery ids(java.lang.String value)

IDs requested ads or campaigns, separated with a comma, depending on the value set in 'ids_type'. Maximum 100 objects.

Parameters:

value - value of "ids" parameter.

Returns:

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

getThis

protected AdsGetPostsReachQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<AdsGetPostsReachQuery,java.util.List<GetPostsReachResponse>>

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<AdsGetPostsReachQuery,java.util.List<GetPostsReachResponse>>

Returns:

list of names