Skip to main content

Get Ads

  • Updated

Use this endpoint to get all ads for an ad account. Optionally, you can use filters in your request to return only certain ads.

Request

End Point https://business.newsbreak.com/business-api/v1/ad/getList

Method GET

Header

Field Required Data Type Description
Access-Token Y string Authorized access token. 

Request Parameters

Field Required Data Type Description
adAccountId Y string ID of ad account.
search N string Query to search.
onlineStatus N enumerate[] Ad status filter. Available values: WARNING, INACTIVE, ACTIVE, DELETED, PENDING, REJECTED.
campaignIds N string[] Get ad in the campaigns only. Leave as null if you don't want to filter by campaign.
adSetIds N string[] Get ad in the ad sets only. Leave as null if you don't want to filter by ad set.
pageNo Y integer Page number.
pageSize Y integer Page size. Available values: 5, 10, 20, 50, 100, 200, 500.

Example

curl --location --request GET 'https://business.newsbreak.com/business-api/v1/ad/getList?adAccountId=12345&search=11111111&onlineStatus=WARNING&onlineStatus=ACTIVE&pageNo=1&pageSize=5' \
-H 'Content-Type: application/json' \
-H 'Access-Token:{{Access-Token}}'
 

Response

Response Parameters

Field Data Type Description
code int Status code, see Return Codes.
errMsg string Error message when code!=0.
data object Response object.
└── createTime string Create time of the ad.
└── updateTime string Update time of the ad.
└── rows object[] Each row is an ad.
    └── id string Ad ID.
    └── name string Ad name.
    └── adAccountId string Ad account ID.
    └── campaignId string Campaign ID.
    └── adSetId string Ad set ID.
    └── clickTrackingUrl string[] Click tracking url list.
    └── impressionTrackingUrl string[] Impression tracking url list.
    └── status enumerate Status of the ad. Available values: ON, OFF.
    └── auditStatus enumerate Status of the ad. Available values: PENDING, APPROVED, REJECTED.
    └── onlineStatus enumerate Online display status of the ad. Available values: PENDING, REJECTED, ACTIVE, INACTIVE, WARNING, DELETED.
    └── statusTxt string Explanation of the status of the ad.
    └── createTime string Create time of the creative.
    └── updateTime string Update time of  the creative.
    └── creative object Creative of the ad.
        └── type enumerate Type of the ad. Available values: IMAGE, VIDEO, GIF.
        └── content object Content of the ad.
        └── headline string Title
        └── assetUrl string Url of the image/video/gif.
        └── height int Height of the video in pixel. Only required for videos.
        └── width int Width of the video in pixel. Only required for videos.
        └── coverUrl string Cover image of the video. Only applicable for videos.
        └── description string Description of this ad.
        └── callToAction string Text on button.
        └── brandName string Brand name of this ad.
        └── logoUrl string Url of the logo.
        └── clickThroughUrl string Landing page url.

Example

{
    "code": 0,
    "data": {
        "rows": [
            "id": "11111111",
            "adAccountId": "123456789",
            "campaignId": "987654321",
            "adSetId": "876543219",
            "name": "New ad for video ads",
            "clickTrackingUrl": [
                "https://business.newsbreak.com/tracking/redirect?nb_event_type=AD_EVENT_IMPRESSION&nb_source=gam_3p_tracking&nb_device_id=%%ADVERTISING_IDENTIFIER_PLAIN%%&nb_flight_id=%eaid!&nb_creative_id=%ecid!&uid_01=%%PATTERN:uid_01%%&uid_02=%%PATTERN:uid_02%%&uid_03=%%PATTERN:uid_03%%&uid_04=%%PATTERN:uid_04%%&uid_05=%%PATTERN:uid_05%%&uid_06=%%PATTERN:uid_06%%&uid_07=%%PATTERN:uid_07%%&uid_08=%%PATTERN:uid_08%%"
            ],
            "status": "ON",
            "auditStatus": "PENDING",
            "onlineStatus": "ACTIVE",
            "creative": {
                "type": "VIDEO",
                "content": {
                    "clickThroughUrl": "https://www.google.com",
                    "assetUrl": "https://static.particlenews.com/nova/assets/1524650104622800898/a0e0e1e65372f72b416777f386e00cc81bc0f141.mp4",
                    "height": 1080,
                    "width": 1920,
                    "brandName": "Newsbreak",
                    "logoUrl": "https://static.particlenews.com/nova/assets/1524650104622800898/5334f606c82250b827db23fe4c29f663b09e6ef5.png",
                    "headline": "New ad for video ads {state} {city}",
                    "description": "New ad for video ads {state} {city} New ad for video ads {state} {city}",
                    "callToAction": "Learn More",
                    "coverUrl": "https://static.particlenews.com/nova/assets/1524650104622800898/1ebe6f926b07f1d7f575012f5733cee5278b62ad.jpeg"
                },
                "createTime": "1700000000",
                "updateTime": "1710000000"
            },
            "statusTxt": "Under review. It usually takes 1-2 work days.",
            "createTime": "1700000000",
            "updateTime": "1720000000"
        ],
        "pageNo": 1,
        "pageSize": 5,
        "total": 1,
        "hasNext": false
    }
}
 

Related articles