Class SponsoredProductsProductAdsOperation

Hierarchy

Operation
- SponsoredProductsProductAdsOperation

Index

Constructors

Methods

archiveProductAd createProductAds getProductAd getProductAdExtended listProductAds listProductAdsExtended updateProductAds create

Constructors

constructor

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

Methods

archiveProductAd

archiveProductAd(adId: number): Promise<{ adId: undefined | number; code: undefined | string; details: undefined | string }>
Sets the product ad status to archived. This same operation can be performed via an update, but is included for completeness. Archived entities cannot be made active again. See developer notes for more information.

Returns
Parameters
- adId: number
Returns Promise<{ adId: undefined | number; code: undefined | string; details: undefined | string }>
- Defined in src/operations/product-ads/sponsored-products-product-ads-operation.ts:74

createProductAds

createProductAds(params: CreateProductAdsParams[]): Promise<{ adId: undefined | number; code: undefined | string; details: undefined | string }[]>
Creates one or more product ads. Successfully created product ads will be assigned a unique adId.

Returns
Parameters
- params: CreateProductAdsParams[]
Returns Promise<{ adId: undefined | number; code: undefined | string; details: undefined | string }[]>
- Defined in src/operations/product-ads/sponsored-products-product-ads-operation.ts:49

getProductAd

getProductAd(adId: number): Promise<{ adGroupId: number; adId: number; campaignId: number; state: "paused" | "enabled" | "archived" } & { sku: string } | { adGroupId: number; adId: number; campaignId: number; state: "paused" | "enabled" | "archived" } & { asin: string }>
Retrieves a product ad by ID. Note that this call returns the minimal set of product ad fields, but is more efficient than getProductAdEx.

Returns
Parameters
- adId: number
Returns Promise<{ adGroupId: number; adId: number; campaignId: number; state: "paused" | "enabled" | "archived" } & { sku: string } | { adGroupId: number; adId: number; campaignId: number; state: "paused" | "enabled" | "archived" } & { asin: string }>
- Defined in src/operations/product-ads/sponsored-products-product-ads-operation.ts:25

getProductAdExtended

getProductAdExtended(adId: number): Promise<{ adGroupId: number; adId: number; campaignId: number; state: "paused" | "enabled" | "archived" } & { sku: string } & { creationDate: Date; lastUpdatedDate: Date; servingStatus: "CAMPAIGN_ARCHIVED" | "CAMPAIGN_PAUSED" | "ADVERTISER_PAYMENT_FAILURE" | "CAMPAIGN_OUT_OF_BUDGET" | "ACCOUNT_OUT_OF_BUDGET" | "PORTFOLIO_ENDED" | "AD_GROUP_ARCHIVED" | "AD_GROUP_PAUSED" | "AD_POLICING_SUSPENDED" | "AD_ARCHIVED" | "AD_PAUSED" | "AD_STATUS_LIVE" | "MISSING_DECORATION" | "NOT_BUYABLE" } & { adGroupId: number; adId: number; campaignId: number; state: "paused" | "enabled" | "archived" } & { asin: string } & { creationDate: Date; lastUpdatedDate: Date; servingStatus: "CAMPAIGN_ARCHIVED" | "CAMPAIGN_PAUSED" | "ADVERTISER_PAYMENT_FAILURE" | "CAMPAIGN_OUT_OF_BUDGET" | "ACCOUNT_OUT_OF_BUDGET" | "PORTFOLIO_ENDED" | "AD_GROUP_ARCHIVED" | "AD_GROUP_PAUSED" | "AD_POLICING_SUSPENDED" | "AD_ARCHIVED" | "AD_PAUSED" | "AD_STATUS_LIVE" | "MISSING_DECORATION" | "NOT_BUYABLE" }>
Retrieves a product ad and its extended fields by ID. Note that this call returns the complete set of product ad fields (including serving status and other read-only fields), but is less efficient than getProductAd.

