Skip to main content

List Ad Sets

The List Ad Sets API retrieves a list of all Ad Sets within a specific campaign. This endpoint is essential for managing and reviewing various ad sets configured under a single campaign, enabling efficient tracking and adjustments as needed.

  • Method: GET

  • URL: https://<PA_RM_END_POINT>/rm/1.0/adset/{campaignId}

    info

    {campaignId} is the unique identifier for the campaign whose Ad Sets are being retrieved.

  • Headers:

    • Content-Type: application/json
    • Authorization: Bearer ACCESS_TOKEN

  • Response Codes:

    • 200 OK

      A successful request returns a structured JSON containing an array of Ad Set details, providing comprehensive information about each Ad Set's strategy, type, and operational status:

      [
          {
              "id": "xxxxxxxxxxxxxxxxxxxxxxx",
              "name": "Name of the Ad Set",
              "strategyType": 3,
              "adSetType": 1,
              "startDate": "2024-05-03T00:00:00",
              "endDate": "2024-05-16T23:59:59",
              "placementIds": ["placementId1", "placementId2"],
              "applyOnSpecificSlots": true,
              "slot": "Slot Identifier",
              "maxCPC": 0.50,
              "fixedCost": 100.00,
              "totalCost": 2000.00,
              "creativeSettings": [
                  {
                      "bannerTitle": "Summer Sale",
                      "termsAndConditionsUrl": "http://example.com/terms",
                      "bannerCopy": "Check out the latest summer collection.",
                      "ctaText": "Shop Now",
                      "ctaRedirectUrl": "http://example.com/shop",
                      "bannerImageUrl": "http://example.com/banner.jpg"
                  }
              ],
              "customerSegmentId": ["segmentId1", "segmentId2"],
              "productAttributeFilter": {
                  "attribute": "category",
                  "attributeValues": ["shoes", "accessories"]
              },
              "isRunning": true,
              "status": 10,
              "hasActiveAdSet": false
          }
      ]

    • Non-200 Responses

      If an error occurs (e.g., bad request, unauthorized access), the server will respond with an appropriate non-200 status code and include an error message in the response body:

      {
          "error": "Error message"
      }
      note

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