Kroger Ad Platform API

TargetAdgroupRequest

object
typeintegerrequired

Type id of the adgroup target. 1 - Placement, 2 - Division, 3 - Day Parting

idAny Of

Id to use for the adgroup target. For placement targets, this should be the placement id. For division targets, this should be division id.

Variant 1integer
valuesAny Of

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.

valuesarray[integer]
Example

Target

object
typestringrequired

Type id of the adgroup target. 1 - Placement, 2 - Division, 3 - Day Parting.

idAny Of

Id to use for the adgroup target. For placement targets, this should be the placement id. For division targets, this should be division id.

Variant 1integer
valuesAny Of

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.

Variant 1array[integer]
Example

CreateAdGroupLegacyRequestV2

object
campaignIdintegerrequired

The campaign id associated with this ad group.

Default:0

namestringrequired

The ad group name.

Default:

>= 1 characters

startDatestringrequired

The start date of the ad group.

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.

Default:

Variant 1string
budgetAmountnumberrequired

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

Default:0

statusstringrequired

Allowed values:DRAFTSCHEDULEDACTIVEENDEDPAUSEDFAILEDUNDER REVIEW

baseBidnumberrequired

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.

Default:0

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

CreateAdGroupRequest

object
* Additional properties are NOT allowed.
campaignIdintegerrequired

The campaign id associated with this ad group.

Default:0

namestringrequired

The ad group name.

Default:

>= 1 characters

startDatestringrequired

The start date of the ad group.

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.

Default:

Variant 1string
budgetAmountnumberrequired

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

Default:0

statusstringrequired

Allowed values:DRAFTSCHEDULEDACTIVEENDEDPAUSEDFAILEDUNDER REVIEW

targetsarray[object]required

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

Show Child Parameters
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