@maxim_mazurok/gapi.client.adexchangebuyer
    TypeScript icon, indicating that this package has built-in type declarations

    1.4.20210818 • Public • Published

    TypeScript typings for Ad Exchange Buyer API v1.4

    Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports. For detailed description please check documentation.

    Installing

    Install typings for Ad Exchange Buyer API:

    npm install @types/gapi.client.adexchangebuyer@v1.4 --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('adexchangebuyer', 'v1.4', () => {
      // now we can use gapi.client.adexchangebuyer
      // ...
    });

    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 = [ 
          // Manage your Ad Exchange buyer account configuration
          'https://www.googleapis.com/auth/adexchange.buyer',
        ],
        immediate = true;
    // ...
    
    gapi.auth.authorize(
      { client_id: client_id, scope: scope, immediate: immediate },
      authResult => {
        if (authResult && !authResult.error) {
            /* handle successful authorization */
        } else {
            /* handle authorization error */
        }
    });

    After that you can use Ad Exchange Buyer API resources:

    /*
    Gets one account by ID.
    */
    await gapi.client.adexchangebuyer.accounts.get({ id: 1,  });
    
    /*
    Retrieves the authenticated user's list of accounts.
    */
    await gapi.client.adexchangebuyer.accounts.list({  });
    
    /*
    Updates an existing account. This method supports patch semantics.
    */
    await gapi.client.adexchangebuyer.accounts.patch({ id: 1,  });
    
    /*
    Updates an existing account.
    */
    await gapi.client.adexchangebuyer.accounts.update({ id: 1,  });
    
    /*
    Returns the billing information for one account specified by account ID.
    */
    await gapi.client.adexchangebuyer.billingInfo.get({ accountId: 1,  });
    
    /*
    Retrieves a list of billing information for all accounts of the authenticated user.
    */
    await gapi.client.adexchangebuyer.billingInfo.list({  });
    
    /*
    Returns the budget information for the adgroup specified by the accountId and billingId.
    */
    await gapi.client.adexchangebuyer.budget.get({ accountId: "accountId", billingId: "billingId",  });
    
    /*
    Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request. This method supports patch semantics.
    */
    await gapi.client.adexchangebuyer.budget.patch({ accountId: "accountId", billingId: "billingId",  });
    
    /*
    Updates the budget amount for the budget of the adgroup specified by the accountId and billingId, with the budget amount in the request.
    */
    await gapi.client.adexchangebuyer.budget.update({ accountId: "accountId", billingId: "billingId",  });
    
    /*
    Add a deal id association for the creative.
    */
    await gapi.client.adexchangebuyer.creatives.addDeal({ accountId: 1, buyerCreativeId: "buyerCreativeId", dealId: "dealId",  });
    
    /*
    Gets the status for a single creative. A creative will be available 30-40 minutes after submission.
    */
    await gapi.client.adexchangebuyer.creatives.get({ accountId: 1, buyerCreativeId: "buyerCreativeId",  });
    
    /*
    Submit a new creative.
    */
    await gapi.client.adexchangebuyer.creatives.insert({  });
    
    /*
    Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.
    */
    await gapi.client.adexchangebuyer.creatives.list({  });
    
    /*
    Lists the external deal ids associated with the creative.
    */
    await gapi.client.adexchangebuyer.creatives.listDeals({ accountId: 1, buyerCreativeId: "buyerCreativeId",  });
    
    /*
    Remove a deal id associated with the creative.
    */
    await gapi.client.adexchangebuyer.creatives.removeDeal({ accountId: 1, buyerCreativeId: "buyerCreativeId", dealId: "dealId",  });
    
    /*
    Delete the specified deals from the proposal
    */
    await gapi.client.adexchangebuyer.marketplacedeals.delete({ proposalId: "proposalId",  });
    
    /*
    Add new deals for the specified proposal
    */
    await gapi.client.adexchangebuyer.marketplacedeals.insert({ proposalId: "proposalId",  });
    
    /*
    List all the deals for a given proposal
    */
    await gapi.client.adexchangebuyer.marketplacedeals.list({ proposalId: "proposalId",  });
    
    /*
    Replaces all the deals in the proposal with the passed in deals
    */
    await gapi.client.adexchangebuyer.marketplacedeals.update({ proposalId: "proposalId",  });
    
    /*
    Add notes to the proposal
    */
    await gapi.client.adexchangebuyer.marketplacenotes.insert({ proposalId: "proposalId",  });
    
    /*
    Get all the notes associated with a proposal
    */
    await gapi.client.adexchangebuyer.marketplacenotes.list({ proposalId: "proposalId",  });
    
    /*
    Update a given private auction proposal
    */
    await gapi.client.adexchangebuyer.marketplaceprivateauction.updateproposal({ privateAuctionId: "privateAuctionId",  });
    
    /*
    Retrieves the authenticated user's list of performance metrics.
    */
    await gapi.client.adexchangebuyer.performanceReport.list({ accountId: "accountId", endDateTime: "endDateTime", startDateTime: "startDateTime",  });
    
    /*
    Deletes an existing pretargeting config.
    */
    await gapi.client.adexchangebuyer.pretargetingConfig.delete({ accountId: "accountId", configId: "configId",  });
    
    /*
    Gets a specific pretargeting configuration
    */
    await gapi.client.adexchangebuyer.pretargetingConfig.get({ accountId: "accountId", configId: "configId",  });
    
    /*
    Inserts a new pretargeting configuration.
    */
    await gapi.client.adexchangebuyer.pretargetingConfig.insert({ accountId: "accountId",  });
    
    /*
    Retrieves a list of the authenticated user's pretargeting configurations.
    */
    await gapi.client.adexchangebuyer.pretargetingConfig.list({ accountId: "accountId",  });
    
    /*
    Updates an existing pretargeting config. This method supports patch semantics.
    */
    await gapi.client.adexchangebuyer.pretargetingConfig.patch({ accountId: "accountId", configId: "configId",  });
    
    /*
    Updates an existing pretargeting config.
    */
    await gapi.client.adexchangebuyer.pretargetingConfig.update({ accountId: "accountId", configId: "configId",  });
    
    /*
    Gets the requested product by id.
    */
    await gapi.client.adexchangebuyer.products.get({ productId: "productId",  });
    
    /*
    Gets the requested product.
    */
    await gapi.client.adexchangebuyer.products.search({  });
    
    /*
    Get a proposal given its id
    */
    await gapi.client.adexchangebuyer.proposals.get({ proposalId: "proposalId",  });
    
    /*
    Create the given list of proposals
    */
    await gapi.client.adexchangebuyer.proposals.insert({  });
    
    /*
    Update the given proposal. This method supports patch semantics.
    */
    await gapi.client.adexchangebuyer.proposals.patch({ proposalId: "proposalId", revisionNumber: "revisionNumber", updateAction: "updateAction",  });
    
    /*
    Search for proposals using pql query
    */
    await gapi.client.adexchangebuyer.proposals.search({  });
    
    /*
    Update the given proposal to indicate that setup has been completed.
    */
    await gapi.client.adexchangebuyer.proposals.setupcomplete({ proposalId: "proposalId",  });
    
    /*
    Update the given proposal
    */
    await gapi.client.adexchangebuyer.proposals.update({ proposalId: "proposalId", revisionNumber: "revisionNumber", updateAction: "updateAction",  });
    
    /*
    Gets the requested publisher profile(s) by publisher accountId.
    */
    await gapi.client.adexchangebuyer.pubprofiles.list({ accountId: 1,  });

    Keywords

    none

    Install

    npm i @maxim_mazurok/gapi.client.adexchangebuyer

    DownloadsWeekly Downloads

    48

    Version

    1.4.20210818

    License

    MIT

    Unpacked Size

    196 kB

    Total Files

    6

    Last publish

    Collaborators

    • maxim_mazurok