com.vk.api.sdk.queries.ads

Class AdsGetCampaignsQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<AdsGetCampaignsQuery,java.util.List<GetCampaignsResponse>>

com.vk.api.sdk.queries.ads.AdsGetCampaignsQuery

public class AdsGetCampaignsQuery
extends AbstractQueryBuilder<AdsGetCampaignsQuery,java.util.List<GetCampaignsResponse>>

Query for Ads.getCampaigns method

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
AdsGetCampaignsQuery	accountId(java.lang.Integer value) Advertising account ID.
AdsGetCampaignsQuery	campaignIds(java.lang.String value) Filter of advertising campaigns to show.
AdsGetCampaignsQuery	clientId(java.lang.Integer value) 'For advertising agencies'.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
AdsGetCampaignsQuery	fields(java.util.List<java.lang.String> value) Set fields
AdsGetCampaignsQuery	fields(java.lang.String... value) fields Set fields
protected AdsGetCampaignsQuery	getThis() Get reference to this object
AdsGetCampaignsQuery	includeDeleted(java.lang.Boolean value) Flag that specifies whether archived ads shall be shown. *0 - show only active campaigns,, *1 - show all campaigns.

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

AdsGetCampaignsQuery

public AdsGetCampaignsQuery(VkApiClient client,
                            UserActor actor,
                            java.lang.Integer accountId)

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

accountId - value of "account id" parameter.

AdsGetCampaignsQuery

public AdsGetCampaignsQuery(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

accountId

public AdsGetCampaignsQuery accountId(java.lang.Integer value)

Advertising account ID.

Parameters:

value - value of "account id" parameter.

Returns:

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

clientId

public AdsGetCampaignsQuery clientId(java.lang.Integer value)

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

Parameters:

value - value of "client id" parameter.

Returns:

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

includeDeleted

public AdsGetCampaignsQuery includeDeleted(java.lang.Boolean value)

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

Parameters:

value - value of "include deleted" parameter.

Returns:

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

campaignIds

public AdsGetCampaignsQuery campaignIds(java.lang.String value)

Filter of advertising campaigns to show. Serialized JSON array with campaign IDs. Only campaigns that exist in 'campaign_ids' and belong to the specified advertising account will be shown. If the parameter is null, all campaigns will be shown.

Parameters:

value - value of "campaign ids" parameter.

Returns:

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

fields

public AdsGetCampaignsQuery fields(java.lang.String... value)

fields Set fields

Parameters:

value - value of "fields" parameter.

Returns:

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

fields

public AdsGetCampaignsQuery fields(java.util.List<java.lang.String> value)

Set fields

Parameters:

value - value of "fields" parameter.

Returns:

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

getThis

protected AdsGetCampaignsQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<AdsGetCampaignsQuery,java.util.List<GetCampaignsResponse>>

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<AdsGetCampaignsQuery,java.util.List<GetCampaignsResponse>>

Returns:

list of names