--- title: /display/v2/advertisers/{advertiserId}/campaigns/{campaignId}/display/ad-groups slug: campaign-reporting-apis/displayv2advertisersadvertiseridcampaignscampaigniddisplayad-groups docTags: createdAt: 2026-03-25T11:01:52.241Z --- { "id": "Q94E2vfgK7ogOpsQaCYEe", "type": "api-oas-v2", "data": { "method": "POST", "url": "https:///display/v2/advertisers/{advertiserId}/campaigns/{campaignId}/display/ad-groups", "servers": [ { "url": "https:///display/v2/advertisers/{advertiserId}/campaigns/{campaignId}/display/ad-groups", "description": "Generated server url" } ], "name": "", "description": "

Creates an ad-group of type DISPLAY or SPONSORED_BRAND.

\n

The API endpoint GET /display/v2/advertisers/{advertiserId}/campaigns/{campaignId}/eligible/display/targeting\ncan be used to retrieve all the sites, publishers and ad-units targetable by the specified campaign. The\ncreatives in an ad-group must be of the sizes supported by the targeted site.

\n

The ad-unit locations HOME_PAGE, CHECKOUT, EMAIL and EMAIL_ABANDONED_CART are not targeted by\ndefault. All other available locations are targeted by default.

\n

Rules:

\n\n

Notes:

\n", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "advertiserId", "type": "integer", "description": "", "format": "int32" }, { "kind": "required", "name": "campaignId", "type": "integer", "description": "", "format": "int32" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "customType": "DisplayAdGroupCreateRequest", "schema": [ { "name": "publisherId", "kind": "required", "type": "integer", "description": "", "format": "int32", "minimum": 1 }, { "name": "name", "kind": "required", "type": "string", "description": "", "minLength": 1 }, { "name": "budget", "kind": "required", "type": "number", "description": "" }, { "name": "dailyBudget", "kind": "optional", "type": "number", "description": "" }, { "name": "weeklyBudget", "kind": "optional", "type": "number", "description": "" }, { "name": "monthlyBudget", "kind": "optional", "type": "number", "description": "" }, { "name": "useDynamicBudget", "kind": "optional", "type": "boolean", "description": "" }, { "name": "dailySpendPacing", "kind": "optional", "type": "string", "description": "" }, { "name": "startDate", "kind": "required", "type": "string", "description": "", "format": "date-time" }, { "name": "endDate", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "targetedSiteIds", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "integer", "customType": "integer[]", "itemExample": "", "itemDefault": "" }, { "name": "targetedLocations", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/AdGroupTargetLocation", "customType": "AdGroupTargetLocation[]", "schema": [ { "name": "location", "kind": "optional", "type": "string", "description": "" }, { "name": "pagePosition", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "targetedAdUnitIds", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "integer", "customType": "integer[]", "itemExample": "", "itemDefault": "" }, { "name": "clickThroughUrl", "kind": "required", "type": "string", "description": "", "minLength": 3, "maxLength": 2000, "pattern": "^(?!\\s*$).+" }, { "name": "maxBid", "kind": "required", "type": "number", "description": "", "minimum": 0 }, { "name": "targetedGtins", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "creatives", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/CreativeRequest", "customType": "CreativeRequest[]", "schema": [ { "name": "creativeSizeId", "kind": "required", "type": "integer", "description": "", "format": "int32", "minimum": 1 }, { "name": "assetId", "kind": "required", "type": "string", "description": "", "format": "uuid" } ] }, { "name": "type", "kind": "required", "type": "string", "description": "", "enum": [ "DISPLAY", "SPONSORED_BRAND" ] }, { "name": "status", "kind": "optional", "type": "string", "description": "", "enum": [ "ADVERTISED", "ARCHIVED", "PAUSED" ] } ], "modelRef": "#/components/schemas/DisplayAdGroupCreateRequest", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "Created", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "DisplayAdGroupResponse", "schema": [ { "name": "id", "kind": "optional", "type": "integer", "description": "", "format": "int32" }, { "name": "publisher", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/PublisherResponse", "customType": "PublisherResponse", "schema": [ { "name": "id", "kind": "optional", "type": "integer", "description": "", "format": "int32" }, { "name": "name", "kind": "optional", "type": "string", "description": "" }, { "name": "bidBelowGlobalFloorPrice", "kind": "optional", "type": "boolean", "description": "" } ] }, { "name": "marketId", "kind": "optional", "type": "integer", "description": "", "format": "int32" }, { "name": "name", "kind": "optional", "type": "string", "description": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "", "enum": [ "DISPLAY", "SPONSORED_BRAND" ] }, { "name": "status", "kind": "optional", "type": "string", "description": "", "enum": [ "ARCHIVED", "EXPIRED", "LIVE", "PAUSED", "SCHEDULED", "WAITING", "REJECTED" ] }, { "name": "budget", "kind": "optional", "type": "number", "description": "" }, { "name": "budgetSpent", "kind": "optional", "type": "number", "description": "" }, { "name": "dailyBudget", "kind": "optional", "type": "number", "description": "" }, { "name": "weeklyBudget", "kind": "optional", "type": "number", "description": "" }, { "name": "monthlyBudget", "kind": "optional", "type": "number", "description": "" }, { "name": "useDynamicBudget", "kind": "optional", "type": "boolean", "description": "" }, { "name": "dailySpendPacing", "kind": "optional", "type": "string", "description": "" }, { "name": "spendVelocity", "kind": "optional", "type": "number", "description": "", "format": "double" }, { "name": "buyout", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/AdGroupBuyout", "customType": "AdGroupBuyout", "schema": [ { "name": "adUnitId", "kind": "optional", "type": "integer", "description": "", "format": "int32" }, { "name": "keywords", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "enabled", "kind": "optional", "type": "boolean", "description": "" }, { "name": "equalShareOfVoice", "kind": "optional", "type": "boolean", "description": "" }, { "name": "shareOfVoicePercentage", "kind": "optional", "type": "integer", "description": "", "format": "int32" }, { "name": "categories", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/CategoryBuyout", "customType": "CategoryBuyout", "schema": [ { "name": "ids", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "integer", "customType": "integer[]", "itemExample": "", "itemDefault": "" }, { "name": "includeSubcategories", "kind": "optional", "type": "boolean", "description": "" } ] } ] }, { "name": "rejectionReason", "kind": "optional", "type": "string", "description": "" }, { "name": "startDate", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "endDate", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "targetedSiteIds", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "integer", "customType": "integer[]", "itemExample": "", "itemDefault": "" }, { "name": "targetedLocations", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/AdGroupTargetLocation", "customType": "AdGroupTargetLocation[]", "schema": [ { "name": "location", "kind": "optional", "type": "string", "description": "" }, { "name": "pagePosition", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "targetedAdUnitIds", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "integer", "customType": "integer[]", "itemExample": "", "itemDefault": "" }, { "name": "advertised", "kind": "optional", "type": "boolean", "description": "" }, { "name": "globalFloorPrice", "kind": "optional", "type": "number", "description": "" }, { "name": "clickThroughUrl", "kind": "optional", "type": "string", "description": "" }, { "name": "maxBid", "kind": "optional", "type": "number", "description": "" }, { "name": "targetedGtins", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ], "modelRef": "#/components/schemas/DisplayAdGroupResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "Unauthorized", "jsonExample": "", "isExpanded": true }, { "statusCode": "403", "description": "Forbidden", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "Not Found", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "MessageResponse", "schema": [ { "name": "messages", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/Message", "customType": "Message[]", "schema": [ { "name": "text", "kind": "optional", "type": "string", "description": "" }, { "name": "level", "kind": "optional", "type": "string", "description": "", "enum": [ "ERROR", "WARNING" ] } ] } ], "modelRef": "#/components/schemas/MessageResponse", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "KGxpbCB4rEZr_NlxFqmEJ", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https:///display/v2/advertisers/{advertiserId}/campaigns/{campaignId}/display/ad-groups \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"publisherId\": \"\",\n \"name\": \"\",\n \"budget\": \"\",\n \"startDate\": \"\",\n \"targetedSiteIds\": [],\n \"clickThroughUrl\": \"\",\n \"maxBid\": \"\",\n \"targetedGtins\": [],\n \"creatives\": [\n {\n \"creativeSizeId\": \"\",\n \"assetId\": \"\"\n }\n ],\n \"type\": \"\"\n }'" }, { "id": "ybWHRLrZbR92nS0ZWtlfu", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"publisherId\": \"\",\n \"name\": \"\",\n \"budget\": \"\",\n \"startDate\": \"\",\n \"targetedSiteIds\": [],\n \"clickThroughUrl\": \"\",\n \"maxBid\": \"\",\n \"targetedGtins\": [],\n \"creatives\": [\n {\n \"creativeSizeId\": \"\",\n \"assetId\": \"\"\n }\n ],\n \"type\": \"\"\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https:///display/v2/advertisers/{advertiserId}/campaigns/{campaignId}/display/ad-groups\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "oRuzddcnu8GA_8KTYRCKE", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https:///display/v2/advertisers/{advertiserId}/campaigns/{campaignId}/display/ad-groups\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"publisherId\": \"\",\n \"name\": \"\",\n \"budget\": \"\",\n \"startDate\": \"\",\n \"targetedSiteIds\": [],\n \"clickThroughUrl\": \"\",\n \"maxBid\": \"\",\n \"targetedGtins\": [],\n \"creatives\": [\n {\n \"creativeSizeId\": \"\",\n \"assetId\": \"\"\n }\n ],\n \"type\": \"\"\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "K2qcyk0PdewCLVByoAdLb", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https:///display/v2/advertisers/{advertiserId}/campaigns/{campaignId}/display/ad-groups\"\n\npayload = json.dumps({\n \"publisherId\": \"\",\n \"name\": \"\",\n \"budget\": \"\",\n \"startDate\": \"\",\n \"targetedSiteIds\": [],\n \"clickThroughUrl\": \"\",\n \"maxBid\": \"\",\n \"targetedGtins\": [],\n \"creatives\": [\n {\n \"creativeSizeId\": \"\",\n \"assetId\": \"\"\n }\n ],\n \"type\": \"\"\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "KGxpbCB4rEZr_NlxFqmEJ" }, "results": { "languages": [ { "id": "response-0-201", "language": "201", "code": "// Created\n{\n \"id\": \"\",\n \"publisher\": {\n \"id\": \"\",\n \"name\": \"\",\n \"bidBelowGlobalFloorPrice\": false\n },\n \"marketId\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"budget\": 0,\n \"budgetSpent\": 0,\n \"dailyBudget\": 0,\n \"weeklyBudget\": 0,\n \"monthlyBudget\": 0,\n \"useDynamicBudget\": false,\n \"dailySpendPacing\": \"\",\n \"spendVelocity\": \"\",\n \"buyout\": {\n \"adUnitId\": \"\",\n \"keywords\": [\n \"\"\n ],\n \"enabled\": false,\n \"equalShareOfVoice\": false,\n \"shareOfVoicePercentage\": \"\",\n \"categories\": {\n \"ids\": [\n 0\n ],\n \"includeSubcategories\": false\n }\n },\n \"rejectionReason\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"targetedSiteIds\": [\n 0\n ],\n \"targetedLocations\": [\n {\n \"location\": \"\",\n \"pagePosition\": \"\"\n }\n ],\n \"targetedAdUnitIds\": [\n 0\n ],\n \"advertised\": false,\n \"globalFloorPrice\": 0,\n \"clickThroughUrl\": \"\",\n \"maxBid\": 0,\n \"targetedGtins\": [\n \"\"\n ]\n}" }, { "id": "response-1-401", "language": "401", "code": "// Unauthorized\n" }, { "id": "response-2-403", "language": "403", "code": "// Forbidden\n" }, { "id": "response-3-404", "language": "404", "code": "// Not Found\n{\n \"messages\": [\n {\n \"text\": \"\",\n \"level\": \"\"\n }\n ]\n}" } ], "selectedLanguageId": "response-0-201" } }, "children": [ { "text": "" } ] }