Returns
Parameters
- adId: number
Returns Promise<{ adGroupId: number; adId: number; campaignId: number; state: "paused" | "enabled" | "archived" } & { sku: string } & { creationDate: Date; lastUpdatedDate: Date; servingStatus: "CAMPAIGN_ARCHIVED" | "CAMPAIGN_PAUSED" | "ADVERTISER_PAYMENT_FAILURE" | "CAMPAIGN_OUT_OF_BUDGET" | "ACCOUNT_OUT_OF_BUDGET" | "PORTFOLIO_ENDED" | "AD_GROUP_ARCHIVED" | "AD_GROUP_PAUSED" | "AD_POLICING_SUSPENDED" | "AD_ARCHIVED" | "AD_PAUSED" | "AD_STATUS_LIVE" | "MISSING_DECORATION" | "NOT_BUYABLE" } & { adGroupId: number; adId: number; campaignId: number; state: "paused" | "enabled" | "archived" } & { asin: string } & { creationDate: Date; lastUpdatedDate: Date; servingStatus: "CAMPAIGN_ARCHIVED" | "CAMPAIGN_PAUSED" | "ADVERTISER_PAYMENT_FAILURE" | "CAMPAIGN_OUT_OF_BUDGET" | "ACCOUNT_OUT_OF_BUDGET" | "PORTFOLIO_ENDED" | "AD_GROUP_ARCHIVED" | "AD_GROUP_PAUSED" | "AD_POLICING_SUSPENDED" | "AD_ARCHIVED" | "AD_PAUSED" | "AD_STATUS_LIVE" | "MISSING_DECORATION" | "NOT_BUYABLE" }>
- Defined in src/operations/product-ads/sponsored-products-product-ads-operation.ts:37

listProductAds

listProductAds(params?: { count: undefined | number; startIndex: undefined | number } & { adGroupIdFilter: undefined | number[]; adIdFilter: undefined | number[]; campaignIdFilter: undefined | number[]; stateFilter: undefined | "paused" | "enabled" | "archived" }): Promise<({ adGroupId: number; adId: number; campaignId: number; state: "paused" | "enabled" | "archived" } & { sku: string } | { adGroupId: number; adId: number; campaignId: number; state: "paused" | "enabled" | "archived" } & { asin: string })[]>
Retrieves a list of product ads satisfying optional criteria.

Returns
Parameters
- Optional params: { count: undefined | number; startIndex: undefined | number } & { adGroupIdFilter: undefined | number[]; adIdFilter: undefined | number[]; campaignIdFilter: undefined | number[]; stateFilter: undefined | "paused" | "enabled" | "archived" }
Returns Promise<({ adGroupId: number; adId: number; campaignId: number; state: "paused" | "enabled" | "archived" } & { sku: string } | { adGroupId: number; adId: number; campaignId: number; state: "paused" | "enabled" | "archived" } & { asin: string })[]>
- Defined in src/operations/product-ads/sponsored-products-product-ads-operation.ts:85

listProductAdsExtended

listProductAdsExtended(params?: { count: undefined | number; startIndex: undefined | number } & { adGroupIdFilter: undefined | number[]; adIdFilter: undefined | number[]; campaignIdFilter: undefined | number[]; stateFilter: undefined | "paused" | "enabled" | "archived" }): Promise<({ adGroupId: number; adId: number; campaignId: number; state: "paused" | "enabled" | "archived" } & { sku: string } & { creationDate: Date; lastUpdatedDate: Date; servingStatus: "CAMPAIGN_ARCHIVED" | "CAMPAIGN_PAUSED" | "ADVERTISER_PAYMENT_FAILURE" | "CAMPAIGN_OUT_OF_BUDGET" | "ACCOUNT_OUT_OF_BUDGET" | "PORTFOLIO_ENDED" | "AD_GROUP_ARCHIVED" | "AD_GROUP_PAUSED" | "AD_POLICING_SUSPENDED" | "AD_ARCHIVED" | "AD_PAUSED" | "AD_STATUS_LIVE" | "MISSING_DECORATION" | "NOT_BUYABLE" } & { adGroupId: number; adId: number; campaignId: number; state: "paused" | "enabled" | "archived" } & { asin: string } & { creationDate: Date; lastUpdatedDate: Date; servingStatus: "CAMPAIGN_ARCHIVED" | "CAMPAIGN_PAUSED" | "ADVERTISER_PAYMENT_FAILURE" | "CAMPAIGN_OUT_OF_BUDGET" | "ACCOUNT_OUT_OF_BUDGET" | "PORTFOLIO_ENDED" | "AD_GROUP_ARCHIVED" | "AD_GROUP_PAUSED" | "AD_POLICING_SUSPENDED" | "AD_ARCHIVED" | "AD_PAUSED" | "AD_STATUS_LIVE" | "MISSING_DECORATION" | "NOT_BUYABLE" })[]>
Retrieves a list of product ads with extended fields satisfying optional criteria.

