Class SponsoredProductsProductTargetingOperation

Hierarchy

Operation
- SponsoredProductsProductTargetingOperation

Index

Constructors

Methods

archiveTargetingClause createTargetRecommendations createTargetingClauses getBrandRecommendations getRefinementsForCategory getTargetingCategories getTargetingClause getTargetingClauseExtended listTargetingClauses listTargetingClausesExtended updateTargetingClauses create

Constructors

constructor

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

Methods

archiveTargetingClause

archiveTargetingClause(targetId: number): Promise<{ code: undefined | string; details: undefined | string; targetId: undefined | number }>
Set the status of targeting clauses to archived. This same operation can also be performed via an update (PUT method), but is included for completeness. Archived entities cannot be made active again.

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

createTargetRecommendations

createTargetRecommendations(params: { asins: string[]; pageNumber: number; pageSize: number }): Promise<{ recommendedProducts: ({ recommendedTargetAsin: string; })[]; totalResultCount: number }>
Generate list of recommended products to target, based on the ASIN that is input. Successful response will be a list of recommended ASINs to target.

Returns
Parameters
- params: { asins: string[]; pageNumber: number; pageSize: number }
  - asins: string[]
    
    A list of asins for which to get recommendations for
  - pageNumber: number
    
    The number of pages to index into the result set
  - pageSize: number
    
    The number of recommendations to return in one page.
Returns Promise<{ recommendedProducts: ({ recommendedTargetAsin: string; })[]; totalResultCount: number }>
- Defined in src/operations/product-targeting/sponsored-products-product-targeting-operation.ts:116

createTargetingClauses

createTargetingClauses(params: { adGroupId: undefined | number; bid: undefined | number; campaignId: undefined | number; expression: undefined | ({ type: "asinCategorySameAs" | "asinBrandSameAs" | "asinPriceLessThan" | "asinPriceBetween" | "asinPriceGreaterThan" | "asinReviewRatingLessThan" | "asinReviewRatingBetween" | "asinReviewRatingGreaterThan" | "asinSameAs" | "queryBroadRelMatches" | "queryHighRelMatches" | "asinSubstituteRelated" | "asinAccessoryRelated" | "asinIsPrimeShippingEligible" | "asinAgeRangeSameAs" | "asinGenreSameAs" } & ({ value?: string | undefined; }))[]; expressionType: undefined | "auto" | "manual"; state: undefined | "paused" | "enabled" | "archived" }[]): Promise<{ code: undefined | string; details: undefined | string; targetId: undefined | number }[]>
Creates one or more targeting expressions.

Returns
Parameters
- params: { adGroupId: undefined | number; bid: undefined | number; campaignId: undefined | number; expression: undefined | ({ type: "asinCategorySameAs" | "asinBrandSameAs" | "asinPriceLessThan" | "asinPriceBetween" | "asinPriceGreaterThan" | "asinReviewRatingLessThan" | "asinReviewRatingBetween" | "asinReviewRatingGreaterThan" | "asinSameAs" | "queryBroadRelMatches" | "queryHighRelMatches" | "asinSubstituteRelated" | "asinAccessoryRelated" | "asinIsPrimeShippingEligible" | "asinAgeRangeSameAs" | "asinGenreSameAs" } & ({ value?: string | undefined; }))[]; expressionType: undefined | "auto" | "manual"; state: undefined | "paused" | "enabled" | "archived" }[]
Returns Promise<{ code: undefined | string; details: undefined | string; targetId: undefined | number }[]>
- Defined in src/operations/product-targeting/sponsored-products-product-targeting-operation.ts:80

getBrandRecommendations

getBrandRecommendations(params: { categoryId: undefined | number; keyword: undefined | string }): Promise<{ id: number; name: string }>
Get recommended brands for Sponsored Products. Only one parameter (keyword or categoryId) per request is allowed.

Returns
Parameters
- params: { categoryId: undefined | number; keyword: undefined | string }
  - categoryId: undefined | number
  - keyword: undefined | string
Returns Promise<{ id: number; name: string }>
- Defined in src/operations/product-targeting/sponsored-products-product-targeting-operation.ts:159

getRefinementsForCategory

getRefinementsForCategory(categoryId: number): Promise<{ ageRanges: ({ id: number; name: string; })[]; brands: ({ id: number; name: string; })[]; categoryId: number }>
Get refinements for a single category. Categories and Refinements are determined based on marketplaceId of the profile in the request. Note that refinements will differ between marketplaces.

