DefinitelyTyped/types/gapi.client.doubleclickbidmanager

TypeScript typings for DoubleClick Bid Manager API v1

API for viewing and managing your reports in DoubleClick Bid Manager. For detailed description please check documentation.

Installing

Install typings for DoubleClick Bid Manager API:

npm install @types/gapi.client.doubleclickbidmanager@v1 --save-dev

Usage

You need to initialize Google API client in your code:

gapi.load("client", () => { 
    // now we can use gapi.client
    // ... 
});

Then load api client wrapper:

gapi.client.load('doubleclickbidmanager', 'v1', () => {
    // now we can use gapi.client.doubleclickbidmanager
    // ... 
});

Don't forget to authenticate your client before sending any request to resources:

// declare client_id registered in Google Developers Console
var client_id = '',
    scope = [     
        // View and manage your reports in DoubleClick Bid Manager
        'https://www.googleapis.com/auth/doubleclickbidmanager',
    ],
    immediate = true;
// ...

gapi.auth.authorize({ client_id: client_id, scope: scope, immediate: immediate }, authResult => {
    if (authResult && !authResult.error) {
        /* handle succesfull authorization */
    } else {
        /* handle authorization error */
    }
});            

After that you can use DoubleClick Bid Manager API resources:

    
/* 
Retrieves line items in CSV format.  
*/
await gapi.client.lineitems.downloadlineitems({  }); 
    
/* 
Uploads line items in CSV format.  
*/
await gapi.client.lineitems.uploadlineitems({  }); 
    
/* 
Creates a query.  
*/
await gapi.client.queries.createquery({  }); 
    
/* 
Deletes a stored query as well as the associated stored reports.  
*/
await gapi.client.queries.deletequery({ queryId: "queryId",  }); 
    
/* 
Retrieves a stored query.  
*/
await gapi.client.queries.getquery({ queryId: "queryId",  }); 
    
/* 
Retrieves stored queries.  
*/
await gapi.client.queries.listqueries({  }); 
    
/* 
Runs a stored query to generate a report.  
*/
await gapi.client.queries.runquery({ queryId: "queryId",  }); 
    
/* 
Retrieves stored reports.  
*/
await gapi.client.reports.listreports({ queryId: "queryId",  }); 
    
/* 
Retrieves entities in SDF format.  
*/
await gapi.client.sdf.download({  });