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

Class AdsCreateTargetGroupQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<AdsCreateTargetGroupQuery,CreateTargetGroupResponse>

com.vk.api.sdk.queries.ads.AdsCreateTargetGroupQuery

public class AdsCreateTargetGroupQuery
extends AbstractQueryBuilder<AdsCreateTargetGroupQuery,CreateTargetGroupResponse>

Query for Ads.createTargetGroup method

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected AdsCreateTargetGroupQuery	accountId(int value)	Advertising account ID.
AdsCreateTargetGroupQuery	clientId(java.lang.Integer value)	'Only for advertising agencies.', ID of the client with the advertising account where the group will be created.
protected java.util.List<java.lang.String>	essentialKeys()	Get list of required parameter names
protected AdsCreateTargetGroupQuery	getThis()	Get reference to this object
protected AdsCreateTargetGroupQuery	lifetime(int value)	'For groups with auditory created with pixel code only.', , Number of days after that users will be automatically removed from the group.
protected AdsCreateTargetGroupQuery	name(java.lang.String value)	Name of the target group — a string up to 64 characters long.
AdsCreateTargetGroupQuery	targetPixelId(java.lang.Integer value)	Set target pixel id
AdsCreateTargetGroupQuery	targetPixelRules(java.lang.String value)	Set target pixel rules

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

AdsCreateTargetGroupQuery

public AdsCreateTargetGroupQuery(VkApiClient client,
                                 UserActor actor,
                                 int accountId,
                                 java.lang.String name,
                                 int lifetime)

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.

name - value of "name" parameter.

lifetime - value of "lifetime" parameter. Maximum is 720. Minimum is 1.

Method Detail

accountId

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

clientId

public AdsCreateTargetGroupQuery clientId(java.lang.Integer value)

'Only for advertising agencies.', ID of the client with the advertising account where the group will be created.

Parameters:

value - value of "client id" parameter.

Returns:

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

name

protected AdsCreateTargetGroupQuery name(java.lang.String value)

Name of the target group — a string up to 64 characters long.

Parameters:

value - value of "name" parameter.

Returns:

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

lifetime

protected AdsCreateTargetGroupQuery lifetime(int value)

'For groups with auditory created with pixel code only.', , Number of days after that users will be automatically removed from the group.

Parameters:

value - value of "lifetime" parameter. Maximum is 720. Minimum is 1.

Returns:

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

targetPixelId

public AdsCreateTargetGroupQuery targetPixelId(java.lang.Integer value)

Set target pixel id

Parameters:

value - value of "target pixel id" parameter.

Returns:

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

targetPixelRules

public AdsCreateTargetGroupQuery targetPixelRules(java.lang.String value)

Set target pixel rules

Parameters:

value - value of "target pixel rules" parameter.

Returns:

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

getThis

protected AdsCreateTargetGroupQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<AdsCreateTargetGroupQuery,CreateTargetGroupResponse>

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<AdsCreateTargetGroupQuery,CreateTargetGroupResponse>

Returns:

list of names