Class SponsoredDisplayProductAdsOperation

Hierarchy

Operation
- SponsoredDisplayProductAdsOperation

Index

Constructors

Methods

archiveProductAd createProductAds getProductAd getProductAdExtended listProductAds listProductAdsExtended updateProductAds create

Constructors

constructor

new SponsoredDisplayProductAdsOperation(client: HttpClient): SponsoredDisplayProductAdsOperation
Parameters
- client: HttpClient
Returns SponsoredDisplayProductAdsOperation
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 operation is equivalent to an update operation that sets the status field to 'archived'. Note that setting the status field to 'archived' is permanent and can't be undone. 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-display-product-ads-operation.ts:77

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-display-product-ads-operation.ts:51

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 }>
Gets a requested product ad. Note that the ProductAd object is designed for performance, and includes a small set of commonly used fields to reduce size. If the extended set of fields is required, use a product ad operations that returns the ProductAdResponseEx object.

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-display-product-ads-operation.ts:26

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" }>
Gets a list of product ads with extended fields. Gets an array of ProductAdExtended objects for a set of requested ad groups. The ProductAdExtended object includes the extended set of available fields.

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-display-product-ads-operation.ts:39

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 })[]>
Gets a list of product ads. Note that the ProductAd object is designed for performance, and includes a small set of commonly used fields to reduce size. If the extended set of fields is required, use a product ad operation that returns the ProductAdExtended object.

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-display-product-ads-operation.ts:90

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" })[]>
Gets a list of product ads with extended fields. The ProductAdExtended object includes the extended set of available fields.

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-display-product-ads-operation.ts:102

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-display-product-ads-operation.ts:63

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

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: HttpClient

Returns SponsoredDisplayProductAdsOperation

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