Narcissistic Pickle Meister

    criteo-mapi

    0.9.6 • Public • Published

    Criteo Node.js MAPI Client

    Features

    • Promise and Callback compatible
    • Authentication retry system
    • Inline documentation (JSDoc specification)
    • Save reporting results to file

    Installation

    $ npm install criteo-mapi

    Basic Code Examples

    Initialization
    const Criteo_MAPI = require( 'criteo-mapi' );
     
    const criteo = new Criteo_MAPI( 'username', 'password' );
    A Basic Request (Promise / then-able)

    Results from an API request can be returned as a settled Javascript Promise:

    criteo.getCampaignsByAdvertiser( '12345' )
        .then( (campaigns) => console.log(campaigns) )
        .catch ( (err) => console.log(err) )
    A Basic Request (Callback)

    Alternately, data can be returned via a standard callback function if one is provided as the final parameter:

    criteo.getCategoriesByCampaign( '9876',  true , (err, categories) => {
        if (!err){
            console.log(categories);
        }
    });

    Authentication Retry

    Oauth2 Tokens retrieved from the /oauth2/token endpoint are valid for 5 minutes.

    For the first request after initialization, the MAPI Client will request an authentication token based on the username and password provided and proceed with the request.

    First Request (No Stored Auth)

    MAPI Authentication Retry

    For subsequent requests, the stored token may have become invalid for long-running processes. The MAPI Client will automatically detect the need for a refreshed token and retry a request that fails once because of a 401 Unauthorized error.

    Request with Expired or Invalid Token

    MAPI Authentication Retry

    Other Features

    Saving Reports to File

    For reporting API calls, a filepath can be provided to optionally save results to a local path.

        const query = {
            'reportType': 'CampaignPerformance',
            'advertiserIds': '12345',
            'startDate': '2018-09-25',
            'endDate': '2018-09-26',
            'dimensions': [
                'AdvertiserId',
                'CampaignId'
            ],
            'metrics': [
                'Displays',
                'Clicks',
                'AdvertiserCost'
            ],
            'format': 'csv',
            'currency': 'USD',
            'timezone': 'PST'
        };
     
    criteo.getStats(query, './reports/results.csv')
        .then( (res) => console.log(res) )
        .catch( (err) => console.log(err) )
     

    Further Documentation

    Full Technical Documentation - JSDoc

    MAPI Documentation (Criteo Help Center)

    MAPI Spec and Test Tool (Swagger)

    License

    MIT

    Keywords

    Install

    npm i criteo-mapi

    DownloadsWeekly Downloads

    6

    Version

    0.9.6

    License

    MIT

    Unpacked Size

    55 kB

    Total Files

    6

    Last publish

    Collaborators

    • joepikowski