Class SponsoredProductsCampaignOperation

Hierarchy

Operation
- SponsoredProductsCampaignOperation

Index

Constructors

Methods

archiveCampaign createCampaigns getCampaign getCampaignExtended listCampaigns listCampaignsExtended updateCampaigns create

Constructors

constructor

new SponsoredProductsCampaignOperation(client: HttpClient): SponsoredProductsCampaignOperation
Parameters
- client: HttpClient
Returns SponsoredProductsCampaignOperation
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 }>
Sets the campaign status to archived. Archived entities cannot be made active again. See developer notes for more information.

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

createCampaigns

createCampaigns(campaigns: ({ campaignType: undefined | "sponsoredProducts"; dailyBudget: number; name: string; startDate: string; state: "paused" | "enabled" | "archived"; targetingType: "auto" | "manual" } & { bidding: undefined | { adjustments: (({ predicate: "placementTop" | "placementProductPage"; }) & ({ percentage?: number | undefined; }))[] } & ({ strategy?: "manual" | "legacyForSales" | "autoForSales" | "ruleBased" | undefined; }) })[]): Promise<({ code: string } & { campaignId: undefined | number; description: undefined | string; details: undefined | string })[]>
Creates one or more campaigns. Successfully created campaigns will be assigned a unique campaignId.

Returns
Parameters
- campaigns: ({ campaignType: undefined | "sponsoredProducts"; dailyBudget: number; name: string; startDate: string; state: "paused" | "enabled" | "archived"; targetingType: "auto" | "manual" } & { bidding: undefined | { adjustments: (({ predicate: "placementTop" | "placementProductPage"; }) & ({ percentage?: number | undefined; }))[] } & ({ strategy?: "manual" | "legacyForSales" | "autoForSales" | "ruleBased" | undefined; }) })[]
Returns Promise<({ code: string } & { campaignId: undefined | number; description: undefined | string; details: undefined | string })[]>
- Defined in src/operations/campaigns/sponsored-products-campaign-operation.ts:71

getCampaign

getCampaign(campaignId: number): Promise<{ campaignId: number; campaignType: undefined | "sponsoredProducts"; dailyBudget: number; name: string; startDate: string; state: "paused" | "enabled" | "archived"; targetingType: "auto" | "manual" } & { bidding: undefined | { adjustments: (({ predicate: "placementTop" | "placementProductPage"; }) & ({ percentage?: number | undefined; }))[] } & ({ strategy?: "manual" | "legacyForSales" | "autoForSales" | "ruleBased" | undefined; }); endDate: undefined | string; portfolioId: undefined | number; premiumBidAdjustment: undefined | boolean }>
Retrieves a campaign by campaignId. Note that this call returns the minimal set of campaign fields, but is more efficient than getCampaignEx

Returns
Parameters
- campaignId: number
Returns Promise<{ campaignId: number; campaignType: undefined | "sponsoredProducts"; dailyBudget: number; name: string; startDate: string; state: "paused" | "enabled" | "archived"; targetingType: "auto" | "manual" } & { bidding: undefined | { adjustments: (({ predicate: "placementTop" | "placementProductPage"; }) & ({ percentage?: number | undefined; }))[] } & ({ strategy?: "manual" | "legacyForSales" | "autoForSales" | "ruleBased" | undefined; }); endDate: undefined | string; portfolioId: undefined | number; premiumBidAdjustment: undefined | boolean }>
- Defined in src/operations/campaigns/sponsored-products-campaign-operation.ts:47

getCampaignExtended

getCampaignExtended(campaignId: number): Promise<{ campaignId: number; campaignType: undefined | "sponsoredProducts"; dailyBudget: number; name: string; startDate: string; state: "paused" | "enabled" | "archived"; targetingType: "auto" | "manual" } & { bidding: undefined | { adjustments: (({ predicate: "placementTop" | "placementProductPage"; }) & ({ percentage?: number | undefined; }))[] } & ({ strategy?: "manual" | "legacyForSales" | "autoForSales" | "ruleBased" | undefined; }); endDate: undefined | string; portfolioId: undefined | number; premiumBidAdjustment: undefined | boolean } & { creationDate: undefined | Date; lastUpdatedDate: undefined | Date; placement: undefined | "Top of Search on-Amazon" | "Other on-Amazon"; servingStatus: undefined | "CAMPAIGN_ARCHIVED" | "CAMPAIGN_PAUSED" | "CAMPAIGN_STATUS_ENABLED" | "ADVERTISER_PAYMENT_FAILURE" | "CAMPAIGN_OUT_OF_BUDGET" | "ACCOUNT_OUT_OF_BUDGET" | "PORTFOLIO_ENDED" | "CAMPAIGN_INCOMPLETE" | "PENDING_START_DATE" | "ENDED" }>
Retrieves a campaign and its extended fields by campaignId. Note that this call returns the complete set of campaign fields (including serving status and other read-only fields), but is less efficient than getCampaign

