com.vk.api.sdk.actions

Class Ads

java.lang.Object

com.vk.api.sdk.client.AbstractAction

com.vk.api.sdk.actions.Ads

public class Ads
extends AbstractAction

List of Ads methods

Constructor Summary

Constructors

Constructor and Description
Ads(VkApiClient client) Constructor

Method Summary

Modifier and Type	Method and Description
AdsAddOfficeUsersQuery	addOfficeUsers(UserActor actor) Adds managers and/or supervisors to advertising account.
AdsAddOfficeUsersQuery	addOfficeUsers(UserActor actor, java.lang.Integer accountId, java.util.List<UserSpecificationCutted> data) Adds managers and/or supervisors to advertising account.
AdsAddOfficeUsersQuery	addOfficeUsers(UserActor actor, java.lang.Integer accountId, UserSpecificationCutted... data) Adds managers and/or supervisors to advertising account.
AdsCheckLinkQuery	checkLink(UserActor actor) Allows to check the ad link.
AdsCheckLinkQuery	checkLink(UserActor actor, java.lang.Integer accountId, CheckLinkLinkType linkType, java.lang.String linkUrl) Allows to check the ad link.
AdsCreateAdsQuery	createAds(UserActor actor) Creates ads.
AdsCreateAdsQuery	createAds(UserActor actor, java.lang.Integer accountId, java.lang.String data) Creates ads.
AdsCreateCampaignsQuery	createCampaigns(UserActor actor) Creates advertising campaigns.
AdsCreateCampaignsQuery	createCampaigns(UserActor actor, java.lang.Integer accountId, java.lang.String data) Creates advertising campaigns.
AdsCreateClientsQuery	createClients(UserActor actor) Creates clients of an advertising agency.
AdsCreateClientsQuery	createClients(UserActor actor, java.lang.Integer accountId, java.lang.String data) Creates clients of an advertising agency.
AdsCreateLookalikeRequestQuery	createLookalikeRequest(UserActor actor)
AdsCreateLookalikeRequestQuery	createLookalikeRequest(UserActor actor, java.lang.Integer accountId, java.lang.String sourceType)
AdsCreateTargetGroupQuery	createTargetGroup(UserActor actor) Creates a group to re-target ads for users who visited advertiser's site (viewed information about the product, registered, etc.).
AdsCreateTargetGroupQuery	createTargetGroup(UserActor actor, java.lang.Integer accountId, java.lang.String name, java.lang.Integer lifetime) Creates a group to re-target ads for users who visited advertiser's site (viewed information about the product, registered, etc.).
AdsCreateTargetPixelQuery	createTargetPixel(UserActor actor)
AdsCreateTargetPixelQuery	createTargetPixel(UserActor actor, java.lang.Integer accountId, java.lang.String name, java.lang.Integer categoryId)
AdsDeleteAdsQuery	deleteAds(UserActor actor) Archives ads.
AdsDeleteAdsQuery	deleteAds(UserActor actor, java.lang.Integer accountId, java.lang.String ids) Archives ads.
AdsDeleteCampaignsQuery	deleteCampaigns(UserActor actor) Archives advertising campaigns.
AdsDeleteCampaignsQuery	deleteCampaigns(UserActor actor, java.lang.Integer accountId, java.lang.String ids) Archives advertising campaigns.
AdsDeleteClientsQuery	deleteClients(UserActor actor) Archives clients of an advertising agency.
AdsDeleteClientsQuery	deleteClients(UserActor actor, java.lang.Integer accountId, java.lang.String ids) Archives clients of an advertising agency.
AdsDeleteTargetGroupQuery	deleteTargetGroup(UserActor actor) Deletes a retarget group.
AdsDeleteTargetGroupQuery	deleteTargetGroup(UserActor actor, java.lang.Integer accountId, java.lang.Integer targetGroupId) Deletes a retarget group.
AdsDeleteTargetPixelQuery	deleteTargetPixel(UserActor actor)
AdsDeleteTargetPixelQuery	deleteTargetPixel(UserActor actor, java.lang.Integer accountId, java.lang.Integer targetPixelId)
AdsGetAccountsQuery	getAccounts(UserActor actor) Returns a list of advertising accounts.
AdsGetAdsQuery	getAds(UserActor actor) Returns number of ads.
AdsGetAdsQuery	getAds(UserActor actor, java.lang.Integer accountId) Returns number of ads.
AdsGetAdsLayoutQuery	getAdsLayout(UserActor actor) Returns descriptions of ad layouts.
AdsGetAdsLayoutQuery	getAdsLayout(UserActor actor, java.lang.Integer accountId) Returns descriptions of ad layouts.
AdsGetAdsTargetingQuery	getAdsTargeting(UserActor actor) Returns ad targeting parameters.
AdsGetAdsTargetingQuery	getAdsTargeting(UserActor actor, java.lang.Integer accountId) Returns ad targeting parameters.
AdsGetBudgetQuery	getBudget(UserActor actor) Returns current budget of the advertising account.
AdsGetBudgetQuery	getBudget(UserActor actor, java.lang.Integer accountId) Returns current budget of the advertising account.
AdsGetCampaignsQuery	getCampaigns(UserActor actor) Returns a list of campaigns in an advertising account.
AdsGetCampaignsQuery	getCampaigns(UserActor actor, java.lang.Integer accountId) Returns a list of campaigns in an advertising account.
AdsGetCategoriesQuery	getCategories(UserActor actor) Returns a list of possible ad categories.
AdsGetClientsQuery	getClients(UserActor actor) Returns a list of advertising agency's clients.
AdsGetClientsQuery	getClients(UserActor actor, java.lang.Integer accountId) Returns a list of advertising agency's clients.
AdsGetDemographicsQuery	getDemographics(UserActor actor) Returns demographics for ads or campaigns.
AdsGetDemographicsQuery	getDemographics(UserActor actor, java.lang.Integer accountId, GetDemographicsIdsType idsType, java.lang.String ids, GetDemographicsPeriod period, java.lang.String dateFrom, java.lang.String dateTo) Returns demographics for ads or campaigns.
AdsGetFloodStatsQuery	getFloodStats(UserActor actor) Returns information about current state of a counter - number of remaining runs of methods and time to the next counter nulling in seconds.
AdsGetFloodStatsQuery	getFloodStats(UserActor actor, java.lang.Integer accountId) Returns information about current state of a counter - number of remaining runs of methods and time to the next counter nulling in seconds.
AdsGetLookalikeRequestsQuery	getLookalikeRequests(UserActor actor)
AdsGetLookalikeRequestsQuery	getLookalikeRequests(UserActor actor, java.lang.Integer accountId)
AdsGetMusiciansQuery	getMusicians(UserActor actor)
AdsGetMusiciansQuery	getMusicians(UserActor actor, java.lang.String artistName)
AdsGetMusiciansByIdsQuery	getMusiciansByIds(UserActor actor)
AdsGetMusiciansByIdsQuery	getMusiciansByIds(UserActor actor, java.util.List<java.lang.Long> ids)
AdsGetMusiciansByIdsQuery	getMusiciansByIds(UserActor actor, java.lang.Long... ids)
AdsGetOfficeUsersQuery	getOfficeUsers(UserActor actor) Returns a list of managers and supervisors of advertising account.
AdsGetOfficeUsersQuery	getOfficeUsers(UserActor actor, java.lang.Integer accountId) Returns a list of managers and supervisors of advertising account.
AdsGetPostsReachQuery	getPostsReach(UserActor actor) Returns detailed statistics of promoted posts reach from campaigns and ads.
AdsGetPostsReachQuery	getPostsReach(UserActor actor, java.lang.Integer accountId, GetPostsReachIdsType idsType, java.lang.String ids) Returns detailed statistics of promoted posts reach from campaigns and ads.
AdsGetRejectionReasonQuery	getRejectionReason(UserActor actor) Returns a reason of ad rejection for pre-moderation.
AdsGetRejectionReasonQuery	getRejectionReason(UserActor actor, java.lang.Integer accountId, java.lang.Integer adId) Returns a reason of ad rejection for pre-moderation.
AdsGetStatisticsQuery	getStatistics(UserActor actor) Returns statistics of performance indicators for ads, campaigns, clients or the whole account.
AdsGetStatisticsQuery	getStatistics(UserActor actor, java.lang.Integer accountId, GetStatisticsIdsType idsType, java.lang.String ids, GetStatisticsPeriod period, java.lang.String dateFrom, java.lang.String dateTo) Returns statistics of performance indicators for ads, campaigns, clients or the whole account.
AdsGetSuggestionsQuery	getSuggestions(UserActor actor) Returns a set of auto-suggestions for various targeting parameters.
AdsGetSuggestionsQuery	getSuggestions(UserActor actor, GetSuggestionsSection section) Returns a set of auto-suggestions for various targeting parameters.
AdsGetSuggestionsQueryWithRegions	getSuggestionsRegions(UserActor actor, GetSuggestionsSection section) Returns a set of auto-suggestions for various targeting parameters.
AdsGetSuggestionsQueryWithSchools	getSuggestionsSchools(UserActor actor, GetSuggestionsSection section) Returns a set of auto-suggestions for various targeting parameters.
AdsGetSuggestionsQueryWithCities	getSuggestionsWithCities(UserActor actor, GetSuggestionsSection section, java.lang.String cities) Returns a set of auto-suggestions for various targeting parameters.
AdsGetTargetGroupsQuery	getTargetGroups(UserActor actor) Returns a list of target groups.
AdsGetTargetGroupsQuery	getTargetGroups(UserActor actor, java.lang.Integer accountId) Returns a list of target groups.
AdsGetTargetingStatsQuery	getTargetingStats(UserActor actor) Returns the size of targeting audience, and also recommended values for CPC and CPM.
AdsGetTargetingStatsQuery	getTargetingStats(UserActor actor, java.lang.Integer accountId, java.lang.String linkUrl) Returns the size of targeting audience, and also recommended values for CPC and CPM.
AdsGetTargetPixelsQuery	getTargetPixels(UserActor actor)
AdsGetTargetPixelsQuery	getTargetPixels(UserActor actor, java.lang.Integer accountId)
AdsGetUploadURLQuery	getUploadURL(UserActor actor) Returns URL to upload an ad photo to.
AdsGetUploadURLQuery	getUploadURL(UserActor actor, GetUploadURLAdFormat adFormat) Returns URL to upload an ad photo to.
AdsGetVideoUploadURLQuery	getVideoUploadURL(UserActor actor) Returns URL to upload an ad video to.
AdsImportTargetContactsQuery	importTargetContacts(UserActor actor) Imports a list of advertiser's contacts to count VK registered users against the target group.
AdsImportTargetContactsQuery	importTargetContacts(UserActor actor, java.lang.Integer accountId, java.lang.Integer targetGroupId, java.lang.String contacts) Imports a list of advertiser's contacts to count VK registered users against the target group.
AdsRemoveOfficeUsersQuery	removeOfficeUsers(UserActor actor) Removes managers and/or supervisors from advertising account.
AdsRemoveOfficeUsersQuery	removeOfficeUsers(UserActor actor, java.lang.Integer accountId, java.lang.String ids) Removes managers and/or supervisors from advertising account.
AdsRemoveTargetContactsQuery	removeTargetContacts(UserActor actor)
AdsRemoveTargetContactsQuery	removeTargetContacts(UserActor actor, java.lang.Integer accountId, java.lang.Integer targetGroupId, java.lang.String contacts)
AdsSaveLookalikeRequestResultQuery	saveLookalikeRequestResult(UserActor actor)
AdsSaveLookalikeRequestResultQuery	saveLookalikeRequestResult(UserActor actor, java.lang.Integer accountId, java.lang.Integer requestId, java.lang.Integer level)
AdsShareTargetGroupQuery	shareTargetGroup(UserActor actor)
AdsShareTargetGroupQuery	shareTargetGroup(UserActor actor, java.lang.Integer accountId, java.lang.Integer targetGroupId)
AdsUpdateAdsQuery	updateAds(UserActor actor) Edits ads.
AdsUpdateAdsQuery	updateAds(UserActor actor, java.lang.Integer accountId, java.lang.String data) Edits ads.
AdsUpdateCampaignsQuery	updateCampaigns(UserActor actor) Edits advertising campaigns.
AdsUpdateCampaignsQuery	updateCampaigns(UserActor actor, java.lang.Integer accountId, java.lang.String data) Edits advertising campaigns.
AdsUpdateClientsQuery	updateClients(UserActor actor) Edits clients of an advertising agency.
AdsUpdateClientsQuery	updateClients(UserActor actor, java.lang.Integer accountId, java.lang.String data) Edits clients of an advertising agency.
AdsUpdateOfficeUsersQuery	updateOfficeUsers(UserActor actor) Adds managers and/or supervisors to advertising account.
AdsUpdateOfficeUsersQuery	updateOfficeUsers(UserActor actor, java.lang.Integer accountId, java.util.List<UserSpecification> data) Adds managers and/or supervisors to advertising account.
AdsUpdateOfficeUsersQuery	updateOfficeUsers(UserActor actor, java.lang.Integer accountId, UserSpecification... data) Adds managers and/or supervisors to advertising account.
AdsUpdateTargetGroupQuery	updateTargetGroup(UserActor actor) Edits a retarget group.
AdsUpdateTargetGroupQuery	updateTargetGroup(UserActor actor, java.lang.Integer accountId, java.lang.Integer targetGroupId, java.lang.String name, java.lang.Integer lifetime) Edits a retarget group.
AdsUpdateTargetPixelQuery	updateTargetPixel(UserActor actor)
AdsUpdateTargetPixelQuery	updateTargetPixel(UserActor actor, java.lang.Integer accountId, java.lang.Integer targetPixelId, java.lang.String name, java.lang.Integer categoryId)

