vkGetAdCampaigns: Campaign list

In rvkstat: R Interface to API 'vk.com'

Description

Returns a list of available advertising campaigns from the advertising office Vkontakte.

Usage

vkGetAdCampaigns(
  account_id      = vkCurrentAdAccount(),
  client_id       = vkCurrentClientAccount(),
  include_deleted = TRUE,
  campaign_ids    = "null",
  username        = getOption("rvkstat.username"),
  api_version     = getOption("rvkstat.api_version"),
  token_path      = vkTokenPath(),
  access_token    = getOption("rvkstat.access_token")
)

Arguments

account_id	The ID of the advertising account, a list of all available advertising offices can be obtained using the function vkGetAdAccounts.
client_id	Client identifier from which advertisements are requested. Available and required for advertising agencies.
include_deleted	Boolean TRUE or FALSE, flag, specifying the need to display archived ads.
campaign_ids	Campaing ids.
username	Your vkontakte login.
api_version	Vkontakte API version.
token_path	Path to dir with credentials
access_token	API access tokens obtained using vkAuth or vkGetToken functions

Value

Date frame with a list of advertising offices and their parameters with the following values:

id	campaign ID.
type	campaign type.
name	campaign name.
status	campaign status.
day_limit	daily campaign limit in rubles.
all_limit	total campaign limit in rubles.
start_time	campaign start time.
stop_time	campaign stop time.
create_time	campaign creation time.
update_time	the last time the campaign was modified.

Author(s)

Alexey Seleznev

References

Documentation for API method ads.getCampaigns: https://vk.com/dev/ads.getCampaigns

Examples

## Not run: 
## get campaing list
my_vk_camp <- vkGetAdCampaigns(account_id = 1)

## End(Not run)

rvkstat documentation built on Oct. 18, 2021, 5:07 p.m.