Search
K
Kroger Ad Platform API

AdGroupV2

object
adGroupIdAny Of

Id that identified the Ad Group.

Variant 1integer
campaignIdAny Of

The campaign id associated with this ad group.

Variant 1integer
nameAny Of

The ad group name.

Variant 1string
startDateAny Of

The start date of the ad group.

Default:

Variant 1string
endDateAny Of

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.

Variant 1string
budgetTypeAny Of

The type of budget.

BudgetTypestring

Allowed values:DAILYWEEKLYMONTHLYLIFETIME

budgetAmountAny Of

The budget of the ad group. The sum of all the budgets from the ad group(s) may not exceed the campaign budget.

Variant 1number
statusAny Of

The status of the ad group.

Variant 1string
baseBidAny Of

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.

Variant 1number
entitiesarray[object]required

The products to be advertised.

Show Child Parameters
targetsarray[object]required

The target dimensions for this ad group. Includes placements, divisions, and day parting.

Show Child Parameters
keywordBidModifiersAny Of

Adjustments to keyword bids.

KeywordBidModifierarray[object]
Show Child Parameters
isArchivedAny Of

Whether this ad group is archived.

Variant 1boolean
carouselHeadlineAny Of

This headline is displayed above the product cards to differentiate your Carousel from other listings

Variant 1string
carouselSubtextAny Of

Add subtext to carousel ad group.

Variant 1string
Example

Advertiser

object
idinteger

The id of the advertiser.

Default:0

namestring

The name of the advertiser.

Default:

accountIdinteger

The account id of the advertiser.

Default:0

descriptionstring

The description of the advertiser.

Default:

activeboolean

Whether the advertiser is active.

Default:true

Example

AdvertiserAddress

object
idinteger

Id of the address.

Default:0

companyNamestring

The name of the company the address is for.

Default:

addressLine1string

The first line of the address.

Default:

addressLine2string

The second line of the address.

Default:

citystring

The city of the address.

Default:

statestring

The state of the address.

Default:

postalCodestring

The postal code of the address.

Default:

countrystring

The country of the address.

Default:

addressTypestring

Allowed values:CPGAGENCY

activeboolean

Whether the address is active or not.

Default:true

Example

AdvertiserAddressResponse

object
dataarray[object]required

List of Addresses.

Show Child Parameters
metaobjectrequired
Show Child Parameters
Example

AdvertiserContact

object
idinteger

Id of this contact.

Default:0

firstNamestring

First name of this contact.

Default:

lastNamestring

Last name of this contact.

Default:

emailstring

Email address of this contact.

Default:

contactTypestring

Allowed values:CPGAGENCY

activeboolean

Whether this contact is active or not.

Default:true

accountIdsarray[string]

List of account ids this contact belongs to.

Example