v1

latestOpenAPI 3.1.02026-07-24590188.7 KB

adgroup/list

get/v2/api/adgroup/list

Request body

advertiser_idstring required
campaign_idstring required

Response

200

Example response

{
  "adgroups": [
    {
      "cursor": "<string>",
      "data": {
        "id": "<adsId>",
        "advertiser_id": "<adsId>",
        "campaign_id": "<adsId>",
        "name": "<string>",
        "status": "<string>",
        "user_status": "<string>",
        "placements": [
          "<string>"
        ],
        "bid": {
          "amount": "<money>",
          "pricing_type": "<string>"
        },
        "budget": {
          "amount": "<money>",
          "budget_type": "<string>"
        },
        "start_time": "<zonedDateTime>",
        "end_time": "<zonedDateTime>",
        "frequency_caps": [
          {
            "max_impressions": "<int>",
            "num_timeunits": "<int>",
            "timeunit": "<string>"
          }
        ],
        "targeting": {
          "included_location_targeting_ids": [
            "<adsId>"
          ],
          "excluded_location_targeting_ids": [
            "<adsId>"
          ],
          "audience_targeting_ids": [
            "<adsId>"
          ],
          "time_of_day": {
            "included": [
              {
                "days": [
                  "<string>"
                ],
                "time": {
                  "start_time": "<localDateTime>",
                  "end_time": "<localDateTime>"
                }
              }
            ],
            "excluded": [
              {
                "days": [
                  "<string>"
                ],
                "time": {
                  "start_time": "<localDateTime>",
                  "end_time": "<localDateTime>"
                }
              }
            ]
          }
        },
        "custom_audience_ids": [
          "<adsId>"
        ],
        "created_at": "<instant>",
        "updated_at": "<instant>"
      }
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "page_size": "<int>"
  }
}