Class SponsoredBrandsDraftsOperation

Hierarchy

Operation
- SponsoredBrandsDraftsOperation

Index

Constructors

Methods

archiveDraftCampaign createDraftCampaigns getDraftCampaign listDraftCampaigns submitDraftCampaigns updateDraftCampaigns create

Constructors

constructor

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

Methods

archiveDraftCampaign

archiveDraftCampaign(draftCampaignId: number): Promise<{ code: undefined | string; details: undefined | string; draftCampaignId: undefined | number; keywordResponses: undefined | ({ code: string; keywordId: number } & ({ details?: string | undefined; }))[] }>
Archives a draft campaign specified by identifier.

Returns
Parameters
- draftCampaignId: number
Returns Promise<{ code: undefined | string; details: undefined | string; draftCampaignId: undefined | number; keywordResponses: undefined | ({ code: string; keywordId: number } & ({ details?: string | undefined; }))[] }>
- Defined in src/operations/drafts/sponsored-brands-drafts-operation.ts:66

createDraftCampaigns

createDraftCampaigns(params: ({ brandEntityId: undefined | string; draftCampaignId: undefined | number } & { bidMultiplier: number; bidOptimization: boolean; budget: number; budgetType: "lifetime" | "daily"; creative: { brandName: string; brandLogoAssetID: string; brandLogoUrl: string; headline: string; asins: string[]; shouldOptimizeAsins: boolean; }; endDate: string; landingPage: { asins: undefined | string[] } & ({ url: string; }); name: string; portfolioId: number; startDate: string } & { keywords: ({ keywordText: string; matchType: "exact" | "broad" | "phrase"; bid: number; })[]; negativeKeywords: ({ keywordText: string; matchType: "negativeExact" | "negativePhrase"; })[] })[]): Promise<{ code: undefined | string; details: undefined | string; draftCampaignId: undefined | number; keywordResponses: undefined | ({ code: string; keywordId: number } & ({ details?: string | undefined; }))[] }[]>
Creates one or more new draft campaigns.

Returns
Parameters
- params: ({ brandEntityId: undefined | string; draftCampaignId: undefined | number } & { bidMultiplier: number; bidOptimization: boolean; budget: number; budgetType: "lifetime" | "daily"; creative: { brandName: string; brandLogoAssetID: string; brandLogoUrl: string; headline: string; asins: string[]; shouldOptimizeAsins: boolean; }; endDate: string; landingPage: { asins: undefined | string[] } & ({ url: string; }); name: string; portfolioId: number; startDate: string } & { keywords: ({ keywordText: string; matchType: "exact" | "broad" | "phrase"; bid: number; })[]; negativeKeywords: ({ keywordText: string; matchType: "negativeExact" | "negativePhrase"; })[] })[]
Returns Promise<{ code: undefined | string; details: undefined | string; draftCampaignId: undefined | number; keywordResponses: undefined | ({ code: string; keywordId: number } & ({ details?: string | undefined; }))[] }[]>
- Defined in src/operations/drafts/sponsored-brands-drafts-operation.ts:33

getDraftCampaign

getDraftCampaign(draftCampaignId: number): Promise<{ brandEntityId: undefined | string; draftCampaignId: undefined | number } & { bidMultiplier: number; bidOptimization: boolean; budget: number; budgetType: "lifetime" | "daily"; creative: { brandName: string; brandLogoAssetID: string; brandLogoUrl: string; headline: string; asins: string[]; shouldOptimizeAsins: boolean; }; endDate: string; landingPage: { asins: undefined | string[] } & ({ url: string; }); name: string; portfolioId: number; startDate: string } & { keywords: ({ keywordText: string; matchType: "exact" | "broad" | "phrase"; bid: number; })[]; negativeKeywords: ({ keywordText: string; matchType: "negativeExact" | "negativePhrase"; })[] }>
Gets a draft campaign specified by identifier.

Returns
Parameters
- draftCampaignId: number
Returns Promise<{ brandEntityId: undefined | string; draftCampaignId: undefined | number } & { bidMultiplier: number; bidOptimization: boolean; budget: number; budgetType: "lifetime" | "daily"; creative: { brandName: string; brandLogoAssetID: string; brandLogoUrl: string; headline: string; asins: string[]; shouldOptimizeAsins: boolean; }; endDate: string; landingPage: { asins: undefined | string[] } & ({ url: string; }); name: string; portfolioId: number; startDate: string } & { keywords: ({ keywordText: string; matchType: "exact" | "broad" | "phrase"; bid: number; })[]; negativeKeywords: ({ keywordText: string; matchType: "negativeExact" | "negativePhrase"; })[] }>
- Defined in src/operations/drafts/sponsored-brands-drafts-operation.ts:55

listDraftCampaigns

listDraftCampaigns(params: { count: undefined | number; startIndex: undefined | number } & { draftCampaignIdFilter: undefined | number; name: undefined | string; portfolioIdFilter: undefined | number }): Promise<({ brandEntityId: undefined | string; draftCampaignId: undefined | number } & { bidMultiplier: number; bidOptimization: boolean; budget: number; budgetType: "lifetime" | "daily"; creative: { brandName: string; brandLogoAssetID: string; brandLogoUrl: string; headline: string; asins: string[]; shouldOptimizeAsins: boolean; }; endDate: string; landingPage: { asins: undefined | string[] } & ({ url: string; }); name: string; portfolioId: number; startDate: string })[]>
Gets an array of draft campaign objects.

