rym (version 1.0.6)

rym-calls: Manage callss

Description

calls Management:

rym_enable_calls

Enable calls tracking for the specified counter.

rym_disable_calls

Disable calls tracking for the specified counter.

rym_upload_calls

Upload callss.

rym_allow_calls

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

rym_get_uploadings_callss

Returns a list of calls downloads.

Usage

rym_enable_calls(
   counter, 
   login      = getOption("rym.user"), 
   token.path = getOption("rym.token_path"))
           
rym_disable_calls(
   counter, 
   login      = getOption("rym.user"), 
   token.path = getOption("rym.token_path"))
   
rym_allow_calls(
   counter, 
   login      = getOption("rym.user"), 
   token.path = getOption("rym.token_path"))
   
rym_upload_calls(
   counter, 
   data,
   client.id.type = c("CLIENT_ID", "USER_ID"),
   new.goal.name  = NULL,
   comment        = paste0("Upload by rym at ", Sys.time()),
   login          = getOption("rym.user"), 
   token.path     = getOption("rym.token_path"))

rym_get_uploadings_calls( 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

new.goal.name

The name of the new goal for calls in the event that such a goal does not exist. If the target exists, this parameter is ignored

login

character, Your Yandex login

token.path

character, Directory for store API credential

Author

Alexey Seleznev

Details

Loading data format.

Require:

UserId, ClientId, Yclid

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

Optional:

StaticCall

whether the call is static (1 - static, 0 - dynamic)

Price

target price, the decimal separator is the dot (.)

Currency

currency in the three-letter format ISO 4217, for example: RUB

PhoneNumber

phone number without spaces (with country and city code). For example, +70123456789

TalkDuration

call duration in seconds

HoldDuration

call waiting time in seconds

CallMissed

whether the call is missed (1 - missed, 0 - answered)

Tag

custom label. It can be used to mark the quality of a call or its outcome, etc. For example, “the customer was not satisfied with the price”

FirstTimeCaller

primary (1 - primary call, 0 - secondary call)

URL

The URL from which the call came (the page associated with the event). For example, this could be the landing page for an ad campaign that has a phone number (PhoneNumber)

CallTrackerURL

The URL to go to the call tracker interface

Example of CSV file.

References

See official dox: API documents Upload calls info into Yandex Metrica Calls in Yandex Metrica

Examples

Run this code
if (FALSE) {
# read data for upload
data <- read.csv("https://bit.ly/2CcsNyl")

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

# upload data
rym_upload_calls(
   counter        = 123456789, 
   data           = data,
   client.id.type = "CLIENT_ID",
   login          = "your_login")
   
# check uploading
rym_allow_calls(
   counter = 123456789, 
   login   = "your_login")
}

Run the code above in your browser using DataLab