findParams: Find valid parameters

Description Usage Arguments Details Value Author(s) See Also Examples

View source: R/findParams.R

Description

Helper function to check valid values for parameters of GET-family functions (i.e.: getAny).

Usage

1
2
3
findParams(params = c("level", "breakdowns", "date.preset",
  "action.breakdowns", "action.report.time", "action.attribution.windows",
  "time.increment"))

Arguments

params

parameter(s) to check

Details

Function applies to parameters of the following GET-family functions (i.e.: getAny) parameters:

Value

If one params is passed the function returns a vector otherwise a list is returned.

Author(s)

John Coene jcoenep@gmail.com

See Also

getAny, checkTargetTree

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
## Not run: 

# check all valid fields
parameters <- findParams()

# check valid breakdowns
val_br <- findParams("breakdowns")

# use parameter in GET-family function
dat <- getAny(id = "act_123456789012345", token = "XXXXXXXXXXXXX",
              breakdowns = val_br[1])


## End(Not run)

JohnCoene/fbadsinsightsr documentation built on May 28, 2019, 12:55 p.m.