tune-reporting/lib/api/AdvertiserReportLogEvents.js

TUNE Reporting SDK for Node.js

#!/usr/bin/env node
/**
 * AdvertiserReportLogEvents.js, TUNE Reporting SDK class.
 *
 * @module tune-reporting
 * @submodule api
 * @main tune-reporting
 *
 * @category  tune-reporting-node
 *
 * @author    Jeff Tanner <jefft@tune.com>
 * @copyright 2015 TUNE, Inc. (http://www.tune.com)
 * @license   http://opensource.org/licenses/MIT The MIT License (MIT)
 * @version   $Date: 2015-04-07 15:04:18 $
 * @link      http://developers.mobileapptracking.com @endlink
 */
"use strict";

// Dependencies
var
  util = require('util'),
  _ = require('lodash'),
  AdvertiserReportLogBase = require('../base/endpoints').AdvertiserReportLogBase;

/**
 * TUNE Advertiser Report endpoint '/advertiser/stats/events/'.
 *
 * @class AdvertiserReportLogEvents
 * @constructor
 * @extends AdvertiserReportLogBase
 */
function AdvertiserReportLogEvents() {
  AdvertiserReportLogEvents.super_.call(
    this,
    "advertiser/stats/events",
    true,
    true
  );
}

util.inherits(AdvertiserReportLogEvents, AdvertiserReportLogBase);

/**
 * Get list of recommended fields for endpoint.
 *
 * @property getFieldsRecommended
 * @protected
 * @return {Array}
 */
AdvertiserReportLogEvents.prototype.getFieldsRecommended = function () {
  return [
    'id',
    'stat_install_id',
    'created',
    'status',
    'site_id',
    'site.name',
    'site_event_id',
    'site_event.name',
    'site_event.type',
    'publisher_id',
    'publisher.name',
    'advertiser_ref_id',
    'advertiser_sub_campaign_id',
    'advertiser_sub_campaign.ref',
    'publisher_sub_campaign_id',
    'publisher_sub_campaign.ref',
    'user_id',
    'device_id',
    'os_id',
    'google_aid',
    'ios_ifa',
    'ios_ifv',
    'windows_aid',
    'referral_url',
    'is_view_through',
    'is_reengagement'
  ];
};

module.exports = AdvertiserReportLogEvents;