Returns
Parameters
- campaignId: number
Returns Promise<{ campaignId: number; campaignType: undefined | "sponsoredProducts"; dailyBudget: number; name: string; startDate: string; state: "paused" | "enabled" | "archived"; targetingType: "auto" | "manual" } & { bidding: undefined | { adjustments: (({ predicate: "placementTop" | "placementProductPage"; }) & ({ percentage?: number | undefined; }))[] } & ({ strategy?: "manual" | "legacyForSales" | "autoForSales" | "ruleBased" | undefined; }); endDate: undefined | string; portfolioId: undefined | number; premiumBidAdjustment: undefined | boolean } & { creationDate: undefined | Date; lastUpdatedDate: undefined | Date; placement: undefined | "Top of Search on-Amazon" | "Other on-Amazon"; servingStatus: undefined | "CAMPAIGN_ARCHIVED" | "CAMPAIGN_PAUSED" | "CAMPAIGN_STATUS_ENABLED" | "ADVERTISER_PAYMENT_FAILURE" | "CAMPAIGN_OUT_OF_BUDGET" | "ACCOUNT_OUT_OF_BUDGET" | "PORTFOLIO_ENDED" | "CAMPAIGN_INCOMPLETE" | "PENDING_START_DATE" | "ENDED" }>
- Defined in src/operations/campaigns/sponsored-products-campaign-operation.ts:59

listCampaigns

listCampaigns(params?: { count: undefined | number; startIndex: undefined | number } & { campaignIdFilter: undefined | number[]; name: undefined | string; stateFilter: undefined | "paused" | "enabled" | "archived" }): Promise<({ campaignId: number; campaignType: undefined | "sponsoredProducts"; dailyBudget: number; name: string; startDate: string; state: "paused" | "enabled" | "archived"; targetingType: "auto" | "manual" } & { bidding: undefined | { adjustments: (({ predicate: "placementTop" | "placementProductPage"; }) & ({ percentage?: number | undefined; }))[] } & ({ strategy?: "manual" | "legacyForSales" | "autoForSales" | "ruleBased" | undefined; }); endDate: undefined | string; portfolioId: undefined | number; premiumBidAdjustment: undefined | boolean })[]>
Retrieves a list of Sponsored Products campaigns satisfying optional filtering criteria.

Returns
Parameters
- Optional params: { count: undefined | number; startIndex: undefined | number } & { campaignIdFilter: undefined | number[]; name: undefined | string; stateFilter: undefined | "paused" | "enabled" | "archived" }
Returns Promise<({ campaignId: number; campaignType: undefined | "sponsoredProducts"; dailyBudget: number; name: string; startDate: string; state: "paused" | "enabled" | "archived"; targetingType: "auto" | "manual" } & { bidding: undefined | { adjustments: (({ predicate: "placementTop" | "placementProductPage"; }) & ({ percentage?: number | undefined; }))[] } & ({ strategy?: "manual" | "legacyForSales" | "autoForSales" | "ruleBased" | undefined; }); endDate: undefined | string; portfolioId: undefined | number; premiumBidAdjustment: undefined | boolean })[]>
- Defined in src/operations/campaigns/sponsored-products-campaign-operation.ts:24

listCampaignsExtended

