CPV Lab Pro Documentation

NewsBreak Ads API integration in CPV Lab | CPV One

Steps required in order to setup the NewsBreak Ads Integration with CPV Lab (opens new window) or CPV One (opens new window) tracker:

1. Go to API integrations page

  • Go to Sources ➡️ API Integrations

TIP

Before you start, check the "Quick tour" from the right corner of this screen to understand how to use this page. New integration tour

2. Click New integration

  • Click to add the new integration on the NewsBreak Ads image:

New NewBreak Ads integration

3. NewsBreak API Token

  • A new screen will open where you have to enter
    • NewsBreak API Access Token
    • Organization ID (from NewsBreak)

New NewBreak Ads integration access token

  • Click on the Setup NewsBreak Integration" Button

4. Manage integration

After you save the integration you will go to the integration page. Here you have some settings for the integration:

  • Integration Name - this is a name you want to easily remember the integration with NewBreak

  • API token and Organization ID - the access information to NewsBreak

  • Cost Synchronization Method - choose how you want to see the costs coming from NewsBreak

    • Exact Total Cost - you will get exact same cost per campaign as in NewsBreak Ads.
      • this method will get the exact cost from NewsBreak and distribute it over all the visitors clicking the ads from that campaign
      • it may happen that some visitors to get a different CPC than the one in NewsBreak in this case.
    • Exact CPC - you will get the exact CPC for each ad as in NewsBreak Ads
      • this will get the exact CPC value from NewsBreak Ads
      • in case there are lost clicks (like the campaign was started in Meta before setting it up in CPV Lab), the total cost from NewsBreak Ads will not match the total cost from CPV.

  • The Active status - shows if that API connection is active or not

  • Each NewsBreak Ads API integration will allow syncronization for costs and to get conversions from the tracker

NewsBreak accounts selection

Accounts to Synchronize

  • On this section you will see a list with the accounts from NewsBreak.
  • Select the ones for which you want to syncronize campaigns costs.
  • Click Save or Save & Match
    • The "Save & Match" button will take you to the Match screen to match campaigns between NewsBreak and CPV Lab (CPV One)

5. Match Campaigns

  • To syncronize costs correctly, CPV Lab needs to know which campaigns from NewsBreak should be associated with which campaigns from the tracker.

  • For the match to work without issues, you need to match the campaigns from NewsBreak with the campaigns from CPV Lab on the Match screen.

  • 1. Select the campaign from NewsBreak

  • 2. Select the campaign from CPV tracker

  • 3. Click the Match button

    • A new record will show up in the data table below
    • You can delete the matching by clicking on the delete button from the Actions column.
    • Repeat the Matching until you have all the campaigns matched

  • 4. Save the Matchings

New NewBreak Ads integration match campaigns

6. Integration Status

  • By default the integration is set to “Active” and to Synchronize Costs from NewsBreak Ads.
    • You should leave all these checked in order to take advantage of all the Facebook Ads integration features.

7. Setup Cron Job (only for CPV Lab users)

As CPV Lab is a self-hosted ad tracker, you need to do an extra step in order to start the API integration beteen CPV Lab and NewsBreak Ads.

  • Setup a CRON job that will run the actual integration like this:
    • Frequency: once per hour
    • Command: cd /home/<server-name>/public_html/; php cron-api-integrations.php
  • Now the setup is complete and the CRON job will automatically synchronize CPC values for each keyword once per hour.

Tracking cost in CPV Lab | CPV One

  • After the API connection is established, you need to run traffic to your NewsBreak campaign.
  • Cost data will get automatically updated in the cost fields for that campaign in all CPV reports.
  • There may be an initial delay (up to 24 hours) before the costs appear inside the tracker(after the integration is created). But after that period, the costs will be updated automatically without delays.

WARNING

  • Campaigns are matched between the tracker and your NewsBreak Ads account based on the matching you do on the Match screen.
  • So make sure that you have the campaigns correctly matched.

Additional Notes

Number of matched campaigns

  • You can see the number of matched campaigns and imported keywords in the API integrations page by clicking on the Details button next to your already created integration:

NewsBreak API matched campaigns

Pass Conversions to NewsBreak Ads

  • NewsBreak is an ad network for Native Ads.
  • To Pass Conversion information from the ad tracker to NewsBreak, you need to use the Postback URL provided by NewsBreak
  • When you create a NewsBreak campaign in CPV Lab | CPV One, you will have the Postback URL automatically added to the campaign

NewsBreak Postback URL

You may also find useful:

← Setup Google Ads campaign →