Search
K
Kroger Ad Platform API

CreateEntitiesRequest

object
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.

Example

DomainError

object
domainstringrequired

Type of object related to this error

Allowed values:ad_groupcampaignentitykeywordsub_commodity

idAny Of

Id of the object related to this error

Variant 1integer
fieldNamestringrequired

Name of the field in the object that has an error

codestringrequired

Generic error code

reasonstringrequired

Human readable reason for the error

datetimeobjectrequired

Time the error occurred

Show Child Parameters
rootCausesAny Of

Root causes for this error

DomainErrorarray[object]
Show Child Parameters
Example

DomainType

string

Allowed values:ad_groupcampaignentitykeywordsub_commodity

Entity

object
idintegerrequired

Entity id

subCommodityIdAny Of

Sub commodity id

Variant 1string
useBaseBidbooleanrequired

Whether to use base bid.

bidAmountAny Of

Bid amount for this entity.

Variant 1number
deletedbooleanrequired

Whether this entity is deleted.

Example

EntityMeta

object
successbooleanrequired

Whether the entity request was successful.

messageAny Of

Error message if the request was not successful.

Variant 1string
codeAny Of

Error code if the request was not successful.

Variant 1integer
publishStatusAny Of

Publish status of the entity.

PublishStatusstring

Allowed values:EMPTYPENDINGFAILEDPUBLISHED

errorsAny Of

List of errors if the request was not successful.

Default:[]

Variant 1array[object]
* Additional properties are allowed.
warningsAny Of

Upstream validation warnings.

Warningsobject
Show Child Parameters
Example