Search
K
Kroger Ad Platform API

Agency

object
idAny Of

The id of the agency.

Default:

Variant 1string
nameAny Of

The name of the agency.

Default:

Variant 1string
accountIdAny Of

The id of the account.

Default:0

Variant 1integer
Example

AgencyResponse

object
dataarray[object]required

List of agencies

Show Child Parameters
metaobjectrequired
Show Child Parameters
Example

BudgetType

string

Allowed values:DAILYWEEKLYMONTHLYLIFETIME

Campaign

object
idintegerrequired

The campaign id.

nameAny Of

The campaign name.

Variant 1string
statusAny Of

The campaign status.

Variant 1string
campaignTypeAny Of

The campaign type.

Variant 1string
startDateAny Of

The campaign start date.

Variant 1string
endDateAny Of

The campaign end date.

Variant 1string
budgetAmountAny Of

The campaign budget amount.

Variant 1number
budgetTypeAny Of

The campaign budget type.

Variant 1string
pacingTypeAny Of

The campaign pacing type.

Variant 1string
accountIdintegerrequired

The account id.

advertiserIdsarray[integer]required

The advertiser ids.

billingInsertionOrderAny Of

The billing insertion order.

Variant 1string
billingPurchaseOrderAny Of

The billing purchase order.

Variant 1string
billingAdditionalDetailsAny Of

The billing additional details.

Default:

Variant 1string
billingContactIdAny Of

The billing contact id.

Variant 1integer
billingAddressIdAny Of

The billing address id.

Variant 1integer
adGroupsAny Of

The ad groups.

AdGrouparray[object]
Show Child Parameters
isArchivedAny Of

The campaign is archived.

Variant 1boolean
goalsarray[object]

Goals data associated with the campaign.

Show Child Parameters
Example

CampaignPutRequest

object
namestringrequired

The campaign name.

statusAny Of

The status of the campaign. Can not be changed at the same time as endDate. To cancel a scheduled campaign, set the status to PAUSE and set the end date to match the start date.

CampaignStatusstring

Allowed values:DRAFTSCHEDULEDACTIVEENDEDPAUSED

startDateAny Of

The start date of the campaign. Can only be changed when status is DRAFT. Can not be changed at the same time as status. Format: YYYY-MM-DD

Variant 1string

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

endDateAny Of

The end date of the campaign. Must be after start date. A live campaign can be stopped by setting end date to today’s 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

budgetTypeAny Of

The type of budget. Can only be changed when status is DRAFT.

BudgetTypestring

Allowed values:DAILYWEEKLYMONTHLYLIFETIME

pacingTypestringrequired

Allowed values:EVENASAPAHEAD

billingInsertionOrderAny Of

Insertion order number for this campaign. Can only be changed when status is DRAFT.

Variant 1string
billingPurchaseOrderAny Of

Purchase order number for this campaign. Can only be changed when status is DRAFT.

Variant 1string
billingAdditionalDetailsAny Of

Notes that the advertiser wants to notify the billing department.

Variant 1string
goalsarray[object]

Goals to be updated.

Show Child Parameters
Example