SCAuth: Store Credentials for the Adobe Analytics API

Description Usage Arguments Details Value References Examples

View source: R/SCAuth.R

Description

SCAuth

Usage

1
2
SCAuth(key, secret, company = "", token.file = "", auth.method = "legacy",
  debug.mode = FALSE, endpoint = "", locale = "en_US")

Arguments

key

Client id from your app in the Adobe Marketing cloud Dev Center OR if you are using auth.method='legacy', then this is the API username (username:company)

secret

Secret from your app in the Adobe Marketing cloud Dev Center OR if you are using auth.method='legacy', then this is the API shared secret

company

Your company (only required if using OAUTH2 AUTH method)

token.file

If you would like to save your OAUTH token and other auth details for use in future sessions, specify a file here. The method checks for the existence of the file and uses that if available.

auth.method

Defaults to legacy, can be set to 'OAUTH2' to use the newer OAUTH method.

debug.mode

Set global debug mode

endpoint

Set Adobe Analytics API endpoint rather than let RSiteCatalyst decide (not recommended)

locale

Set encoding for reports (defaults to en_US)

Details

Authorise and store credentials for the Adobe Analytics API

Value

Global credentials list 'SC.Credentials' in AdobeAnalytics (hidden) environment

References

The list of locale values can be obtained from the Adobe Analytics documentation:

https://marketing.adobe.com/developer/documentation/analytics-reporting-1-4/r-reportdescriptionlocale

Examples

1
2
3
4
5
6
## Not run: 
#Legacy authentication
SCAuth("key", "secret")


## End(Not run)

RSiteCatalyst documentation built on July 22, 2017, 1:01 a.m.