Returns
Parameters
- params: { count: undefined | number; startIndex: undefined | number } & { draftCampaignIdFilter: undefined | number; name: undefined | string; portfolioIdFilter: undefined | number }
Returns Promise<({ brandEntityId: undefined | string; draftCampaignId: undefined | number } & { bidMultiplier: number; bidOptimization: boolean; budget: number; budgetType: "lifetime" | "daily"; creative: { brandName: string; brandLogoAssetID: string; brandLogoUrl: string; headline: string; asins: string[]; shouldOptimizeAsins: boolean; }; endDate: string; landingPage: { asins: undefined | string[] } & ({ url: string; }); name: string; portfolioId: number; startDate: string })[]>
- Defined in src/operations/drafts/sponsored-brands-drafts-operation.ts:22

submitDraftCampaigns

submitDraftCampaigns(draftCampaignIds: number[]): Promise<{ code: undefined | string; details: undefined | string; draftCampaignId: undefined | number; keywordResponses: undefined | ({ code: string; keywordId: number } & ({ details?: string | undefined; }))[] }[]>
Submits one or more existing draft campaigns to the moderation approval queue.

Returns
Parameters
- draftCampaignIds: number[]
Returns Promise<{ code: undefined | string; details: undefined | string; draftCampaignId: undefined | number; keywordResponses: undefined | ({ code: string; keywordId: number } & ({ details?: string | undefined; }))[] }[]>
- Defined in src/operations/drafts/sponsored-brands-drafts-operation.ts:79

updateDraftCampaigns

updateDraftCampaigns(params: ({ brandEntityId: undefined | string; draftCampaignId: undefined | number } & { bidMultiplier: number; bidOptimization: boolean; budget: number; budgetType: "lifetime" | "daily"; creative: { brandName: string; brandLogoAssetID: string; brandLogoUrl: string; headline: string; asins: string[]; shouldOptimizeAsins: boolean; }; endDate: string; landingPage: { asins: undefined | string[] } & ({ url: string; }); name: string; portfolioId: number; startDate: string } & { keywords: ({ keywordText: string; matchType: "exact" | "broad" | "phrase"; bid: number; })[]; negativeKeywords: ({ keywordText: string; matchType: "negativeExact" | "negativePhrase"; })[] })[]): Promise<{ code: undefined | string; details: undefined | string; draftCampaignId: undefined | number; keywordResponses: undefined | ({ code: string; keywordId: number } & ({ details?: string | undefined; }))[] }[]>
Updates one or more draft campaigns.

Returns
Parameters
- params: ({ brandEntityId: undefined | string; draftCampaignId: undefined | number } & { bidMultiplier: number; bidOptimization: boolean; budget: number; budgetType: "lifetime" | "daily"; creative: { brandName: string; brandLogoAssetID: string; brandLogoUrl: string; headline: string; asins: string[]; shouldOptimizeAsins: boolean; }; endDate: string; landingPage: { asins: undefined | string[] } & ({ url: string; }); name: string; portfolioId: number; startDate: string } & { keywords: ({ keywordText: string; matchType: "exact" | "broad" | "phrase"; bid: number; })[]; negativeKeywords: ({ keywordText: string; matchType: "negativeExact" | "negativePhrase"; })[] })[]
Returns Promise<{ code: undefined | string; details: undefined | string; draftCampaignId: undefined | number; keywordResponses: undefined | ({ code: string; keywordId: number } & ({ details?: string | undefined; }))[] }[]>
- Defined in src/operations/drafts/sponsored-brands-drafts-operation.ts:44

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

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: HttpClient

Returns SponsoredBrandsDraftsOperation

Methods

archiveDraftCampaign

Returns

Parameters

draftCampaignId: number

Returns Promise<{ code: undefined | string; details: undefined | string; draftCampaignId: undefined | number; keywordResponses: undefined | ({ code: string; keywordId: number } & ({ details?: string | undefined; }))[] }>

createDraftCampaigns

Returns

Parameters

Returns Promise<{ code: undefined | string; details: undefined | string; draftCampaignId: undefined | number; keywordResponses: undefined | ({ code: string; keywordId: number } & ({ details?: string | undefined; }))[] }[]>

getDraftCampaign

Returns

Parameters

draftCampaignId: number

listDraftCampaigns

Returns

Parameters

params: { count: undefined | number; startIndex: undefined | number } & { draftCampaignIdFilter: undefined | number; name: undefined | string; portfolioIdFilter: undefined | number }

submitDraftCampaigns

Returns

Parameters

draftCampaignIds: number[]

Returns Promise<{ code: undefined | string; details: undefined | string; draftCampaignId: undefined | number; keywordResponses: undefined | ({ code: string; keywordId: number } & ({ details?: string | undefined; }))[] }[]>

updateDraftCampaigns

Returns

Parameters

Returns Promise<{ code: undefined | string; details: undefined | string; draftCampaignId: undefined | number; keywordResponses: undefined | ({ code: string; keywordId: number } & ({ details?: string | undefined; }))[] }[]>

Static create

Type Parameters

T extends typeof Operation

Parameters

this: T

httpClient: HttpClient

Returns InstanceType<T>

Settings

Member Visibility

Theme

`Static` create