Methods inherited from class com.vk.api.sdk.client.AbstractAction

getClient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Ads

public Ads(VkApiClient client)

Constructor

Parameters:

client - vk api client

Method Detail

addOfficeUsers

public AdsAddOfficeUsersQuery addOfficeUsers(UserActor actor,
                                             java.lang.Integer accountId,
                                             UserSpecificationCutted... data)

Adds managers and/or supervisors to advertising account.

Parameters:

actor - vk user actor

accountId - Advertising account ID.

data - Serialized JSON array of objects that describe added managers. Description of 'user_specification' objects see below.

Returns:

query

addOfficeUsers

public AdsAddOfficeUsersQuery addOfficeUsers(UserActor actor,
                                             java.lang.Integer accountId,
                                             java.util.List<UserSpecificationCutted> data)

Adds managers and/or supervisors to advertising account.

Parameters:

actor - vk user actor

accountId - Advertising account ID.

data - Serialized JSON array of objects that describe added managers. Description of 'user_specification' objects see below.

Returns:

query

addOfficeUsers

public AdsAddOfficeUsersQuery addOfficeUsers(UserActor actor)

Adds managers and/or supervisors to advertising account.

Parameters:

actor - vk user actor

Returns:

only actor query

checkLink

public AdsCheckLinkQuery checkLink(UserActor actor,
                                   java.lang.Integer accountId,
                                   CheckLinkLinkType linkType,
                                   java.lang.String linkUrl)