Returns
Parameters
- categoryId: number
Returns Promise<{ ageRanges: ({ id: number; name: string; })[]; brands: ({ id: number; name: string; })[]; categoryId: number }>
- Defined in src/operations/product-targeting/sponsored-products-product-targeting-operation.ts:145

getTargetingCategories

getTargetingCategories(asins: string[]): Promise<{ id: number; isTargetable: boolean; name: string; path: string }[]>
Gets the list of targeting categories.

Returns
Parameters
- asins: string[]
Returns Promise<{ id: number; isTargetable: boolean; name: string; path: string }[]>
- Defined in src/operations/product-targeting/sponsored-products-product-targeting-operation.ts:130

getTargetingClause

getTargetingClause(targetId: number): Promise<{ adGroupId: number; campaignId: number; expression: (({ type: "asinCategorySameAs" | "asinBrandSameAs" | "asinPriceLessThan" | "asinPriceBetween" | "asinPriceGreaterThan" | "asinReviewRatingLessThan" | "asinReviewRatingBetween" | "asinReviewRatingGreaterThan" | "asinSameAs" | "queryBroadRelMatches" | "queryHighRelMatches" | "asinSubstituteRelated" | "asinAccessoryRelated" | "asinIsPrimeShippingEligible" | "asinAgeRangeSameAs" | "asinGenreSameAs"; }) & { value: undefined | string })[]; expressionType: "auto" | "manual"; state: "paused" | "enabled" | "archived"; targetId: number } & { bid: undefined | number }>
Retrieve a targeting clause with a specific target ID.

Returns
Parameters
- targetId: number
Returns Promise<{ adGroupId: number; campaignId: number; expression: (({ type: "asinCategorySameAs" | "asinBrandSameAs" | "asinPriceLessThan" | "asinPriceBetween" | "asinPriceGreaterThan" | "asinReviewRatingLessThan" | "asinReviewRatingBetween" | "asinReviewRatingGreaterThan" | "asinSameAs" | "queryBroadRelMatches" | "queryHighRelMatches" | "asinSubstituteRelated" | "asinAccessoryRelated" | "asinIsPrimeShippingEligible" | "asinAgeRangeSameAs" | "asinGenreSameAs"; }) & { value: undefined | string })[]; expressionType: "auto" | "manual"; state: "paused" | "enabled" | "archived"; targetId: number } & { bid: undefined | number }>
- Defined in src/operations/product-targeting/sponsored-products-product-targeting-operation.ts:32

getTargetingClauseExtended

