Search
K
Kroger Ad Platform API

Warnings

object
validationAny Of

List of validation warnings.

UpstreamValidationWarningarray[object]
Show Child Parameters
Example

AdGroupUpdateRequest

object
* Additional properties are NOT allowed.
nameAny Of

The ad group name.

Variant 1string

>= 1 characters

startDateAny Of

The start date of the ad group.

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.

Default:

Variant 1string
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.

AdGroupStatusstring

Allowed values:DRAFTSCHEDULEDACTIVEENDEDPAUSEDFAILEDUNDER REVIEW

targetsAny Of

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

TargetAdgroupRequestarray[object]
Show Child Parameters
keywordBidModifiersAny Of

Adjustments to keyword bids.

KeywordBidModifierarray[object]
Show Child Parameters
Example

AdGroupUpdateRequest

object
* Additional properties are NOT allowed.
nameAny Of

The ad group name.

Variant 1string

>= 1 characters

startDateAny Of

The start date of the ad group.

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.

Default:

Variant 1string
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.

AdGroupStatusstring

Allowed values:DRAFTSCHEDULEDACTIVEENDEDPAUSEDFAILEDUNDER REVIEW

targetsAny Of

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

TargetAdgroupRequestarray[object]
Show Child Parameters
keywordBidModifiersAny Of

Adjustments to keyword bids.

KeywordBidModifierarray[object]
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

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