Allows to check the ad link.

Parameters:

actor - vk user actor

accountId - Advertising account ID.

linkType - Object type: *'community' - community,, *'post' - community post,, *'application' - VK application,, *'video' - video,, *'site' - external site.

linkUrl - Object URL.

Returns:

query

checkLink

public AdsCheckLinkQuery checkLink(UserActor actor)

Allows to check the ad link.

Parameters:

actor - vk user actor

Returns:

only actor query

createAds

public AdsCreateAdsQuery createAds(UserActor actor,
                                   java.lang.Integer accountId,
                                   java.lang.String data)

Creates ads.

Parameters:

actor - vk user actor

accountId - Advertising account ID.

data - Serialized JSON array of objects that describe created ads. Description of 'ad_specification' objects see below.

Returns:

query

createAds

public AdsCreateAdsQuery createAds(UserActor actor)

Creates ads.

Parameters:

actor - vk user actor

Returns:

only actor query

createCampaigns

public AdsCreateCampaignsQuery createCampaigns(UserActor actor,
                                               java.lang.Integer accountId,
                                               java.lang.String data)

Creates advertising campaigns.

Parameters:

actor - vk user actor

accountId - Advertising account ID.

data - Serialized JSON array of objects that describe created campaigns. Description of 'campaign_specification' objects see below.

