Kroger Ad Platform API

Kroger Ad Platform API

1OAS 3.1

Read more about KAP API in our Media Platform Learning Center.

API Base URL
  • Server 1:/v1

Create Ad Group Entities

Add entities to an Ad Group in the Media Platform. Read more about Ad groups in our Media Platform Learning Center.

post
/v1/ad_groups/{ad_group_id}/entities

Path Parameters

ad_group_idintegerrequired

Body

application/json

CreateEntitiesRequest

entitiesarray[object]required

The products to be advertised.

Show Child Parameters
baseBidnumberrequired

The base bid used for all entities that have useBaseBid set to true.

Response

application/json

Successful Response

SingleResponse[AdGroupV2]

dataAny Of

Data of the response.

AdGroupV2object
Show Child Parameters
metaobjectrequired

Response metadata.

Show Child Parameters
errorsAny Of

Errors for this response

DomainErrorarray[object]
Show Child Parameters
warningsAny Of

Warnings for this response

DomainErrorarray[object]
Show Child Parameters
post/ad_groups/{ad_group_id}/entities

Body

{ "entities": [ { "id": 0, "useBaseBid": false, "deleted": false } ], "baseBid": 0 }
 
Invalid URL value '/v1/ad_groups/0/entities'
- missing protocol
application/json

AdGroupStatus

string

Allowed values:DRAFTSCHEDULEDACTIVEENDEDPAUSEDFAILEDUNDER REVIEW