rym_auth: Authentication in Yandex Metrika API

In selesnow/rym: R Interface to Yandex Metrica API

Authentication in Yandex Metrika API

Description

Actually you don't need call rym_auth since it will be called when you run any of the functions available in rym.

Usage

rym_auth(login = getOption("rym.user"), 
         new.user = FALSE, 
         token.path = getOption("rym.token_path"))

Arguments

login	character, Your Yandex login
new.user	logical, If TRUE you reauth in Yandex Metrika API
token.path	character, Directory for store API credential

Details

All your credential save in directory specified in the argument token.path, after save every time you run any function from rym, rym_auth be load credentials from local file login.rymAuth.RData. rym_auth create files for each your logins, which makes it possible use many yandex account in one script. Every tokens expire after 1 year after authentication, but rym_auth automaticly refresh and save you credential 30 days before he expire.

Value

List with credential data.

Author(s)

Alexey Seleznev

References

OAuth 2.0 in Yandex docs - https://tech.yandex.ru/oauth/doc/dg/concepts/about-docpage/

Examples

## Not run: 
library(rym)
rym_auth(login = "my_login")

## End(Not run)

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