Returns:

query

createCampaigns

public AdsCreateCampaignsQuery createCampaigns(UserActor actor)

Creates advertising campaigns.

Parameters:

actor - vk user actor

Returns:

only actor query

createClients

public AdsCreateClientsQuery createClients(UserActor actor,
                                           java.lang.Integer accountId,
                                           java.lang.String data)

Creates clients of an advertising agency.

Parameters:

actor - vk user actor

accountId - Advertising account ID.

data - Serialized JSON array of objects that describe created campaigns. Description of 'client_specification' objects see below.

Returns:

query

createClients

public AdsCreateClientsQuery createClients(UserActor actor)

Creates clients of an advertising agency.

Parameters:

actor - vk user actor

Returns:

only actor query

createLookalikeRequest

public AdsCreateLookalikeRequestQuery createLookalikeRequest(UserActor actor,
                                                             java.lang.Integer accountId,
                                                             java.lang.String sourceType)

Parameters:

actor - vk user actor

accountId -

sourceType -

Returns:

query

createLookalikeRequest

public AdsCreateLookalikeRequestQuery createLookalikeRequest(UserActor actor)

Parameters:

actor - vk user actor

Returns:

only actor query

createTargetGroup

public AdsCreateTargetGroupQuery createTargetGroup(UserActor actor,
                                                   java.lang.Integer accountId,
                                                   java.lang.String name,
                                                   java.lang.Integer lifetime)

Creates a group to re-target ads for users who visited advertiser's site (viewed information about the product, registered, etc.).

Parameters:

actor - vk user actor

accountId - Advertising account ID.

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

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

Returns:

query

createTargetGroup

public AdsCreateTargetGroupQuery createTargetGroup(UserActor actor)

Creates a group to re-target ads for users who visited advertiser's site (viewed information about the product, registered, etc.).

Parameters:

actor - vk user actor

Returns:

only actor query

createTargetPixel

public AdsCreateTargetPixelQuery createTargetPixel(UserActor actor,
                                                   java.lang.Integer accountId,
                                                   java.lang.String name,
                                                   java.lang.Integer categoryId)

Parameters:

actor - vk user actor

accountId -

name -

categoryId -

Returns:

query

createTargetPixel

public AdsCreateTargetPixelQuery createTargetPixel(UserActor actor)

Parameters:

actor - vk user actor

Returns:

only actor query

deleteAds

public AdsDeleteAdsQuery deleteAds(UserActor actor,
                                   java.lang.Integer accountId,
                                   java.lang.String ids)

Archives ads.

Parameters:

actor - vk user actor

accountId - Advertising account ID.

ids - Serialized JSON array with ad IDs.

Returns:

query

deleteAds

public AdsDeleteAdsQuery deleteAds(UserActor actor)

Archives ads.

Parameters:

actor - vk user actor

Returns:

only actor query

deleteCampaigns

public AdsDeleteCampaignsQuery deleteCampaigns(UserActor actor,
                                               java.lang.Integer accountId,
                                               java.lang.String ids)

Archives advertising campaigns.

Parameters:

actor - vk user actor

accountId - Advertising account ID.

ids - Serialized JSON array with IDs of deleted campaigns.

Returns:

query

deleteCampaigns

public AdsDeleteCampaignsQuery deleteCampaigns(UserActor actor)

Archives advertising campaigns.

Parameters:

actor - vk user actor

Returns:

only actor query

deleteClients

public AdsDeleteClientsQuery deleteClients(UserActor actor,
                                           java.lang.Integer accountId,
                                           java.lang.String ids)

Archives clients of an advertising agency.

Parameters:

actor - vk user actor

accountId - Advertising account ID.

ids - Serialized JSON array with IDs of deleted clients.

Returns:

query

deleteClients

public AdsDeleteClientsQuery deleteClients(UserActor actor)

Archives clients of an advertising agency.

Parameters:

actor - vk user actor

Returns:

only actor query

deleteTargetGroup

public AdsDeleteTargetGroupQuery deleteTargetGroup(UserActor actor,
                                                   java.lang.Integer accountId,
                                                   java.lang.Integer targetGroupId)

Deletes a retarget group.

Parameters:

actor - vk user actor

accountId - Advertising account ID.

targetGroupId - Group ID.

Returns:

query

deleteTargetGroup

public AdsDeleteTargetGroupQuery deleteTargetGroup(UserActor actor)

Deletes a retarget group.

Parameters:

actor - vk user actor

Returns:

only actor query

deleteTargetPixel

public AdsDeleteTargetPixelQuery deleteTargetPixel(UserActor actor,
                                                   java.lang.Integer accountId,
                                                   java.lang.Integer targetPixelId)

Parameters:

actor - vk user actor

accountId -

targetPixelId -

Returns:

query

deleteTargetPixel

public AdsDeleteTargetPixelQuery deleteTargetPixel(UserActor actor)

Parameters:

actor - vk user actor

Returns:

only actor query

getAccounts

public AdsGetAccountsQuery getAccounts(UserActor actor)

Returns a list of advertising accounts.

Parameters:

actor - vk user actor

Returns:

query

getAds

public AdsGetAdsQuery getAds(UserActor actor,
                             java.lang.Integer accountId)

Returns number of ads.

Parameters:

actor - vk user actor

accountId - Advertising account ID.

Returns:

query

getAds

public AdsGetAdsQuery getAds(UserActor actor)

Returns number of ads.

Parameters:

actor - vk user actor

Returns:

only actor query

getAdsLayout

