Class SponsoredBrandsCampaignOperation

Hierarchy

Operation
- SponsoredBrandsCampaignOperation

Index

Constructors

constructor

Methods

archiveCampaign createCampaigns getCampaign listCampaigns updateCampaigns create

Constructors

constructor

new SponsoredBrandsCampaignOperation(client: HttpClient): SponsoredBrandsCampaignOperation
Parameters
- client: HttpClient
Returns SponsoredBrandsCampaignOperation
Inherited from Operation.constructor
- Defined in src/operations/operation.ts:25

Methods

archiveCampaign

archiveCampaign(campaignId: number): Promise<{ code: string } & { campaignId: undefined | number; description: undefined | string; details: undefined | string }>
Archives a campaign specified by identifier.

Returns
Parameters
- campaignId: number
Returns Promise<{ code: string } & { campaignId: undefined | number; description: undefined | string; details: undefined | string }>
- Defined in src/operations/campaigns/sponsored-brands-campaign-operation.ts:67

createCampaigns

createCampaigns(campaigns: { dailyBudget: number; name: string; startDate: string; state: "paused" | "enabled" | "archived"; targetingType: "auto" | "manual" }[]): Promise<({ code: string } & { campaignId: undefined | number; description: undefined | string; details: undefined | string })[]>
Creates one or more new Campaigns

Returns
Parameters
- campaigns: { dailyBudget: number; name: string; startDate: string; state: "paused" | "enabled" | "archived"; targetingType: "auto" | "manual" }[]
Returns Promise<({ code: string } & { campaignId: undefined | number; description: undefined | string; details: undefined | string })[]>
- Defined in src/operations/campaigns/sponsored-brands-campaign-operation.ts:45

getCampaign

getCampaign(campaignId: number): Promise<{ budget: number; budgetType: "lifetime" | "daily"; campaignId: number; landingPage: undefined | ({ pageType: "store" | "detailPage"; url: string; }); name: string; servingStatus: Readonly<"paused" | "running" | "ended" | "rejected" | "asinNotBuyable" | "billingError" | "landingPageNotAvailable" | "outOfBudget" | "pendingReview" | "ready" | "scheduled" | "terminated" | "portfolioEnded">; startDate: string; state: "paused" | "enabled" | "archived" } & { bidMultiplier: undefined | number; bidOptimization: undefined | boolean; brandEntityId: undefined | string; creative: undefined | { asins: string[] } & ({ headline?: string | undefined; brandLogoUrl?: string | undefined; brandName?: string | undefined; brandLogoAssetID?: string | undefined; }); endDate: undefined | string; keywords: undefined | { keywordText: string; matchType: "exact" | "broad" | "phrase" } & ({ bid?: number | undefined; }); portfolioId: undefined | number }>
Gets a campaign specified by identifier

Returns
Parameters
- campaignId: number
Returns Promise<{ budget: number; budgetType: "lifetime" | "daily"; campaignId: number; landingPage: undefined | ({ pageType: "store" | "detailPage"; url: string; }); name: string; servingStatus: Readonly<"paused" | "running" | "ended" | "rejected" | "asinNotBuyable" | "billingError" | "landingPageNotAvailable" | "outOfBudget" | "pendingReview" | "ready" | "scheduled" | "terminated" | "portfolioEnded">; startDate: string; state: "paused" | "enabled" | "archived" } & { bidMultiplier: undefined | number; bidOptimization: undefined | boolean; brandEntityId: undefined | string; creative: undefined | { asins: string[] } & ({ headline?: string | undefined; brandLogoUrl?: string | undefined; brandName?: string | undefined; brandLogoAssetID?: string | undefined; }); endDate: undefined | string; keywords: undefined | { keywordText: string; matchType: "exact" | "broad" | "phrase" } & ({ bid?: number | undefined; }); portfolioId: undefined | number }>
- Defined in src/operations/campaigns/sponsored-brands-campaign-operation.ts:23

listCampaigns

listCampaigns(params?: { count: undefined | number; startIndex: undefined | number } & { campaignIdFilter: undefined | number[]; name: undefined | string; stateFilter: undefined | "paused" | "enabled" | "archived" }): Promise<({ budget: number; budgetType: "lifetime" | "daily"; campaignId: number; landingPage: undefined | ({ pageType: "store" | "detailPage"; url: string; }); name: string; servingStatus: Readonly<"paused" | "running" | "ended" | "rejected" | "asinNotBuyable" | "billingError" | "landingPageNotAvailable" | "outOfBudget" | "pendingReview" | "ready" | "scheduled" | "terminated" | "portfolioEnded">; startDate: string; state: "paused" | "enabled" | "archived" } & { bidMultiplier: undefined | number; bidOptimization: undefined | boolean; brandEntityId: undefined | string; creative: undefined | { asins: string[] } & ({ headline?: string | undefined; brandLogoUrl?: string | undefined; brandName?: string | undefined; brandLogoAssetID?: string | undefined; }); endDate: undefined | string; keywords: undefined | { keywordText: string; matchType: "exact" | "broad" | "phrase" } & ({ bid?: number | undefined; }); portfolioId: undefined | number })[]>
Gets an array of all campaigns associated with the client identifier passed in the authorization header, filtered by specified criteria.

