rym-offline-conversion: Manage offline conversions

In selesnow/rym: R Interface to Yandex Metrica API

Manage offline conversions

Description

Offline Conversion Management:

rym_enable_offline_conversion

Enable offline conversion tracking for the specified counter.

rym_disable_offline_conversion

Disable offline conversion tracking for the specified counter.

rym_upload_offline_conversion

Upload offline conversions.

rym_allow_offline_conversion

Returns the date and time from which conversions can be linked to visits for the specified counter.

rym_get_uploadings_offline_conversions

Returns a list of offline conversion downloads.

Usage

rym_enable_offline_conversion(
   counter, 
   login      = getOption("rym.user"), 
   token.path = getOption("rym.token_path"))
           
rym_disable_offline_conversion(
   counter, 
   login      = getOption("rym.user"), 
   token.path = getOption("rym.token_path"))
   
rym_allow_offline_conversion(
   counter, 
   login      = getOption("rym.user"), 
   token.path = getOption("rym.token_path"))
   
rym_upload_offline_conversion(
   counter, 
   data,
   client.id.type = c("CLIENT_ID", "USER_ID"),
   comment        = paste0("Upload by rym at ", Sys.time()),
   login          = getOption("rym.user"), 
   token.path     = getOption("rym.token_path"))

rym_get_uploadings_offline_conversions(
   counter, 
   login      = getOption("rym.user"), 
   token.path = getOption("rym.token_path"))

Arguments

counter	Your yandex metrica counter
data	data.frame, expense data for loading
client.id.type	Type of visitor identifiers: CLIENT_ID or USER_ID
comment	Comment for data loading
login	character, Your Yandex login
token.path	character, Directory for store API credential

Details

Loading data format.

Require:

UserId, ClientId, Yclid

Identifier of the visitor to the site or advertising campaign in Yandex.Direct, for example: 12345

Target

Target ID specified when creating the target, for example order_confirmed

DateTime

The time at which the conversion occurred in Unix Time Stamp format. Indicate the time in the time zone UTC + 0, for example: 1481718166

Optional:

Price

Goal Value, for example: 1000

Currency

Three-letter currency code according to ISO 4217, for example: RUB

Example of CSV file.

Author(s)

Alexey Seleznev

References

See official dox: API documents Yandex Metrica documents

Examples

## Not run: 
# read data for upload
data <- read.csv("https://bit.ly/2CcsNyl")

# enable offline cnversion
rym_enable_offline_conversion(
   counter = 123456789, 
   login   = "your_login"
)

# upload data
rym_upload_offline_conversion(
   counter        = 123456789, 
   data           = data,
   client.id.type = "CLIENT_ID",
   login          = "your_login")
   
# check uploading
rym_allow_offline_conversion(
   counter = 123456789, 
   login   = "your_login")

## End(Not run)

selesnow/rym documentation built on March 25, 2023, 7:38 a.m.