Skip to content

The TradeDesk API library with Auth, Retry and reflection capabilities when interacting with the API.

License

Notifications You must be signed in to change notification settings

GoodwayGroup/lib-tradedesk

Repository files navigation

lib-tradedesk

Coverage Status CircleCI

Usage

This plugin will interact with The Trade Desk's API.

View the API's documentation at https://apis.thetradedesk.com/v3/doc

NOTE: This module uses the debug logging tool. Use DEBUG=tradedesk* to view debug logging.

$ npm install -S @goodwaygroup/lib-tradedesk

const { TradeDesk } = require('@goodwaygroup/lib-tradedesk');

const ttd = new TradeDesk({
    username: '[email protected]',
    password: 'apasswordthatwontwork'
});

// Promises
ttd.get('/campaign/query/facets')
    .then((res) => res.json())
    .then((body) => console.log(body))
    .catch((err) => {
        console.log(err.stack);
        if (err.response) {
            return err.response.json().then((body) => console.log(body))
        }
    });

// Async/Await
try {
    const res = await ttd.get('/campaign/query/facets');
    console.log(await res.json());
} catch (err) {
    console.log(err.stack);
    if (err.response) {
        console.log(await err.response.json())
    }
}

Configuration Options

See Documentation

Full Documentation

See Documentation

Running Tests

To run tests, just run the following:

npm test

All commits are tested on CircleCI

Linting

To run eslint:

npm run lint

To auto-resolve:

npm run lint:fix

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use milestones and npm version to bump versions. We also employ git-chglog to manage the CHANGELOG.md. For the versions available, see the tags on this repository.

To initiate a version change:

npm version minor

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgments

Sponsors

goodwaygroup