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

Class AdsGetAdsQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<AdsGetAdsQuery,java.util.List<GetAdsResponse>>

com.vk.api.sdk.queries.ads.AdsGetAdsQuery

public class AdsGetAdsQuery
extends AbstractQueryBuilder<AdsGetAdsQuery,java.util.List<GetAdsResponse>>

Query for Ads.getAds method

Constructor Summary

Constructors

Constructor	Description
AdsGetAdsQuery(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 AdsGetAdsQuery	accountId(int value)	Advertising account ID.
AdsGetAdsQuery	adIds(java.lang.String value)	Filter by ads.
AdsGetAdsQuery	campaignIds(java.lang.String value)	Filter by advertising campaigns.
AdsGetAdsQuery	clientId(java.lang.Integer value)	'Available and required 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 AdsGetAdsQuery	getThis()	Get reference to this object
AdsGetAdsQuery	includeDeleted(java.lang.Boolean value)	Flag that specifies whether archived ads shall be shown: *0 — show only active ads,, *1 — show all ads.
AdsGetAdsQuery	limit(java.lang.Integer value)	Limit of number of returned ads.
AdsGetAdsQuery	offset(java.lang.Integer value)	Offset.
AdsGetAdsQuery	onlyDeleted(java.lang.Boolean value)	Flag that specifies whether to show only archived ads: *0 — show all ads,, *1 — show only archived ads.

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

AdsGetAdsQuery

public AdsGetAdsQuery(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 AdsGetAdsQuery 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 AdsGetAdsQuery 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 AdsGetAdsQuery 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 AdsGetAdsQuery clientId(java.lang.Integer value)

'Available and required 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 AdsGetAdsQuery 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.

onlyDeleted

public AdsGetAdsQuery onlyDeleted(java.lang.Boolean value)

Flag that specifies whether to show only archived ads: *0 — show all ads,, *1 — show only archived ads. Available when include_deleted flag is *1

Parameters:

value - value of "only deleted" parameter.

Returns:

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

limit

public AdsGetAdsQuery 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 AdsGetAdsQuery offset(java.lang.Integer value)

Offset. Used in the same cases as 'limit' parameter.

Parameters:

value - value of "offset" parameter.

Returns:

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

getThis

protected AdsGetAdsQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<AdsGetAdsQuery,java.util.List<GetAdsResponse>>

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<AdsGetAdsQuery,java.util.List<GetAdsResponse>>

Returns:

list of names