@datafire/nativeads

Client library for Native Ads Publisher API

Installation and Usage

``bash
npm install --save @datafire/nativeads
`
`js
let nativeads = require('@datafire/nativeads').create();

.then(data => {
console.log(data);
});
`

Description

This is a Native Ads Publisher API it provides same functionality as Native Ads Publisher Account GUI.




Actions

$3

Returns Native Ads Publisher API token


`js
nativeads.auth.default.login.post({
"username": "",
"password": ""
}, context)
`

#### Input
* input object
* username required string: Native Ads Publisher username
* password required string: Native Ads Publisher password

#### Output
* output authResponse

$3

Returns publisher statistics split by date


`js
nativeads.publisher.reports.daily.get({
"token": "",
"startDate": "",
"endDate": "",
"limit": 0,
"page": 0
}, context)
`

#### Input
* input object
* token required string: Native Ads Publisher API authentication token
* startDate required string: start date in format YYYY-MM-DD
* endDate required string: end date in format YYYY-MM-DD
* limit required integer: maximum number of results per page
* page required integer: page number

#### Output
* output reportsDailyResponse

$3

Returns publisher statistics split by website


`js
nativeads.publisher.reports.website.get({
"token": "",
"startDate": "",
"endDate": "",
"limit": 0,
"page": 0
}, context)
`

#### Input
* input object
* token required string: Native Ads Publisher API authentication token
* startDate required string: start date in format YYYY-MM-DD
* endDate required string: end date in format YYYY-MM-DD
* limit required integer: maximum number of results per page
* page required integer: page number

#### Output
* output reportsWebsiteResponse

$3

Returns publisher statistics split by widget


`js
nativeads.publisher.reports.widget.get({
"token": "",
"startDate": "",
"endDate": "",
"limit": 0,
"page": 0
}, context)
`

#### Input
* input object
* token required string: Native Ads Publisher API authentication token
* startDate required string: start date in format YYYY-MM-DD
* endDate required string: end date in format YYYY-MM-DD
* limit required integer: maximum number of results per page
* page required integer: page number

#### Output
* output reportsWidgetResponse

Definitions

$3


* authResponse object
* success boolean
* token string

$3

* modelError object
* errors array
* items string
* success boolean

$3

* reportsDailyItem object
* clicks string
* cpc string
* ctr string
* date string
* earnings string
* impressions string
* net_ecpm string
* rpm string

$3

* reportsDailyResponse object
* items array
* items reportsDailyItem
* success boolean
* total_count integer
* totals totals

$3

* reportsWebsiteItem object
* clicks string
* cpc string
* ctr string
* date string
* earnings string
* impressions string
* net_ecpm string
* rpm string

$3

* reportsWebsiteResponse object
* items array
* items reportsWebsiteItem
* success boolean
* total_count integer
* totals totals

$3

* reportsWidgetItem object
* campaign string: widget name
* campaign_id string: widget id
* clicks string
* cpc string
* ctr string
* earnings string
* impressions string
* net_ecpm string
* rpm string

$3

* reportsWidgetResponse object
* items array
* items reportsWidgetItem
* success boolean
* total_count integer
* totals totals

$3

* totals object
* total_clicks string
* total_cpc string
* total_ctr string
* total_earnings string
* total_impressions string
* total_net_ecpm string
* total_rpm string`