listCampaignsExtended(params?: { count: undefined | number; startIndex: undefined | number } & { campaignIdFilter: undefined | number[]; name: undefined | string; stateFilter: undefined | "paused" | "enabled" | "archived" }): Promise<({ campaignId: number; campaignType: undefined | "sponsoredProducts"; dailyBudget: number; name: string; startDate: string; state: "paused" | "enabled" | "archived"; targetingType: "auto" | "manual" } & { bidding: undefined | { adjustments: (({ predicate: "placementTop" | "placementProductPage"; }) & ({ percentage?: number | undefined; }))[] } & ({ strategy?: "manual" | "legacyForSales" | "autoForSales" | "ruleBased" | undefined; }); endDate: undefined | string; portfolioId: undefined | number; premiumBidAdjustment: undefined | boolean } & { creationDate: undefined | Date; lastUpdatedDate: undefined | Date; placement: undefined | "Top of Search on-Amazon" | "Other on-Amazon"; servingStatus: undefined | "CAMPAIGN_ARCHIVED" | "CAMPAIGN_PAUSED" | "CAMPAIGN_STATUS_ENABLED" | "ADVERTISER_PAYMENT_FAILURE" | "CAMPAIGN_OUT_OF_BUDGET" | "ACCOUNT_OUT_OF_BUDGET" | "PORTFOLIO_ENDED" | "CAMPAIGN_INCOMPLETE" | "PENDING_START_DATE" | "ENDED" })[]>
Retrieves a list of Sponsored Products campaigns with extended fields satisfying optional filtering criteria.

Returns
Parameters
- Optional params: { count: undefined | number; startIndex: undefined | number } & { campaignIdFilter: undefined | number[]; name: undefined | string; stateFilter: undefined | "paused" | "enabled" | "archived" }
Returns Promise<({ campaignId: number; campaignType: undefined | "sponsoredProducts"; dailyBudget: number; name: string; startDate: string; state: "paused" | "enabled" | "archived"; targetingType: "auto" | "manual" } & { bidding: undefined | { adjustments: (({ predicate: "placementTop" | "placementProductPage"; }) & ({ percentage?: number | undefined; }))[] } & ({ strategy?: "manual" | "legacyForSales" | "autoForSales" | "ruleBased" | undefined; }); endDate: undefined | string; portfolioId: undefined | number; premiumBidAdjustment: undefined | boolean } & { creationDate: undefined | Date; lastUpdatedDate: undefined | Date; placement: undefined | "Top of Search on-Amazon" | "Other on-Amazon"; servingStatus: undefined | "CAMPAIGN_ARCHIVED" | "CAMPAIGN_PAUSED" | "CAMPAIGN_STATUS_ENABLED" | "ADVERTISER_PAYMENT_FAILURE" | "CAMPAIGN_OUT_OF_BUDGET" | "ACCOUNT_OUT_OF_BUDGET" | "PORTFOLIO_ENDED" | "CAMPAIGN_INCOMPLETE" | "PENDING_START_DATE" | "ENDED" })[]>
- Defined in src/operations/campaigns/sponsored-products-campaign-operation.ts:35

updateCampaigns

updateCampaigns(campaigns: ({ campaignId: number } & { bidding: undefined | { adjustments: (({ predicate: "placementTop" | "placementProductPage"; }) & ({ percentage?: number | undefined; }))[] } & ({ strategy?: "manual" | "legacyForSales" | "autoForSales" | "ruleBased" | undefined; }); dailyBudget: undefined | number; endDate: undefined | string; name: undefined | string; portfolioId: undefined | number; premiumBidAdjustment: undefined | boolean; startDate: undefined | string; 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 } & { bidding: undefined | { adjustments: (({ predicate: "placementTop" | "placementProductPage"; }) & ({ percentage?: number | undefined; }))[] } & ({ strategy?: "manual" | "legacyForSales" | "autoForSales" | "ruleBased" | undefined; }); dailyBudget: undefined | number; endDate: undefined | string; name: undefined | string; portfolioId: undefined | number; premiumBidAdjustment: undefined | boolean; startDate: undefined | string; state: undefined | "paused" | "enabled" | "archived" })[]
Returns Promise<({ code: string } & { campaignId: undefined | number; description: undefined | string; details: undefined | string })[]>
- Defined in src/operations/campaigns/sponsored-products-campaign-operation.ts:82

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

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: HttpClient

Returns SponsoredProductsCampaignOperation

Methods

archiveCampaign

Returns

Parameters

campaignId: number

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

createCampaigns

Returns

Parameters

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

getCampaign

Returns

Parameters

campaignId: number

getCampaignExtended

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" }

listCampaignsExtended

Returns

Parameters

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

updateCampaigns

Returns

Parameters

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" }

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

`Static` create