public AdsGetAdsLayoutQuery getAdsLayout(UserActor actor,
                                         java.lang.Integer accountId)

Returns descriptions of ad layouts.

Parameters:

actor - vk user actor

accountId - Advertising account ID.

Returns:

query

getAdsLayout

public AdsGetAdsLayoutQuery getAdsLayout(UserActor actor)

Returns descriptions of ad layouts.

Parameters:

actor - vk user actor

Returns:

only actor query

getAdsTargeting

public AdsGetAdsTargetingQuery getAdsTargeting(UserActor actor,
                                               java.lang.Integer accountId)

Returns ad targeting parameters.

Parameters:

actor - vk user actor

accountId - Advertising account ID.

Returns:

query

getAdsTargeting

public AdsGetAdsTargetingQuery getAdsTargeting(UserActor actor)

Returns ad targeting parameters.

Parameters:

actor - vk user actor

Returns:

only actor query

getBudget

public AdsGetBudgetQuery getBudget(UserActor actor,
                                   java.lang.Integer accountId)

Returns current budget of the advertising account.

Parameters:

actor - vk user actor

accountId - Advertising account ID.

Returns:

query

getBudget

public AdsGetBudgetQuery getBudget(UserActor actor)

Returns current budget of the advertising account.

Parameters:

actor - vk user actor

Returns:

only actor query

getCampaigns

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

Returns a list of campaigns in an advertising account.

Parameters:

actor - vk user actor

accountId - Advertising account ID.

Returns:

query

getCampaigns

public AdsGetCampaignsQuery getCampaigns(UserActor actor)

Returns a list of campaigns in an advertising account.

Parameters:

actor - vk user actor

Returns:

only actor query

getCategories

public AdsGetCategoriesQuery getCategories(UserActor actor)

Returns a list of possible ad categories.

Parameters:

actor - vk user actor

Returns:

query

getClients

public AdsGetClientsQuery getClients(UserActor actor,
                                     java.lang.Integer accountId)

Returns a list of advertising agency's clients.

Parameters:

actor - vk user actor

accountId - Advertising account ID.

Returns:

query

getClients

public AdsGetClientsQuery getClients(UserActor actor)

Returns a list of advertising agency's clients.

Parameters:

actor - vk user actor

Returns:

only actor query

getDemographics

public AdsGetDemographicsQuery getDemographics(UserActor actor,
                                               java.lang.Integer accountId,
                                               GetDemographicsIdsType idsType,
                                               java.lang.String ids,
                                               GetDemographicsPeriod period,
                                               java.lang.String dateFrom,
                                               java.lang.String dateTo)

Returns demographics for ads or campaigns.

Parameters:

actor - vk user actor

accountId - Advertising account ID.

idsType - Type of requested objects listed in 'ids' parameter: *ad - ads,, *campaign - campaigns.

ids - IDs requested ads or campaigns, separated with a comma, depending on the value set in 'ids_type'. Maximum 2000 objects.

period - Data grouping by dates: *day - statistics by days,, *month - statistics by months,, *overall - overall statistics. 'date_from' and 'date_to' parameters set temporary limits.

dateFrom - Date to show statistics from. For different value of 'period' different date format is used: *day: YYYY-MM-DD, example: 2011-09-27 - September 27, 2011, **0 - day it was created on,, *month: YYYY-MM, example: 2011-09 - September 2011, **0 - month it was created in,, *overall: 0.

dateTo - Date to show statistics to. For different value of 'period' different date format is used: *day: YYYY-MM-DD, example: 2011-09-27 - September 27, 2011, **0 - current day,, *month: YYYY-MM, example: 2011-09 - September 2011, **0 - current month,, *overall: 0.

Returns:

query

getDemographics

public AdsGetDemographicsQuery getDemographics(UserActor actor)

Returns demographics for ads or campaigns.

Parameters:

actor - vk user actor

Returns:

only actor query

getFloodStats

public AdsGetFloodStatsQuery getFloodStats(UserActor actor,
                                           java.lang.Integer accountId)

Returns information about current state of a counter - number of remaining runs of methods and time to the next counter nulling in seconds.

Parameters:

actor - vk user actor

accountId - Advertising account ID.

Returns:

query

getFloodStats

public AdsGetFloodStatsQuery getFloodStats(UserActor actor)

Returns information about current state of a counter - number of remaining runs of methods and time to the next counter nulling in seconds.

Parameters:

actor - vk user actor

Returns:

only actor query

getLookalikeRequests

public AdsGetLookalikeRequestsQuery getLookalikeRequests(UserActor actor,
                                                         java.lang.Integer accountId)

Parameters:

actor - vk user actor

accountId -

Returns:

query

getLookalikeRequests

public AdsGetLookalikeRequestsQuery getLookalikeRequests(UserActor actor)

Parameters:

actor - vk user actor

Returns:

only actor query

getMusicians

public AdsGetMusiciansQuery getMusicians(UserActor actor,
                                         java.lang.String artistName)

Parameters:

actor - vk user actor

artistName -

Returns:

query

getMusicians

public AdsGetMusiciansQuery getMusicians(UserActor actor)

Parameters:

actor - vk user actor

Returns:

only actor query

getMusiciansByIds

public AdsGetMusiciansByIdsQuery getMusiciansByIds(UserActor actor,
                                                   java.lang.Long... ids)

Parameters:

actor - vk user actor

ids -

Returns:

query

getMusiciansByIds

public AdsGetMusiciansByIdsQuery getMusiciansByIds(UserActor actor,
                                                   java.util.List<java.lang.Long> ids)

Parameters:

actor - vk user actor

ids -

