Search
K
Kroger Ad Platform API

CampaignRemainingBudgetResponse

object
remainingBudgetAmountstringrequired

The budget amount remaining for the campaign.

Match pattern:^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Example

CampaignRequest

object
namestringrequired

The campaign name.

statusstringrequired

Allowed values:DRAFTSCHEDULEDACTIVEENDEDPAUSED

startDatestringrequired

The start date of the campaign. Format: YYYY-MM-DD

Match pattern:\d{4}-\d{2}-\d{2}

endDateAny Of

The end date of the campaign. Must be after start date. If null the campaign is considered “always-on”. Cannot be null if budget type is LIFETIME

Default:

Variant 1string

Match pattern:\d{4}-\d{2}-\d{2}

budgetAmountnumberrequired

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

>= 1

budgetTypestringrequired

Allowed values:DAILYWEEKLYMONTHLYLIFETIME

pacingTypestringrequired

Allowed values:EVENASAPAHEAD

accountIdintegerrequired

Id from the Account entity.

advertiserIdsarray[integer]required

Ids from the Advertiser entities associated with the account.

billingInsertionOrderAny Of

Insertion order number for this campaign.

Variant 1string
billingPurchaseOrderAny Of

Purchase order number for this campaign.

Variant 1string
billingAdditionalDetailsAny Of

Notes that the advertiser wants to notify the billing department.

Variant 1string
billingContactIdintegerrequired

Id from the Contact entity associated with the account.

billingAddressIdintegerrequired

Id from the Address entity associated with the account.

campaignTypeAny Of

Type for this campaign.

Default:PLA

CampaignTypestring

Allowed values:PLATOACAROUSEL

goalsarray[object]

Goals data associated with the campaign.

Show Child Parameters
Example

CampaignStatus

string

Allowed values:DRAFTSCHEDULEDACTIVEENDEDPAUSED

CampaignType

string

Allowed values:PLATOACAROUSEL

Division

object
idinteger

Id of the division

Default:0

namestring

Name of the division

Default:

activeboolean

Whether the division is active

Default:true

Example