com.vk.api.sdk.queries.ads

Class AdsGetAdsLayoutQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<AdsGetAdsLayoutQuery,java.util.List<GetAdsLayoutResponse>>

com.vk.api.sdk.queries.ads.AdsGetAdsLayoutQuery

public class AdsGetAdsLayoutQuery
extends AbstractQueryBuilder<AdsGetAdsLayoutQuery,java.util.List<GetAdsLayoutResponse>>

Query for Ads.getAdsLayout method

Constructor Summary

Constructors

Constructor and Description
AdsGetAdsLayoutQuery(VkApiClient client, UserActor actor) Creates a AbstractQueryBuilder instance that can be used to build user api request with various parameters
AdsGetAdsLayoutQuery(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
AdsGetAdsLayoutQuery	accountId(java.lang.Integer value) Advertising account ID.
AdsGetAdsLayoutQuery	adIds(java.lang.String value) Filter by ads.
AdsGetAdsLayoutQuery	campaignIds(java.lang.String value) Filter by advertising campaigns.
AdsGetAdsLayoutQuery	clientId(java.lang.Integer value) 'For advertising agencies.'
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
protected AdsGetAdsLayoutQuery	getThis() Get reference to this object
AdsGetAdsLayoutQuery	includeDeleted(java.lang.Boolean value) Flag that specifies whether archived ads shall be shown. *0 - show only active ads,, *1 - show all ads.
AdsGetAdsLayoutQuery	limit(java.lang.Integer value) Limit of number of returned ads.
AdsGetAdsLayoutQuery	offset(java.lang.Integer value) Offset.
AdsGetAdsLayoutQuery	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, 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

AdsGetAdsLayoutQuery

public AdsGetAdsLayoutQuery(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.

AdsGetAdsLayoutQuery

public AdsGetAdsLayoutQuery(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 AdsGetAdsLayoutQuery 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 AdsGetAdsLayoutQuery 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 AdsGetAdsLayoutQuery 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 AdsGetAdsLayoutQuery 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.

campaignIds

public AdsGetAdsLayoutQuery 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.

adIds

public AdsGetAdsLayoutQuery 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.

limit

public AdsGetAdsLayoutQuery 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 AdsGetAdsLayoutQuery 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 AdsGetAdsLayoutQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<AdsGetAdsLayoutQuery,java.util.List<GetAdsLayoutResponse>>

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<AdsGetAdsLayoutQuery,java.util.List<GetAdsLayoutResponse>>

Returns:

list of names