Returns:

query

getMusiciansByIds

public AdsGetMusiciansByIdsQuery getMusiciansByIds(UserActor actor)

Parameters:

actor - vk user actor

Returns:

only actor query

getOfficeUsers

public AdsGetOfficeUsersQuery getOfficeUsers(UserActor actor,
                                             java.lang.Integer accountId)

Returns a list of managers and supervisors of advertising account.

Parameters:

actor - vk user actor

accountId - Advertising account ID.

Returns:

query

getOfficeUsers

public AdsGetOfficeUsersQuery getOfficeUsers(UserActor actor)

Returns a list of managers and supervisors of advertising account.

Parameters:

actor - vk user actor

Returns:

only actor query

getPostsReach

public AdsGetPostsReachQuery getPostsReach(UserActor actor,
                                           java.lang.Integer accountId,
                                           GetPostsReachIdsType idsType,
                                           java.lang.String ids)

Returns detailed statistics of promoted posts reach from campaigns and ads.

Parameters:

actor - vk user actor

accountId - Advertising account ID.

idsType - Type of requested objects listed in 'ids' parameter: *ad - ads,, *campaign - campaigns.

ids - IDs requested ads or campaigns, separated with a comma, depending on the value set in 'ids_type'. Maximum 100 objects.

Returns:

query

getPostsReach

public AdsGetPostsReachQuery getPostsReach(UserActor actor)

Returns detailed statistics of promoted posts reach from campaigns and ads.

Parameters:

actor - vk user actor

Returns:

only actor query

getRejectionReason

public AdsGetRejectionReasonQuery getRejectionReason(UserActor actor,
                                                     java.lang.Integer accountId,
                                                     java.lang.Integer adId)

Returns a reason of ad rejection for pre-moderation.

Parameters:

actor - vk user actor

accountId - Advertising account ID.

adId - Ad ID.

Returns:

query

getRejectionReason

public AdsGetRejectionReasonQuery getRejectionReason(UserActor actor)

Returns a reason of ad rejection for pre-moderation.

Parameters:

actor - vk user actor

Returns:

only actor query

getStatistics

public AdsGetStatisticsQuery getStatistics(UserActor actor,
                                           java.lang.Integer accountId,
                                           GetStatisticsIdsType idsType,
                                           java.lang.String ids,
                                           GetStatisticsPeriod period,
                                           java.lang.String dateFrom,
                                           java.lang.String dateTo)

Returns statistics of performance indicators for ads, campaigns, clients or the whole account.

Parameters:

actor - vk user actor

accountId - Advertising account ID.

idsType - Type of requested objects listed in 'ids' parameter: *ad - ads,, *campaign - campaigns,, *client - clients,, *office - account.

ids - IDs requested ads, campaigns, clients or account, separated with a comma, depending on the value set in 'ids_type'. Maximum 2000 objects.

period - Data grouping by dates: *day - statistics by days,, *month - statistics by months,, *overall - overall statistics. 'date_from' and 'date_to' parameters set temporary limits.

dateFrom - Date to show statistics from. For different value of 'period' different date format is used: *day: YYYY-MM-DD, example: 2011-09-27 - September 27, 2011, **0 - day it was created on,, *month: YYYY-MM, example: 2011-09 - September 2011, **0 - month it was created in,, *overall: 0.

dateTo - Date to show statistics to. For different value of 'period' different date format is used: *day: YYYY-MM-DD, example: 2011-09-27 - September 27, 2011, **0 - current day,, *month: YYYY-MM, example: 2011-09 - September 2011, **0 - current month,, *overall: 0.

Returns:

query

getStatistics

public AdsGetStatisticsQuery getStatistics(UserActor actor)

Returns statistics of performance indicators for ads, campaigns, clients or the whole account.

Parameters:

actor - vk user actor

Returns:

only actor query

getSuggestions

public AdsGetSuggestionsQuery getSuggestions(UserActor actor,
                                             GetSuggestionsSection section)

Returns a set of auto-suggestions for various targeting parameters.

Parameters:

actor - vk user actor

section - Section, suggestions are retrieved in. Available values: *countries - request of a list of countries. If q is not set or blank, a short list of countries is shown. Otherwise, a full list of countries is shown. *regions - requested list of regions. 'country' parameter is required. *cities - requested list of cities. 'country' parameter is required. *districts - requested list of districts. 'cities' parameter is required. *stations - requested list of subway stations. 'cities' parameter is required. *streets - requested list of streets. 'cities' parameter is required. *schools - requested list of educational organizations. 'cities' parameter is required. *interests - requested list of interests. *positions - requested list of positions (professions). *group_types - requested list of group types. *religions - requested list of religious commitments. *browsers - requested list of browsers and mobile devices.

Returns:

query

getSuggestions

public AdsGetSuggestionsQuery getSuggestions(UserActor actor)

Returns a set of auto-suggestions for various targeting parameters.

Parameters:

actor - vk user actor

Returns:

only actor query

getSuggestionsRegions

public AdsGetSuggestionsQueryWithRegions getSuggestionsRegions(UserActor actor,
                                                               GetSuggestionsSection section)

Returns a set of auto-suggestions for various targeting parameters.

Parameters:

actor - vk user actor

section - Section, suggestions are retrieved in. Available values: *countries - request of a list of countries. If q is not set or blank, a short list of countries is shown. Otherwise, a full list of countries is shown. *regions - requested list of regions. 'country' parameter is required. *cities - requested list of cities. 'country' parameter is required. *districts - requested list of districts. 'cities' parameter is required. *stations - requested list of subway stations. 'cities' parameter is required. *streets - requested list of streets. 'cities' parameter is required. *schools - requested list of educational organizations. 'cities' parameter is required. *interests - requested list of interests. *positions - requested list of positions (professions). *group_types - requested list of group types. *religions - requested list of religious commitments. *browsers - requested list of browsers and mobile devices.

