---
title: "Kroger Ad Platform API"
url: "https://api-catalog-test.8451.com/apis/kroger-ad-platform-api-1/versions/161b884e-bbcf-458e-9b78-9eff02a00217"
---

# Kroger Ad Platform API

OpenAPI specification document.

```json
{"openapi":"3.1.0","info":{"title":"Kroger Ad Platform API","description":"Read more about KAP API in our Media Platform [Learning Center](https://mp-help.8451.com/mp-help/content/about/apis.htm).","version":"1"},"servers":[{"url":"/v1"}],"paths":{"/ad_groups/{ad_group_id}/entities":{"post":{"tags":["Ad Groups Endpoints"],"summary":"Create Ad Group Entities","description":"Add entities to an Ad Group in the Media Platform. Read more about [Ad groups](https://mp-help.8451.com/mp-help/content/about/ad-groups.htm) in our Media Platform Learning Center.","operationId":"Create_Ad_Group_entities_ad_groups__ad_group_id__entities_post","parameters":[{"name":"ad_group_id","in":"path","required":true,"schema":{"type":"integer","title":"Ad Group Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEntitiesRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleResponse_AdGroupV2_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"AdGroupStatus":{"type":"string","enum":["DRAFT","SCHEDULED","ACTIVE","ENDED","PAUSED","FAILED","UNDER REVIEW"],"title":"AdGroupStatus"},"AdGroupV2":{"properties":{"adGroupId":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"adGroupId","description":"Id that identified the Ad Group."},"campaignId":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"campaignId","description":"The campaign id associated with this ad group."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"name","description":"The ad group name."},"startDate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"startDate","description":"The start date of the ad group.","default":""},"endDate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"endDate","description":"The end date of the ad group. If null the ad group is considered 'always-on' and will stop when/if the campaign has an end date."},"budgetType":{"anyOf":[{"$ref":"#/components/schemas/BudgetType"},{"type":"null"}],"title":"budgetType","description":"The type of budget."},"budgetAmount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"budgetAmount","description":"The budget of the ad group. The sum of all the budgets from the ad group(s) may not exceed the campaign budget."},"status":{"anyOf":[{"$ref":"#/components/schemas/AdGroupStatus"},{"type":"null"}],"title":"status","description":"The status of the ad group."},"baseBid":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"baseBid","description":"The base bid used for all entities that have the useBaseBid flag as true. It must be above the highers floor price of the placement(s) selected."},"entities":{"anyOf":[{"items":{"$ref":"#/components/schemas/Entity"},"type":"array"},{"type":"null"}],"title":"entities","description":"The products to be advertised.","default":[]},"targets":{"items":{"$ref":"#/components/schemas/Target"},"type":"array","title":"targets","description":"The target dimensions for this ad group. Includes placements, divisions, and day parting."},"keywordBidModifiers":{"anyOf":[{"items":{"$ref":"#/components/schemas/KeywordBidModifier"},"type":"array"},{"type":"null"}],"title":"keywordBidModifiers","description":"Adjustments to keyword bids."},"isArchived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"isArchived","description":"Whether this ad group is archived."},"carouselHeadline":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"carouselHeadline","description":"This headline is displayed above the product cards to differentiate your Carousel from other listings"},"carouselSubtext":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"carouselSubtext","description":"Add subtext to carousel ad group."},"creativeType":{"anyOf":[{"$ref":"#/components/schemas/CarouselCreativeType"},{"type":"null"}],"title":"creativeType","description":"The type of creative."}},"type":"object","required":["targets"],"title":"AdGroupV2"},"BudgetType":{"type":"string","enum":["DAILY","WEEKLY","MONTHLY","LIFETIME"],"title":"BudgetType"},"CarouselCreativeType":{"type":"string","enum":["STANDARD","VIDEO"],"title":"CarouselCreativeType"},"CreateEntitiesRequest":{"properties":{"entities":{"items":{"$ref":"#/components/schemas/Entity"},"type":"array","title":"entities","description":"The products to be advertised."},"baseBid":{"type":"number","title":"baseBid","description":"The base bid used for all entities that have useBaseBid set to true."}},"type":"object","required":["entities","baseBid"],"title":"CreateEntitiesRequest"},"DomainError":{"properties":{"domain":{"$ref":"#/components/schemas/DomainType","title":"domain","description":"Type of object related to this error"},"id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"id","description":"Id of the object related to this error"},"fieldName":{"type":"string","title":"fieldName","description":"Name of the field in the object that has an error"},"code":{"type":"string","title":"code","description":"Generic error code"},"reason":{"type":"string","title":"reason","description":"Human readable reason for the error"},"datetime":{"$ref":"#/components/schemas/ErrorDateTime","title":"datetime","description":"Time the error occurred"},"rootCauses":{"anyOf":[{"items":{"$ref":"#/components/schemas/DomainError"},"type":"array"},{"type":"null"}],"title":"rootCauses","description":"Root causes for this error"}},"type":"object","required":["domain","fieldName","code","reason","datetime"],"title":"DomainError"},"DomainType":{"type":"string","enum":["ad_group","campaign","entity","keyword","sub_commodity"],"title":"DomainType"},"Entity":{"properties":{"id":{"type":"integer","title":"id","description":"Entity id"},"subCommodityId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"subCommodityId","description":"Sub commodity id"},"useBaseBid":{"type":"boolean","title":"useBaseBid","description":"Whether to use base bid."},"bidAmount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"bidAmount","description":"Bid amount for this entity."},"deleted":{"type":"boolean","title":"deleted","description":"Whether this entity is deleted."}},"type":"object","required":["id","useBaseBid","deleted"],"title":"Entity"},"EntityMeta":{"properties":{"success":{"type":"boolean","title":"success","description":"Whether the entity request was successful."},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"message","description":"Error message if the request was not successful."},"code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"code","description":"Error code if the request was not successful."},"publishStatus":{"anyOf":[{"$ref":"#/components/schemas/PublishStatus"},{"type":"null"}],"title":"publishStatus","description":"Publish status of the entity."},"errors":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"errors","description":"List of errors if the request was not successful.","default":[]},"warnings":{"anyOf":[{"$ref":"#/components/schemas/Warnings"},{"type":"null"}],"title":"warnings","description":"Upstream validation warnings."}},"type":"object","required":["success"],"title":"EntityMeta"},"ErrorDateTime":{"properties":{"value":{"type":"string","title":"value","description":"ISO time string"},"timezone":{"type":"string","title":"timezone","description":"Timezone abbreviation"}},"type":"object","required":["value","timezone"],"title":"ErrorDateTime"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"KeywordBidModifier":{"properties":{"keyword":{"type":"string","title":"keyword","description":"Keyword to modify."},"modifier":{"type":"number","title":"modifier","description":"Modifier value for this keyword."},"deleted":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"deleted","description":"Whether this keyword is deleted."}},"type":"object","required":["keyword","modifier"],"title":"KeywordBidModifier"},"PublishStatus":{"type":"string","enum":["EMPTY","PENDING","FAILED","PUBLISHED"],"title":"PublishStatus"},"SingleResponse_AdGroupV2_":{"properties":{"data":{"anyOf":[{"$ref":"#/components/schemas/AdGroupV2"},{"type":"null"}],"title":"data","description":"Data of the response."},"meta":{"$ref":"#/components/schemas/EntityMeta","title":"meta","description":"Response metadata."},"errors":{"anyOf":[{"items":{"$ref":"#/components/schemas/DomainError"},"type":"array"},{"type":"null"}],"title":"errors","description":"Errors for this response"},"warnings":{"anyOf":[{"items":{"$ref":"#/components/schemas/DomainError"},"type":"array"},{"type":"null"}],"title":"warnings","description":"Warnings for this response"}},"type":"object","required":["meta"],"title":"SingleResponse[AdGroupV2]"},"Target":{"properties":{"type":{"anyOf":[{"type":"string"},{"type":"integer"}],"title":"type","description":"Type id of the adgroup target. 1 - Placement, 2 - Division, 3 - Day Parting"},"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"id","description":"Id to use for the adgroup target. For placement targets, this should be the placement id. For division targets, this should be division id."},"values":{"anyOf":[{"items":{"type":"integer"},"type":"array"},{"type":"null"}],"title":"values","description":"Values to use for the adgroup target. For day parting targets, this should be a list of two values, which are start and end hours (1 - 24) in the EST timezone."}},"type":"object","required":["type"],"title":"Target"},"UpstreamValidationWarning":{"properties":{"detail":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"detail","description":"Details about the validation warnings."},"path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"path","description":"JSON path to the field with a validation warning."}},"type":"object","title":"UpstreamValidationWarning"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"Warnings":{"properties":{"validation":{"anyOf":[{"items":{"$ref":"#/components/schemas/UpstreamValidationWarning"},"type":"array"},{"type":"null"}],"title":"validation","description":"List of validation warnings."}},"type":"object","title":"Warnings"}}}}
```