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

Class AdsGetAdsTargetingQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<AdsGetAdsTargetingQuery,java.util.List<GetAdsTargetingResponse>>

com.vk.api.sdk.queries.ads.AdsGetAdsTargetingQuery

public class AdsGetAdsTargetingQuery
extends AbstractQueryBuilder<AdsGetAdsTargetingQuery,java.util.List<GetAdsTargetingResponse>>

Query for Ads.getAdsTargeting method

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected AdsGetAdsTargetingQuery	accountId(int value)	Advertising account ID.
AdsGetAdsTargetingQuery	adIds(java.lang.String value)	Filter by ads.
AdsGetAdsTargetingQuery	campaignIds(java.lang.String value)	Filter by advertising campaigns.
AdsGetAdsTargetingQuery	clientId(java.lang.Integer value)	'For advertising agencies.' ID of the client ads are retrieved from.
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
protected AdsGetAdsTargetingQuery	getThis()	Get reference to this object
AdsGetAdsTargetingQuery	includeDeleted(java.lang.Boolean value)	Flag that specifies whether archived ads shall be shown: *0 — show only active ads,, *1 — show all ads.
AdsGetAdsTargetingQuery	limit(java.lang.Integer value)	Limit of number of returned ads.
AdsGetAdsTargetingQuery	offset(java.lang.Integer value)	Offset needed to return a specific subset of results.

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

AdsGetAdsTargetingQuery

public AdsGetAdsTargetingQuery(VkApiClient client,
                               UserActor actor,
                               int accountId)

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.

Method Detail

accountId

protected AdsGetAdsTargetingQuery 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.

adIds

public AdsGetAdsTargetingQuery adIds(java.lang.String value)

Filter by ads. Serialized JSON array with ad IDs. If the parameter is null, all ads will be shown.

Parameters:

value - value of "ad ids" parameter.

Returns:

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

campaignIds

public AdsGetAdsTargetingQuery campaignIds(java.lang.String value)

Filter by advertising campaigns. Serialized JSON array with campaign IDs. If the parameter is null, ads of all campaigns will be shown.

Parameters:

value - value of "campaign ids" parameter.

Returns:

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

clientId

public AdsGetAdsTargetingQuery clientId(java.lang.Integer value)

'For advertising agencies.' ID of the client ads are retrieved from.

Parameters:

value - value of "client id" parameter.

Returns:

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

includeDeleted

public AdsGetAdsTargetingQuery includeDeleted(java.lang.Boolean value)

Flag that specifies whether archived ads shall be shown: *0 — show only active ads,, *1 — show all ads.

Parameters:

value - value of "include deleted" parameter.

Returns:

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

limit

public AdsGetAdsTargetingQuery limit(java.lang.Integer value)

Limit of number of returned ads. Used only if 'ad_ids' parameter is null, and 'campaign_ids' parameter contains ID of only one campaign.

Parameters:

value - value of "limit" parameter.

Returns:

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

offset

public AdsGetAdsTargetingQuery offset(java.lang.Integer value)

Offset needed to return a specific subset of results.

Parameters:

value - value of "offset" parameter.

Returns:

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

getThis

protected AdsGetAdsTargetingQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<AdsGetAdsTargetingQuery,java.util.List<GetAdsTargetingResponse>>

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<AdsGetAdsTargetingQuery,java.util.List<GetAdsTargetingResponse>>

Returns:

list of names