Returns:

query

getSuggestionsSchools

public AdsGetSuggestionsQueryWithSchools getSuggestionsSchools(UserActor actor,
                                                               GetSuggestionsSection section)

Returns a set of auto-suggestions for various targeting parameters.

Parameters:

actor - vk user actor

section - Section, suggestions are retrieved in. Available values: *countries - request of a list of countries. If q is not set or blank, a short list of countries is shown. Otherwise, a full list of countries is shown. *regions - requested list of regions. 'country' parameter is required. *cities - requested list of cities. 'country' parameter is required. *districts - requested list of districts. 'cities' parameter is required. *stations - requested list of subway stations. 'cities' parameter is required. *streets - requested list of streets. 'cities' parameter is required. *schools - requested list of educational organizations. 'cities' parameter is required. *interests - requested list of interests. *positions - requested list of positions (professions). *group_types - requested list of group types. *religions - requested list of religious commitments. *browsers - requested list of browsers and mobile devices.

Returns:

query

getSuggestionsWithCities

public AdsGetSuggestionsQueryWithCities getSuggestionsWithCities(UserActor actor,
                                                                 GetSuggestionsSection section,
                                                                 java.lang.String cities)

Returns a set of auto-suggestions for various targeting parameters.

Parameters:

actor - vk user actor

section - Section, suggestions are retrieved in. Available values: *countries - request of a list of countries. If q is not set or blank, a short list of countries is shown. Otherwise, a full list of countries is shown. *regions - requested list of regions. 'country' parameter is required. *cities - requested list of cities. 'country' parameter is required. *districts - requested list of districts. 'cities' parameter is required. *stations - requested list of subway stations. 'cities' parameter is required. *streets - requested list of streets. 'cities' parameter is required. *schools - requested list of educational organizations. 'cities' parameter is required. *interests - requested list of interests. *positions - requested list of positions (professions). *group_types - requested list of group types. *religions - requested list of religious commitments. *browsers - requested list of browsers and mobile devices.

cities - IDs of cities where objects are searched in, separated with a comma.

Returns:

query

getTargetGroups

public AdsGetTargetGroupsQuery getTargetGroups(UserActor actor,
                                               java.lang.Integer accountId)

Returns a list of target groups.

Parameters:

actor - vk user actor

accountId - Advertising account ID.

Returns:

query

getTargetGroups

public AdsGetTargetGroupsQuery getTargetGroups(UserActor actor)

Returns a list of target groups.

Parameters:

actor - vk user actor

Returns:

only actor query

getTargetPixels

public AdsGetTargetPixelsQuery getTargetPixels(UserActor actor,
                                               java.lang.Integer accountId)

Parameters:

actor - vk user actor

accountId -

Returns:

query

getTargetPixels

public AdsGetTargetPixelsQuery getTargetPixels(UserActor actor)

Parameters:

actor - vk user actor

Returns:

only actor query

getTargetingStats

public AdsGetTargetingStatsQuery getTargetingStats(UserActor actor,
                                                   java.lang.Integer accountId,
                                                   java.lang.String linkUrl)

Returns the size of targeting audience, and also recommended values for CPC and CPM.

Parameters:

actor - vk user actor

accountId - Advertising account ID.

linkUrl - URL for the advertised object.

Returns:

query

getTargetingStats

public AdsGetTargetingStatsQuery getTargetingStats(UserActor actor)

Returns the size of targeting audience, and also recommended values for CPC and CPM.

Parameters:

actor - vk user actor

Returns:

only actor query

getUploadURL

public AdsGetUploadURLQuery getUploadURL(UserActor actor,
                                         GetUploadURLAdFormat adFormat)

Returns URL to upload an ad photo to.

Parameters:

actor - vk user actor

adFormat - Ad format: *1 - image and text,, *2 - big image,, *3 - exclusive format,, *4 - community, square image,, *7 - special app format.

Returns:

query

getUploadURL

public AdsGetUploadURLQuery getUploadURL(UserActor actor)

Returns URL to upload an ad photo to.

Parameters:

actor - vk user actor

Returns:

only actor query

getVideoUploadURL

public AdsGetVideoUploadURLQuery getVideoUploadURL(UserActor actor)

Returns URL to upload an ad video to.

Parameters:

actor - vk user actor

Returns:

query

importTargetContacts

public AdsImportTargetContactsQuery importTargetContacts(UserActor actor,
                                                         java.lang.Integer accountId,
                                                         java.lang.Integer targetGroupId,
                                                         java.lang.String contacts)

Imports a list of advertiser's contacts to count VK registered users against the target group.

Parameters:

actor - vk user actor

accountId - Advertising account ID.

targetGroupId - Target group ID.

contacts - List of phone numbers, emails or user IDs separated with a comma.

Returns:

query

importTargetContacts

public AdsImportTargetContactsQuery importTargetContacts(UserActor actor)

Imports a list of advertiser's contacts to count VK registered users against the target group.

Parameters:

actor - vk user actor

Returns:

only actor query

removeOfficeUsers

public AdsRemoveOfficeUsersQuery removeOfficeUsers(UserActor actor,
                                                   java.lang.Integer accountId,
                                                   java.lang.String ids)

Removes managers and/or supervisors from advertising account.

Parameters:

actor - vk user actor

