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

Update a DISPLAY or SPONSORED_BRAND ad-group.

\n

Rules

\n\n

Note:

\n", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "advertiserId", "type": "integer", "description": "", "format": "int32" }, { "kind": "required", "name": "campaignId", "type": "integer", "description": "", "format": "int32" }, { "kind": "required", "name": "adGroupId", "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": "DisplayAdGroupUpdateRequest", "schema": [ { "name": "name", "kind": "optional", "type": "string", "description": "" }, { "name": "budget", "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": "status", "kind": "optional", "type": "string", "description": "", "enum": [ "ADVERTISED", "ARCHIVED", "PAUSED" ] }, { "name": "maxBid", "kind": "optional", "type": "number", "description": "", "minimum": 0 }, { "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": "startDate", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "endDate", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "targetedGtins", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "buyout", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/BuyoutRequest", "customType": "BuyoutRequest", "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": "required", "type": "boolean", "description": "" }, { "name": "equalShareOfVoice", "kind": "optional", "type": "boolean", "description": "" }, { "name": "shareOfVoicePercentage", "kind": "optional", "type": "integer", "description": "", "format": "int32", "minimum": 1, "maximum": 100 }, { "name": "categories", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/CategoryBuyoutRequest", "customType": "CategoryBuyoutRequest", "schema": [ { "name": "ids", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "integer", "customType": "integer[]", "itemExample": "", "itemDefault": "" }, { "name": "includeSubcategories", "kind": "optional", "type": "boolean", "description": "" } ] } ] }, { "name": "approvalStatus", "kind": "optional", "type": "string", "description": "", "enum": [ "WAITING", "REJECTED", "APPROVED" ] }, { "name": "clickThroughUrl", "kind": "optional", "type": "string", "description": "", "minLength": 3, "maxLength": 2000, "pattern": "^(?!\\s*$).+" } ], "modelRef": "#/components/schemas/DisplayAdGroupUpdateRequest", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "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 } ] }, { "statusCode": "422", "description": "Unprocessable Entity", "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": "_oSpJ_kx7bwHlA4p0LEEX", "language": "curl", "label": "cURL", "code": "curl --request PUT \\\n --url https:///display/v2/advertisers/{advertiserId}/campaigns/{campaignId}/display/ad-groups/{adGroupId} \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"buyout\": {\n \"enabled\": \"\"\n }\n }'" }, { "id": "w7eB452Pebkk6ITcsLNCT", "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 \"buyout\": {\n \"enabled\": \"\"\n }\n});\n\nvar requestOptions = {\n method: 'PUT',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https:///display/v2/advertisers/{advertiserId}/campaigns/{campaignId}/display/ad-groups/{adGroupId}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "5ahGlHPp2pJE8C3lOH6cn", "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/{adGroupId}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Put.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"buyout\": {\n \"enabled\": \"\"\n }\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "9timOhb4xSf4OzPdFVmFS", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https:///display/v2/advertisers/{advertiserId}/campaigns/{campaignId}/display/ad-groups/{adGroupId}\"\n\npayload = json.dumps({\n \"buyout\": {\n \"enabled\": \"\"\n }\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"PUT\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "_oSpJ_kx7bwHlA4p0LEEX" }, "results": { "languages": [ { "id": "jlD25SNNepXT2fCglQ3aL", "language": "200", "code": "// OK\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": "zJPRWtwcVILNbx8dJNUcF", "language": "401", "code": "// Unauthorized\n" }, { "id": "NSuweUddb5Y7Y9rNvtfRO", "language": "403", "code": "// Forbidden\n" }, { "id": "qa6kXok0lXoVWXwjcv7Fr", "language": "404", "code": "// Not Found\n{\n \"messages\": [\n {\n \"text\": \"\",\n \"level\": \"\"\n }\n ]\n}" }, { "id": "MC4agnuPfsyVgqfdCxyr3", "language": "422", "code": "// Unprocessable Entity\n{\n \"messages\": [\n {\n \"text\": \"\",\n \"level\": \"\"\n }\n ]\n}" } ], "selectedLanguageId": "jlD25SNNepXT2fCglQ3aL" } }, "children": [ { "text": "" } ] }