Why List Ads for a Network

It can sometimes be helpful to retrieve an array of all ads that are part of a specific network. By returning a list of all ads for a network, you can add, update, and/or delete ads for that network.

The List Ads for Network API call, returns an array of all ads for a given network.

Note

In the response, depending on the settings of the ad, not all of these properties will be present (such as IsGoalOverride).

API Syntax

When using the List Ads for Network API call, it is important to understand the syntax required to make the request. Because the Kevel API is a RESTful API, there is a specific request format that must be followed to ensure the endpoint can process the request. The format is:

GET https://api.kevel.co/v1/ad

Where:

• GET - the type of API request being made.
• https://api.kevel.co - the URL for the request.
• v1 - the API version.
• ad - the API endpoint being called in the request.

200

Response Structure

{
  "page": 1,
  "items": [
    {
      "Id": 123456,
      "CampaignId": 123456,
      "FlightId": 123456,
      "ZoneId": null,
      "SiteId": null,
      "PublisherAccountId": 0,
      "Impressions": 100,
      "Percentage": 0,
      "DistributionType": 1,
      "IsDeleted": false,
      "IsActive": true,
      "Creative": {
        "Id": 12345,
        "Title": "Adzerk Blue Creative",
        "ImageName": "",
        "Url": "https://adzerk.com",
        "Body": "",
        "AdvertiserId": 12345,
        "IsActive": true,
        "AdTypeId": 5,
        "Alt": "Adzerk - Native Ads",
        "IsDeleted": false,
        "IsSync": false,
        "IsHTMLJS": true,
        "ScriptBody": "JS or HTML content",
        "Metadata": {
          "something": true
        },
        "ImageLink": "httpss://static.adzerk.net/Advertisers/",
        "IsNoTrack": true,
        "IsNetworkAd": false
      },
      "CustomTargeting": "$keywords contains \"dean\"",
      "FreqCap": 5,
      "FreqCapDuration": 1,
      "FreqCapType": 2,
      "DontAffectParentFreqCap": true,
      "StartDate": null,
      "EndDate": null,
      "StartDateISO": "2017-01-01T00:00:00.0000000",
      "EndDateISO": "2015-12-05T00:00:00.0000000",
      "GoalType": 1,
      "Price": 1,
      "IsGoalOverride": true,
      "IsStartEndDateOverride": true,
      "ActiveKeywords": [
        "kittens",
        "cats"
      ]
    }
  ]
}