accountId - Advertising account ID.

ids - Serialized JSON array with IDs of deleted managers.

Returns:

query

removeOfficeUsers

public AdsRemoveOfficeUsersQuery removeOfficeUsers(UserActor actor)

Removes managers and/or supervisors from advertising account.

Parameters:

actor - vk user actor

Returns:

only actor query

removeTargetContacts

public AdsRemoveTargetContactsQuery removeTargetContacts(UserActor actor,
                                                         java.lang.Integer accountId,
                                                         java.lang.Integer targetGroupId,
                                                         java.lang.String contacts)

Parameters:

actor - vk user actor

accountId -

targetGroupId -

contacts -

Returns:

query

removeTargetContacts

public AdsRemoveTargetContactsQuery removeTargetContacts(UserActor actor)

Parameters:

actor - vk user actor

Returns:

only actor query

saveLookalikeRequestResult

public AdsSaveLookalikeRequestResultQuery saveLookalikeRequestResult(UserActor actor,
                                                                     java.lang.Integer accountId,
                                                                     java.lang.Integer requestId,
                                                                     java.lang.Integer level)

Parameters:

actor - vk user actor

accountId -

requestId -

level -

Returns:

query

saveLookalikeRequestResult

public AdsSaveLookalikeRequestResultQuery saveLookalikeRequestResult(UserActor actor)

Parameters:

actor - vk user actor

Returns:

only actor query

shareTargetGroup

public AdsShareTargetGroupQuery shareTargetGroup(UserActor actor,
                                                 java.lang.Integer accountId,
                                                 java.lang.Integer targetGroupId)

Parameters:

actor - vk user actor

accountId -

targetGroupId -

Returns:

query

shareTargetGroup

public AdsShareTargetGroupQuery shareTargetGroup(UserActor actor)

Parameters:

actor - vk user actor

Returns:

only actor query

updateAds

public AdsUpdateAdsQuery updateAds(UserActor actor,
                                   java.lang.Integer accountId,
                                   java.lang.String data)

Edits ads.

Parameters:

actor - vk user actor

accountId - Advertising account ID.

data - Serialized JSON array of objects that describe changes in ads. Description of 'ad_edit_specification' objects see below.

Returns:

query

updateAds

public AdsUpdateAdsQuery updateAds(UserActor actor)

Edits ads.

Parameters:

actor - vk user actor

Returns:

only actor query

updateCampaigns

public AdsUpdateCampaignsQuery updateCampaigns(UserActor actor,
                                               java.lang.Integer accountId,
                                               java.lang.String data)

Edits advertising campaigns.

Parameters:

actor - vk user actor

accountId - Advertising account ID.

data - Serialized JSON array of objects that describe changes in campaigns. Description of 'campaign_mod' objects see below.

Returns:

query

updateCampaigns

public AdsUpdateCampaignsQuery updateCampaigns(UserActor actor)

Edits advertising campaigns.

Parameters:

actor - vk user actor

Returns:

only actor query

updateClients

public AdsUpdateClientsQuery updateClients(UserActor actor,
                                           java.lang.Integer accountId,
                                           java.lang.String data)

Edits clients of an advertising agency.

Parameters:

actor - vk user actor

accountId - Advertising account ID.

data - Serialized JSON array of objects that describe changes in clients. Description of 'client_mod' objects see below.

Returns:

query

updateClients

public AdsUpdateClientsQuery updateClients(UserActor actor)

Edits clients of an advertising agency.

Parameters:

actor - vk user actor

Returns:

only actor query

updateOfficeUsers

public AdsUpdateOfficeUsersQuery updateOfficeUsers(UserActor actor,
                                                   java.lang.Integer accountId,
                                                   UserSpecification... data)

Adds managers and/or supervisors to advertising account.

Parameters:

actor - vk user actor

accountId - Advertising account ID.

data - Serialized JSON array of objects that describe added managers. Description of 'user_specification' objects see below.

Returns:

query

updateOfficeUsers

public AdsUpdateOfficeUsersQuery updateOfficeUsers(UserActor actor,
                                                   java.lang.Integer accountId,
                                                   java.util.List<UserSpecification> data)

Adds managers and/or supervisors to advertising account.

Parameters:

actor - vk user actor

accountId - Advertising account ID.

data - Serialized JSON array of objects that describe added managers. Description of 'user_specification' objects see below.

Returns:

query

updateOfficeUsers

public AdsUpdateOfficeUsersQuery updateOfficeUsers(UserActor actor)

Adds managers and/or supervisors to advertising account.

Parameters:

actor - vk user actor

Returns:

only actor query

updateTargetGroup

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

Edits a retarget group.

Parameters:

actor - vk user actor

accountId - Advertising account ID.

targetGroupId - Group ID.

name - New name of the target group - a string up to 64 characters long.

lifetime - '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.

Returns:

query

updateTargetGroup

public AdsUpdateTargetGroupQuery updateTargetGroup(UserActor actor)

Edits a retarget group.

Parameters:

actor - vk user actor

Returns:

only actor query

updateTargetPixel

public AdsUpdateTargetPixelQuery updateTargetPixel(UserActor actor,
                                                   java.lang.Integer accountId,
                                                   java.lang.Integer targetPixelId,
                                                   java.lang.String name,
                                                   java.lang.Integer categoryId)

Parameters:

actor - vk user actor

accountId -

targetPixelId -

name -

categoryId -

Returns:

query

updateTargetPixel

public AdsUpdateTargetPixelQuery updateTargetPixel(UserActor actor)

Parameters:

actor - vk user actor

Returns:

only actor query