getTargetingClauseExtended(targetId: number): Promise<{ adGroupId: number; campaignId: number; expression: (({ type: "asinCategorySameAs" | "asinBrandSameAs" | "asinPriceLessThan" | "asinPriceBetween" | "asinPriceGreaterThan" | "asinReviewRatingLessThan" | "asinReviewRatingBetween" | "asinReviewRatingGreaterThan" | "asinSameAs" | "queryBroadRelMatches" | "queryHighRelMatches" | "asinSubstituteRelated" | "asinAccessoryRelated" | "asinIsPrimeShippingEligible" | "asinAgeRangeSameAs" | "asinGenreSameAs"; }) & { value: undefined | string })[]; expressionType: "auto" | "manual"; state: "paused" | "enabled" | "archived"; targetId: number } & { bid: undefined | number } & { 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" | "TARGETING_CLAUSE_ARCHIVED" | "TARGETING_CLAUSE_PAUSED" | "TARGETING_CLAUSE_STATUS_LIVE" | "TARGETING_CLAUSE_POLICING_SUSPENDED" }>
Retrieve a targeting clause with additional attributes using a specific target ID.

Returns
Parameters
- targetId: number
Returns Promise<{ adGroupId: number; campaignId: number; expression: (({ type: "asinCategorySameAs" | "asinBrandSameAs" | "asinPriceLessThan" | "asinPriceBetween" | "asinPriceGreaterThan" | "asinReviewRatingLessThan" | "asinReviewRatingBetween" | "asinReviewRatingGreaterThan" | "asinSameAs" | "queryBroadRelMatches" | "queryHighRelMatches" | "asinSubstituteRelated" | "asinAccessoryRelated" | "asinIsPrimeShippingEligible" | "asinAgeRangeSameAs" | "asinGenreSameAs"; }) & { value: undefined | string })[]; expressionType: "auto" | "manual"; state: "paused" | "enabled" | "archived"; targetId: number } & { bid: undefined | number } & { 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" | "TARGETING_CLAUSE_ARCHIVED" | "TARGETING_CLAUSE_PAUSED" | "TARGETING_CLAUSE_STATUS_LIVE" | "TARGETING_CLAUSE_POLICING_SUSPENDED" }>
- Defined in src/operations/product-targeting/sponsored-products-product-targeting-operation.ts:43

listTargetingClauses

listTargetingClauses(params?: { count: undefined | number; startIndex: undefined | number } & { adGroupIdFilter: undefined | number[]; campaignIdFilter: undefined | number[]; stateFilter: undefined | "paused" | "enabled" | "archived"; targetIdFilter: undefined | number[] }): Promise<({ adGroupId: number; campaignId: number; expression: (({ type: "asinCategorySameAs" | "asinBrandSameAs" | "asinPriceLessThan" | "asinPriceBetween" | "asinPriceGreaterThan" | "asinReviewRatingLessThan" | "asinReviewRatingBetween" | "asinReviewRatingGreaterThan" | "asinSameAs" | "queryBroadRelMatches" | "queryHighRelMatches" | "asinSubstituteRelated" | "asinAccessoryRelated" | "asinIsPrimeShippingEligible" | "asinAgeRangeSameAs" | "asinGenreSameAs"; }) & { value: undefined | string })[]; expressionType: "auto" | "manual"; state: "paused" | "enabled" | "archived"; targetId: number } & { bid: undefined | number })[]>
Retrieves a list of targeting clauses.

Returns
Parameters
- Optional params: { count: undefined | number; startIndex: undefined | number } & { adGroupIdFilter: undefined | number[]; campaignIdFilter: undefined | number[]; stateFilter: undefined | "paused" | "enabled" | "archived"; targetIdFilter: undefined | number[] }
Returns Promise<({ adGroupId: number; campaignId: number; expression: (({ type: "asinCategorySameAs" | "asinBrandSameAs" | "asinPriceLessThan" | "asinPriceBetween" | "asinPriceGreaterThan" | "asinReviewRatingLessThan" | "asinReviewRatingBetween" | "asinReviewRatingGreaterThan" | "asinSameAs" | "queryBroadRelMatches" | "queryHighRelMatches" | "asinSubstituteRelated" | "asinAccessoryRelated" | "asinIsPrimeShippingEligible" | "asinAgeRangeSameAs" | "asinGenreSameAs"; }) & { value: undefined | string })[]; expressionType: "auto" | "manual"; state: "paused" | "enabled" | "archived"; targetId: number } & { bid: undefined | number })[]>
- Defined in src/operations/product-targeting/sponsored-products-product-targeting-operation.ts:54

listTargetingClausesExtended

listTargetingClausesExtended(params?: { count: undefined | number; startIndex: undefined | number } & { adGroupIdFilter: undefined | number[]; campaignIdFilter: undefined | number[]; stateFilter: undefined | "paused" | "enabled" | "archived"; targetIdFilter: undefined | number[] }): Promise<({ adGroupId: number; campaignId: number; expression: (({ type: "asinCategorySameAs" | "asinBrandSameAs" | "asinPriceLessThan" | "asinPriceBetween" | "asinPriceGreaterThan" | "asinReviewRatingLessThan" | "asinReviewRatingBetween" | "asinReviewRatingGreaterThan" | "asinSameAs" | "queryBroadRelMatches" | "queryHighRelMatches" | "asinSubstituteRelated" | "asinAccessoryRelated" | "asinIsPrimeShippingEligible" | "asinAgeRangeSameAs" | "asinGenreSameAs"; }) & { value: undefined | string })[]; expressionType: "auto" | "manual"; state: "paused" | "enabled" | "archived"; targetId: number } & { bid: undefined | number } & { 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" | "TARGETING_CLAUSE_ARCHIVED" | "TARGETING_CLAUSE_PAUSED" | "TARGETING_CLAUSE_STATUS_LIVE" | "TARGETING_CLAUSE_POLICING_SUSPENDED" })[]>
Retrieve a list of targeting clauses with extended properties.

Returns
Parameters
- Optional params: { count: undefined | number; startIndex: undefined | number } & { adGroupIdFilter: undefined | number[]; campaignIdFilter: undefined | number[]; stateFilter: undefined | "paused" | "enabled" | "archived"; targetIdFilter: undefined | number[] }
Returns Promise<({ adGroupId: number; campaignId: number; expression: (({ type: "asinCategorySameAs" | "asinBrandSameAs" | "asinPriceLessThan" | "asinPriceBetween" | "asinPriceGreaterThan" | "asinReviewRatingLessThan" | "asinReviewRatingBetween" | "asinReviewRatingGreaterThan" | "asinSameAs" | "queryBroadRelMatches" | "queryHighRelMatches" | "asinSubstituteRelated" | "asinAccessoryRelated" | "asinIsPrimeShippingEligible" | "asinAgeRangeSameAs" | "asinGenreSameAs"; }) & { value: undefined | string })[]; expressionType: "auto" | "manual"; state: "paused" | "enabled" | "archived"; targetId: number } & { bid: undefined | number } & { 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" | "TARGETING_CLAUSE_ARCHIVED" | "TARGETING_CLAUSE_PAUSED" | "TARGETING_CLAUSE_STATUS_LIVE" | "TARGETING_CLAUSE_POLICING_SUSPENDED" })[]>
- Defined in src/operations/product-targeting/sponsored-products-product-targeting-operation.ts:67

updateTargetingClauses

updateTargetingClauses(params: { adGroupId: undefined | number; bid: undefined | number; campaignId: undefined | number; expression: undefined | ({ type: "asinCategorySameAs" | "asinBrandSameAs" | "asinPriceLessThan" | "asinPriceBetween" | "asinPriceGreaterThan" | "asinReviewRatingLessThan" | "asinReviewRatingBetween" | "asinReviewRatingGreaterThan" | "asinSameAs" | "queryBroadRelMatches" | "queryHighRelMatches" | "asinSubstituteRelated" | "asinAccessoryRelated" | "asinIsPrimeShippingEligible" | "asinAgeRangeSameAs" | "asinGenreSameAs" } & ({ value?: string | undefined; }))[]; expressionType: undefined | "auto" | "manual"; state: undefined | "paused" | "enabled" | "archived"; targetId: undefined | number }[]): Promise<{ code: undefined | string; details: undefined | string; targetId: undefined | number }[]>
Update one or more targeting clauses.

Returns
Parameters
- params: { adGroupId: undefined | number; bid: undefined | number; campaignId: undefined | number; expression: undefined | ({ type: "asinCategorySameAs" | "asinBrandSameAs" | "asinPriceLessThan" | "asinPriceBetween" | "asinPriceGreaterThan" | "asinReviewRatingLessThan" | "asinReviewRatingBetween" | "asinReviewRatingGreaterThan" | "asinSameAs" | "queryBroadRelMatches" | "queryHighRelMatches" | "asinSubstituteRelated" | "asinAccessoryRelated" | "asinIsPrimeShippingEligible" | "asinAgeRangeSameAs" | "asinGenreSameAs" } & ({ value?: string | undefined; }))[]; expressionType: undefined | "auto" | "manual"; state: undefined | "paused" | "enabled" | "archived"; targetId: undefined | number }[]
Returns Promise<{ code: undefined | string; details: undefined | string; targetId: undefined | number }[]>
- Defined in src/operations/product-targeting/sponsored-products-product-targeting-operation.ts:91

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

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: HttpClient

Returns SponsoredProductsProductTargetingOperation

Methods

archiveTargetingClause

Returns

Parameters

targetId: number

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

createTargetRecommendations

Returns

Parameters

params: { asins: string[]; pageNumber: number; pageSize: number }

asins: string[]

pageNumber: number

pageSize: number

Returns Promise<{ recommendedProducts: ({ recommendedTargetAsin: string; })[]; totalResultCount: number }>

createTargetingClauses

Returns

Parameters

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

getBrandRecommendations

Returns

Parameters

params: { categoryId: undefined | number; keyword: undefined | string }

categoryId: undefined | number

keyword: undefined | string

Returns Promise<{ id: number; name: string }>

getRefinementsForCategory

Returns

Parameters

categoryId: number

Returns Promise<{ ageRanges: ({ id: number; name: string; })[]; brands: ({ id: number; name: string; })[]; categoryId: number }>

getTargetingCategories

Returns

Parameters

asins: string[]

Returns Promise<{ id: number; isTargetable: boolean; name: string; path: string }[]>

getTargetingClause

Returns

Parameters

targetId: number

getTargetingClauseExtended

Returns

Parameters

targetId: number

listTargetingClauses

Returns

Parameters

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

listTargetingClausesExtended

Returns

Parameters

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

updateTargetingClauses

Returns

Parameters

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

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[]; campaignIdFilter: undefined | number[]; stateFilter: undefined | "paused" | "enabled" | "archived"; targetIdFilter: undefined | number[] }

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

`Static` create