Campaign AdSets

The Campaign AdSets API fetches a list of all AdSets associated with a specific campaign. This endpoint is crucial for managing and reviewing AdSets within a campaign, allowing for effective tracking and adjustment.

warning

Ensure that Ad Set data is accessed securely and only by authorized users to maintain confidentiality and integrity of the information.

API Endpoint

Method: GET

URL: https://<PA_RM_END_POINT>/retail-media/campaigns/{campaignId}/adsets

info

Please refer to the Supplier API documentation for detailed instructions on how to retrieve the supplierId and Campaign List API for campaignId.

Request Header

Name	Value
Content-Type	application/json
Authorization	Bearer ACCESS_TOKEN

info

Please refer to the Authentication API documentation for bearer token.

Request Query Parameters

Parameter	Type	Description
page	integer	The page number of the user list. Defaults to 1 if not specified.
limit	integer	The number of users to return per page. Defaults to 10 but can be set as needed up to a maximum of 100.

Response Payload

Success Response

• Status Code: 200 OK
• Payload: Returns list of adsets for a particular campaign that belongs to a specific supplier in JSON format

{
    "adsets": [
      {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
          "name": "name of the adset",
          "collectionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
          "placements": [
            {
                "id": "xxxxxxxxxxxxxxxxxxxxxxxxx",
                "name": "Hero Banner",
                "widget": "Banner",
                "route": "Home Page",
                "strategy": "Fixed",
                "adSetType": "Sponsored Display",
                "costType": "Cost per click",
                "availabeSlots": [1],
                "cost": 0.5,
                "status": "Active",
                "isKeywordTargetingEnabled": false,
                "startDate": "2025-02-20",
                "endDate": "2025-02-21"
                "specialRates": [
                    {
                        "title": "special rate title",
                        "specialCost": 2.00,
                        "startDate": "2025-02-20",
                        "endDate": "2025-02-21",
                        "id": "xxxxxxxxxxxxxxxxxxxxxxxxx"
                    }
                ],
                "dimension": "360x600",
                "displayDimensionType": "IAB Standerd",
            },
          ],

          "banner": {
            "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "title": "Banner title",
            "images": [
              {
                "imageUrl": "",
                "deviceType": "Desktop"
              },
              {
                "imageUrl": "",
                "deviceType": "Mobile"
              },
              {
                "imageUrl": "",
                "deviceType": "Tablet"
              }
            ]
        }
      },
      {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
          "name": "name of the adset",
          "collectionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
          "placements":[
            {
                "id": "xxxxxxxxxxxxxxxxxxxxxxxxx",
                "name": "placement name",
                "widget": "Popular Items",
                "route": "Home Page",
                "strategy": "Relevance",
                "adSetType": "Sponsored Product",
                "costType": "Cost per mille",
                "availabeSlots": [2, 0, 1, 3, 7, 6, 4, 5],
                "cost": 0.5,
                "status": "Active",
            }
          ]
      }
    ],
    
    "totalItems": 12,
    "totalPages": 1,
    "currentPage": 1,
    "pageSize": 20,
    "hasPreviousPage": false,
    "hasNextPage": false
}

Parameter	Type	Description
id	GUID	System generated ID of the adset.
name	string	Name of the adset
collectionId	GUID	AdSet collection ID attached to this adset.
placements	Array of Object	Array of placements attached to this adset. Check the details parameter defination in placement object section
banner	Object	Banner details attached to this adset. Check the details parameter defination in banner object section
totalItems	integer	Total number of users available for the given organisation.
totalPages	integer	Total number of pages available for the given organisation.
currentPage	integer	Current page number for the list of users.
pageSize	integer	Number of users returned per page.
hasPreviousPage	boolean	Indicates if previous page is available.
hasNextPage	boolean	Indicates if next page is available.

placement object

Parameter	Type	Description
id	GUID	System generated unique identifier for the placement
name	string	Name of the placement.
widget	string	Name of the widget where the placement is located.
route	string	Name of the route where the placement is located.
strategy	string	Advertising strategy used for the placement.
adSetType	string	Type of ad set associated with the placement.
costType	string	Type of cost associated with the placement.
availabeSlots	Array	List of available slots for the placement.
cost	float	Cost associated with the placement.
status	string	Status of the placement.
startDate	string	Start date for the placement. Only available for Fixed strategy.
endDate	string	End date for the placement. Only available for Fixed strategy.
specialRates	Array	List of special rates for the placement. Only available for Fixed strategy.
dimension	string	Dimension of the placement. Available for Sponsored Display AdSet type.
displayDimensionType	string	Type of dimension used for the placement. Available for Sponsored Display AdSet type.
isKeywordTargetingEnabled	boolean	Indicates if keyword targeting is enabled for the placement. Available for Sponsored Display AdSet type.

banner object

Parameter	Type	Description
id	GUID	System generated unique identifier for the banner
name	string	Name of the banner.
images	array of object	Array of object for the banner image. Fields are url & deviceType

Error Response

If an error occurs, the API will return an appropriate status code along with an error message.

• Sample Error Response (400 Bad Request):

{
  "errors": [
    "Error message 1",
    "Error message 2"
  ],
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "traceId": "xxxxxxxxxxxxxxxxxxx"
}

Example Usage (JavaScript)

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "BEARER YOUR_ACCESS_TOKEN");

var urlencoded = new URLSearchParams();

var requestOptions = {
  method: 'GET',
  headers: myHeaders,
  body: urlencoded,
  redirect:'follow'
};

fetch("https://<PA_RM_END_POINT>/retail-media/campaigns/{campaignId}/adsets?page=1&limit=100", requestOptions)
  .then(response => response.json())
  .then(result=> { 
    console.log(result);
  })
  .catch(error => console.log('error', error));