com.vk.api.sdk.queries.ads

Class AdsUpdateTargetGroupQuery

java.lang.Object

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

com.vk.api.sdk.client.AbstractQueryBuilder<AdsUpdateTargetGroupQuery,OkResponse>

com.vk.api.sdk.queries.ads.AdsUpdateTargetGroupQuery

public class AdsUpdateTargetGroupQuery
extends AbstractQueryBuilder<AdsUpdateTargetGroupQuery,OkResponse>

Query for Ads.updateTargetGroup method

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
AdsUpdateTargetGroupQuery	accountId(java.lang.Integer value) Advertising account ID.
AdsUpdateTargetGroupQuery	clientId(java.lang.Integer value) 'Only for advertising agencies.' , ID of the client with the advertising account where the group will be created.
AdsUpdateTargetGroupQuery	domain(java.lang.String value) Domain of the site where user accounting code will be placed.
protected java.util.List<java.lang.String>	essentialKeys() Get list of required parameter names
protected AdsUpdateTargetGroupQuery	getThis() Get reference to this object
AdsUpdateTargetGroupQuery	lifetime(java.lang.Integer value) 'Only for the groups that get audience from sites with user accounting code
AdsUpdateTargetGroupQuery	name(java.lang.String value) New name of the target group - a string up to 64 characters long.
AdsUpdateTargetGroupQuery	targetGroupId(java.lang.Integer value) Group ID.
AdsUpdateTargetGroupQuery	targetPixelId(java.lang.Integer value) Set target pixel id
AdsUpdateTargetGroupQuery	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, 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

AdsUpdateTargetGroupQuery

public AdsUpdateTargetGroupQuery(VkApiClient client,
                                 UserActor actor,
                                 java.lang.Integer accountId,
                                 java.lang.Integer targetGroupId,
                                 java.lang.String name,
                                 java.lang.Integer lifetime)

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.

targetGroupId - value of "target group id" parameter.

name - value of "name" parameter.

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

AdsUpdateTargetGroupQuery

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

targetGroupId

public AdsUpdateTargetGroupQuery targetGroupId(java.lang.Integer value)

Group ID.

Parameters:

value - value of "target group id" parameter.

Returns:

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

name

public AdsUpdateTargetGroupQuery name(java.lang.String value)

New 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.

domain

public AdsUpdateTargetGroupQuery domain(java.lang.String value)

Domain of the site where user accounting code will be placed.

Parameters:

value - value of "domain" parameter.

Returns:

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

lifetime

public AdsUpdateTargetGroupQuery lifetime(java.lang.Integer value)

'Only for the groups that get audience from sites with user accounting code.', Time in days when users added to a retarget group will be automatically excluded from it. '0' - automatic exclusion is off.

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 AdsUpdateTargetGroupQuery 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 AdsUpdateTargetGroupQuery 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 AdsUpdateTargetGroupQuery getThis()

Description copied from class: AbstractQueryBuilder

Get reference to this object

Specified by:

getThis in class AbstractQueryBuilder<AdsUpdateTargetGroupQuery,OkResponse>

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<AdsUpdateTargetGroupQuery,OkResponse>

Returns:

list of names