Returns
Parameters
- Optional params: { count: undefined | number; startIndex: undefined | number } & { adGroupIdFilter: undefined | number[]; adIdFilter: undefined | number[]; campaignIdFilter: undefined | number[]; stateFilter: undefined | "paused" | "enabled" | "archived" }
Returns Promise<({ adGroupId: number; adId: number; campaignId: number; state: "paused" | "enabled" | "archived" } & { sku: string } & { creationDate: Date; lastUpdatedDate: Date; servingStatus: "CAMPAIGN_ARCHIVED" | "CAMPAIGN_PAUSED" | "ADVERTISER_PAYMENT_FAILURE" | "CAMPAIGN_OUT_OF_BUDGET" | "ACCOUNT_OUT_OF_BUDGET" | "PORTFOLIO_ENDED" | "AD_GROUP_ARCHIVED" | "AD_GROUP_PAUSED" | "AD_POLICING_SUSPENDED" | "AD_ARCHIVED" | "AD_PAUSED" | "AD_STATUS_LIVE" | "MISSING_DECORATION" | "NOT_BUYABLE" } & { adGroupId: number; adId: number; campaignId: number; state: "paused" | "enabled" | "archived" } & { asin: string } & { creationDate: Date; lastUpdatedDate: Date; servingStatus: "CAMPAIGN_ARCHIVED" | "CAMPAIGN_PAUSED" | "ADVERTISER_PAYMENT_FAILURE" | "CAMPAIGN_OUT_OF_BUDGET" | "ACCOUNT_OUT_OF_BUDGET" | "PORTFOLIO_ENDED" | "AD_GROUP_ARCHIVED" | "AD_GROUP_PAUSED" | "AD_POLICING_SUSPENDED" | "AD_ARCHIVED" | "AD_PAUSED" | "AD_STATUS_LIVE" | "MISSING_DECORATION" | "NOT_BUYABLE" })[]>
- Defined in src/operations/product-ads/sponsored-products-product-ads-operation.ts:96

updateProductAds

updateProductAds(params: { adId: number; state: "paused" | "enabled" | "archived" }[]): Promise<{ adId: undefined | number; code: undefined | string; details: undefined | string }[]>
Updates one or more product ads. Product ads are identified using their adId.

Returns
Parameters
- params: { adId: number; state: "paused" | "enabled" | "archived" }[]
Returns Promise<{ adId: undefined | number; code: undefined | string; details: undefined | string }[]>
- Defined in src/operations/product-ads/sponsored-products-product-ads-operation.ts:61

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

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: HttpClient

Returns SponsoredProductsProductAdsOperation

Methods

archiveProductAd

Returns

Parameters

adId: number

Returns Promise<{ adId: undefined | number; code: undefined | string; details: undefined | string }>

createProductAds

Returns

Parameters

params: CreateProductAdsParams[]

Returns Promise<{ adId: undefined | number; code: undefined | string; details: undefined | string }[]>

getProductAd

Returns

Parameters

adId: number

Returns Promise<{ adGroupId: number; adId: number; campaignId: number; state: "paused" | "enabled" | "archived" } & { sku: string } | { adGroupId: number; adId: number; campaignId: number; state: "paused" | "enabled" | "archived" } & { asin: string }>

getProductAdExtended

Returns

Parameters

adId: number

listProductAds

Returns

Parameters

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

Returns Promise<({ adGroupId: number; adId: number; campaignId: number; state: "paused" | "enabled" | "archived" } & { sku: string } | { adGroupId: number; adId: number; campaignId: number; state: "paused" | "enabled" | "archived" } & { asin: string })[]>

listProductAdsExtended

Returns

Parameters

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

updateProductAds

Returns

Parameters

params: { adId: number; state: "paused" | "enabled" | "archived" }[]

Returns Promise<{ adId: undefined | number; code: 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 } & { adGroupIdFilter: undefined | number[]; adIdFilter: undefined | number[]; campaignIdFilter: undefined | number[]; stateFilter: undefined | "paused" | "enabled" | "archived" }

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

`Static` create