Skip to main content

Get Ad Sets

  • Updated

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

Request

End Point https://business.newsbreak.com/business-api/v1/ad-set/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 set status filter. Available values: WARNING, INACTIVE, ACTIVE, DELETED, READY, COMPLETED.
campaignIds N string[] Get ad sets in the campaigns only. Leave as null if you don't want to filter by campaign.
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-set/getList?adAccountId=12345&search=123456789&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.
└── pageNo int Number of current page.
└── pageSize int Size of current page.
└── total int Total size for this search.
└── hasNext bool Whether there is next page.
└── rows object[] Each row is an ad set.
    └── id string Ad set ID.
    └── name string Ad set name.
    └── orgId string Organization ID.
    └── adAccountId string Ad account ID.
    └── campaignId string Campaign ID.
    └── trackingId string Event tracking ID.
    └── budget int Ad set budget in cents.
    └── budgetType enumerate Ad set budget type.
    └── status string Ad set status.
    └── onlineStatus string Ad set Online status.
    └── startTime string Ad set start time.
    └── endTime string Ad set end time.
    └── schedule map Ad set schedule.
    └── bidType enumerate Ad set bid type.
    └── bidRate string Ad set status in cents.
    └── deliveryRate enumerate Delivery Rate of the ad set.
    └── optimization bool Whether the creative should be optimized.
    └── frequencyCaps list Delivery frequency cap of the ad set.
    └── targeting map The targeting of the ad set.
    └── createTime string Create time of the ad set.
    └── updateTime string Update time of the ad set.

Example

{
    "code": 0,
    "data": {
        "rows": [
            {
                "id": "123456789",
                "orgId": "987654321",
                "adAccountId": "123456789",
                "campaignId": "987654321",
                "name": "my ad set example",
                "trackingId": "123456789",
                "budget": 10000,
                "onlineStatus": "ACTIVE",
                "status": "ON",
                "budgetType": "DAILY",
                "startTime": 1712029800,
                "endTime": 1735793459,
                "schedule": {
                    "1": [
                        5,
                        6,
                        7,
                        8,
                        9,
                        10,
                        11,
                        12,
                        13,
                        14,
                        15,
                        16
                    ],
                    "3": [
                        6,
                        7,
                        8
                    ]
                },
                "bidType": "TARGET_CPA",
                "bidRate": 1000,
                "deliveryRate": "ASAP",
                "optimization": true,
                "frequencyCaps": [
                    {
                        "impressions": 1,
                        "days": 1,
                        "timeUnit": "DAY"
                    }
                ],
                "targeting": {
                    "gender": {
                        "positive": [
                            "female"
                        ]
                    },
                    "ageGroup": {
                        "positive": [
                            "31-44"
                        ]
                    },
                    "interest": {
                        "positive": [
                            "all"
                        ]
                    },
                    "location": {
                        "positive": [
                            "all"
                        ]
                    },
                    "language": {
                        "positive": [
                            "en_us"
                        ]
                    },
                    "os": {
                        "positive": [],
                        "negative": [
                            "android@5",
                            "android@6"
                        ]
                    },
                    "manufacturer": {
                        "positive": [
                            "all"
                        ]
                    },
                    "carrier": {
                        "positive": [
                            "all"
                        ]
                    },
                    "network": {
                        "positive": [
                            "5g",
                            "wifi"
                        ]
                    }
                },
                "createTime": "1700000000",
                "updateTime": "1710000000"
            }
        ],
        "pageNo": 1,
        "pageSize": 5,
        "total": 1,
        "hasNext": false
    }
}

 

 

Related articles