Returns
Parameters
- Optional params: { count: undefined | number; startIndex: undefined | number } & { campaignIdFilter: undefined | number[]; name: undefined | string; stateFilter: undefined | "paused" | "enabled" | "archived" }
Returns Promise<({ budget: number; budgetType: "lifetime" | "daily"; campaignId: number; landingPage: undefined | ({ pageType: "store" | "detailPage"; url: string; }); name: string; servingStatus: Readonly<"paused" | "running" | "ended" | "rejected" | "asinNotBuyable" | "billingError" | "landingPageNotAvailable" | "outOfBudget" | "pendingReview" | "ready" | "scheduled" | "terminated" | "portfolioEnded">; startDate: string; state: "paused" | "enabled" | "archived" } & { bidMultiplier: undefined | number; bidOptimization: undefined | boolean; brandEntityId: undefined | string; creative: undefined | { asins: string[] } & ({ headline?: string | undefined; brandLogoUrl?: string | undefined; brandName?: string | undefined; brandLogoAssetID?: string | undefined; }); endDate: undefined | string; keywords: undefined | { keywordText: string; matchType: "exact" | "broad" | "phrase" } & ({ bid?: number | undefined; }); portfolioId: undefined | number })[]>
- Defined in src/operations/campaigns/sponsored-brands-campaign-operation.ts:34

updateCampaigns

updateCampaigns(campaigns: ({ campaignId: number } & { bidMultiplier: undefined | number; bidOptimization: undefined | boolean; budget: undefined | number; endDate: undefined | string; portfolioId: undefined | number; state: undefined | "paused" | "enabled" | "archived" })[]): Promise<({ code: string } & { campaignId: undefined | number; description: undefined | string; details: undefined | string })[]>
Updates one or more campaigns.

Returns
Parameters
- campaigns: ({ campaignId: number } & { bidMultiplier: undefined | number; bidOptimization: undefined | boolean; budget: undefined | number; endDate: undefined | string; portfolioId: undefined | number; state: undefined | "paused" | "enabled" | "archived" })[]
Returns Promise<({ code: string } & { campaignId: undefined | number; description: undefined | string; details: undefined | string })[]>
- Defined in src/operations/campaigns/sponsored-brands-campaign-operation.ts:56

`Static` create

create<T>(this: T, httpClient: HttpClient): InstanceType<T>
Type Parameters
- T extends typeof Operation
Parameters
- this: T
- httpClient: HttpClient
Returns InstanceType<T>
Inherited from Operation.create
- Defined in src/operations/operation.ts:27

Class SponsoredBrandsCampaignOperation

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: HttpClient

Returns SponsoredBrandsCampaignOperation

Methods

archiveCampaign

Returns

Parameters

campaignId: number

Returns Promise<{ code: string } & { campaignId: undefined | number; description: undefined | string; details: undefined | string }>

createCampaigns

Returns

Parameters

campaigns: { dailyBudget: number; name: string; startDate: string; state: "paused" | "enabled" | "archived"; targetingType: "auto" | "manual" }[]

Returns Promise<({ code: string } & { campaignId: undefined | number; description: undefined | string; details: undefined | string })[]>

getCampaign

Returns

Parameters

campaignId: number

listCampaigns

Returns

Parameters

Optional params: { count: undefined | number; startIndex: undefined | number } & { campaignIdFilter: undefined | number[]; name: undefined | string; stateFilter: undefined | "paused" | "enabled" | "archived" }

updateCampaigns

Returns

Parameters

campaigns: ({ campaignId: number } & { bidMultiplier: undefined | number; bidOptimization: undefined | boolean; budget: undefined | number; endDate: undefined | string; portfolioId: undefined | number; state: undefined | "paused" | "enabled" | "archived" })[]

Returns Promise<({ code: string } & { campaignId: undefined | number; description: undefined | string; details: undefined | string })[]>

Static create

Type Parameters

T extends typeof Operation

Parameters

this: T

httpClient: HttpClient

Returns InstanceType<T>

Settings

Member Visibility

Theme

`Optional` params: { count: undefined | number; startIndex: undefined | number } & { campaignIdFilter: undefined | number[]; name: undefined | string; stateFilter: undefined | "paused" | "enabled" | "archived" }

`Static` create