| Type: | Package |
| Title: | Access to TikTok Ads via the 'Windsor.ai' API |
| Version: | 0.1.0 |
| Description: | Collect marketing data from TikTok Ads using the 'Windsor.ai' API https://windsor.ai/api-fields/. |
| License: | GPL-3 |
| URL: | https://windsor.ai/ |
| Depends: | R (≥ 3.5.0) |
| Imports: | jsonlite (≥ 1.7.2) |
| Suggests: | knitr, rmarkdown, dplyr, ggplot2, tidyr, curl |
| VignetteBuilder: | knitr |
| Encoding: | UTF-8 |
| Language: | en-US |
| LazyData: | true |
| RoxygenNote: | 7.2.1 |
| NeedsCompilation: | no |
| Packaged: | 2022-10-17 16:31:23 UTC; pablo |
| Author: | Pablo Sanchez [cre, aut], Windsor.ai [cph] |
| Maintainer: | Pablo Sanchez <pablosama@outlook.es> |
| Repository: | CRAN |
| Date/Publication: | 2022-10-18 06:40:02 UTC |
fetch_tiktokads A function to fetch TikTok Ads data from the windsor.ai API
Description
fetch_tiktokads A function to fetch TikTok Ads data from the windsor.ai API
Usage
fetch_tiktokads(
api_key,
date_from = NULL,
date_to = NULL,
fields = c("campaign", "clicks", "spend", "impressions", "date")
)
Arguments
api_key |
Your api key to access Windsor.ai API |
date_from |
The date from which to start getting data in format YYYY-MM-DD |
date_to |
The date until which to start getting data in format YYYY-MM-DD |
fields |
he fields fetched from the API for a given connector See https://windsor.ai/api-fields/ for details. |
Value
A data frame with the desired data
Examples
## Not run:
my_tiktokads_data <- fetch_tiktokads(api_key = "your api key",
date_from = "2022-10-01",
date_to = "2022-10-02",
fields = c("campaign", "clicks",
"spend", "impressions", "date"))
## End(Not run)
Sample data of TikTok ads from the Windsor API.
Description
A dataset containing sample TikTok ads data fetched from windsor.ai API. See more at: https://windsor.ai/
Usage
my_tiktokads_data
Format
A data frame with 164 rows and 5 variables:
- campaign
name of the campaign
- clicks
number of clicks
- spend
spend data
- impressions
impressions data
- date
date