Twitter Ads API for NodeJS
Switch branches/tags
Nothing to show
Clone or download
Latest commit 922bef5 Sep 18, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib v2 basic support Sep 18, 2017
.gitignore initial commit Oct 30, 2015
.npmignore version 0.0.3 changes Nov 2, 2015
.travis.yml fixed travis Jan 15, 2016
History.md v2 basic support Sep 18, 2017
LICENSE v2 basic support Sep 18, 2017
Readme.md v2 basic support Sep 18, 2017
index.js initial commit Oct 30, 2015
package.json v2 basic support Sep 18, 2017

Readme.md

Twitter Ads API

Build Status Dependency Status NPM version

NPM stats

A simple wrapper for Twitter Ads & TON API in NodeJS.

Installation

$ npm install twitter-ads

Usage

var TwitterAdsAPI = require('twitter-ads');
var T = new TwitterAdsAPI({
  consumer_key: 'XXX',
  consumer_secret: 'XXX',
  access_token: 'XXX',
  access_token_secret: 'XXX',
  sandbox: false, // defaults to true
  api_version: '2' //defaults to 2
});

T.get('accounts/:account_id', {account_id: 'XXX'}, function(error, resp, body) {
  if (error) return console.error(error);
  console.log(body);
  /* If everything goes okay,
  you should get something similar to this:
  
    {
      data: {
        approval_status: "ACCEPTED",
        created_at: "2014-07-14T22:51:48Z",
        deleted: false,
        id: "hkkd",
        name: "Some person named Emma",
        salt: "973fef8gce1c5d5f6bba4b91827c214a",
        timezone: "America/Los_Angeles",
        timezone_switch_at: "2014-07-27T07:00:00Z",
        updated_at: "2014-08-27T21:59:56Z"
      },
      data_type: "account",
      request: {
        params: {
          account_id: "hkkd"
        }
      }
    }  
  */
  
});

/* Use T.get, T.post, T.put and T.delete
   refer to Twitter API docs for the details on call parameters. */

Twitter TON API

T.tonUpload({
    file: './test.txt',
    content_type: 'text/plain',
    bucket_name: 'ta_partner'
  },
  function(error, location) {
    if (error) return console.error(error);
    console.log(location);
    /* If everything goes okay,
    you should get something similar to this:
      https://ton.twitter.com/1.1/ton/bucket/ta_partner/2892314386/n3UPAcC02roTP6C
    */
});

T.tonDownload({
    file: './test.txt',
    url: 'https://ton.twitter.com/1.1/ton/bucket/ta_partner/2892314386/n3UPAcC02roTP6C'
  },
  function(error, size) {
    if (error) return console.error(error);
    console.log(size);
    /* If everything goes okay,
    you should get something similar to this:
      204923
    */
});

Additional Configurables

  • sandbox (Boolean) - (Default: true) - Uses sandbox API host.
  • api_version (String) - (Default: 2) - Ads API version to use.