Class SponsoredProductsBidRecommendationOperation

Hierarchy

Operation
- SponsoredProductsBidRecommendationOperation

Index

Constructors

constructor

Methods

createKeywordBidRecommendations getAdGroupBidRecommendations getBidRecommendations getKeywordBidRecommendations create

Constructors

constructor

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

Methods

createKeywordBidRecommendations

createKeywordBidRecommendations(params: { adGroupId: number; keywords: ({ keyword: string; matchType: "exact" | "broad" | "phrase"; })[] }): Promise<{ adGroupId: number; recommendations: (({ code: "SUCCESS"; suggestedBid: { rangeStart: number; rangeEnd: number; suggested: number; }; }) & ({ keyword: string; matchType: "exact" | "broad" | "phrase"; }) | ({ code: "NOT_FOUND"; }))[] }>
Request bid recommendations for a list of up to 100 keywords.

Returns
BidRecommendationsResponse
Parameters
- params: { adGroupId: number; keywords: ({ keyword: string; matchType: "exact" | "broad" | "phrase"; })[] }
  - adGroupId: number
    
    The ID of the ad group that a bid was requested for.
  - keywords: ({ keyword: string; matchType: "exact" | "broad" | "phrase"; })[]
    
    Suggested Bid
Returns Promise<{ adGroupId: number; recommendations: (({ code: "SUCCESS"; suggestedBid: { rangeStart: number; rangeEnd: number; suggested: number; }; }) & ({ keyword: string; matchType: "exact" | "broad" | "phrase"; }) | ({ code: "NOT_FOUND"; }))[] }>
- Defined in src/operations/bidding/sponsored-products-bid-recommendation-operation.ts:50

getAdGroupBidRecommendations

getAdGroupBidRecommendations(id: number): Promise<{ adGroupId: number; suggestedBid: { rangeStart: number; rangeEnd: number; suggested: number; } }>
Request bid recommendations for specified ad group.

Returns
AdGroupBidRecommendationsResponse
Parameters
- id: number
Returns Promise<{ adGroupId: number; suggestedBid: { rangeStart: number; rangeEnd: number; suggested: number; } }>
- Defined in src/operations/bidding/sponsored-products-bid-recommendation-operation.ts:24

getBidRecommendations

getBidRecommendations(params: { adGroupId: number; expressions: ({ value: string; type: "queryBroadMatches" | "queryPhraseMatches" | "queryExactMatches" | "asinCategorySameAs" | "asinBrandSameAs" | "asinPriceLessThan" | "asinPriceBetween" | "asinPriceGreaterThan" | "asinReviewRatingLessThan" | "asinReviewRatingBetween" | "asinReviewRatingGreaterThan" | "asinSameAs" | "queryBroadRelMatches" | "queryHighRelMatches" | "asinSubstituteRelated" | "asinAccessoryRelated"; })[] }): Promise<{ adGroupId: number; recommendations: (({ code: "NOT_FOUND"; }) | ({ suggestedBid: { rangeStart: number; rangeEnd: number; suggested: number; }; expression: { value: string; type: "queryBroadMatches" | "queryPhraseMatches" | "queryExactMatches" | "asinCategorySameAs" | "asinBrandSameAs" | "asinPriceLessThan" | "asinPriceBetween" | "asinPriceGreaterThan" | "asinReviewRatingLessThan" | "asinReviewRatingBetween" | "asinReviewRatingGreaterThan" | "asinSameAs" | "queryBroadRelMatches" | "queryHighRelMatches" | "asinSubstituteRelated" | "asinAccessoryRelated"; }; code: "SUCCESS"; }) | ({ code: "INVALID_ARGUMENT"; }) | ({ code: "INTERNAL_ERROR"; }) | ({ code: "SERVER_IS_BUSY"; }) | ({ code: "UNAUTHORIZED"; }))[] }>
Retrieve a list of bid recommendations for keyword, product, or auto targeting expressions by adGroupId.

Returns
BidRecommendationForTargetsResponse
Parameters
- params: { adGroupId: number; expressions: ({ value: string; type: "queryBroadMatches" | "queryPhraseMatches" | "queryExactMatches" | "asinCategorySameAs" | "asinBrandSameAs" | "asinPriceLessThan" | "asinPriceBetween" | "asinPriceGreaterThan" | "asinReviewRatingLessThan" | "asinReviewRatingBetween" | "asinReviewRatingGreaterThan" | "asinSameAs" | "queryBroadRelMatches" | "queryHighRelMatches" | "asinSubstituteRelated" | "asinAccessoryRelated"; })[] }
  - adGroupId: number
    
    The adGroupId where the targeting expression exists, to generate a bid recommendation
  - expressions: ({ value: string; type: "queryBroadMatches" | "queryPhraseMatches" | "queryExactMatches" | "asinCategorySameAs" | "asinBrandSameAs" | "asinPriceLessThan" | "asinPriceBetween" | "asinPriceGreaterThan" | "asinReviewRatingLessThan" | "asinReviewRatingBetween" | "asinReviewRatingGreaterThan" | "asinSameAs" | "queryBroadRelMatches" | "queryHighRelMatches" | "asinSubstituteRelated" | "asinAccessoryRelated"; })[]
    
    List of targeting expressions to generate recommendations for
Returns Promise<{ adGroupId: number; recommendations: (({ code: "NOT_FOUND"; }) | ({ suggestedBid: { rangeStart: number; rangeEnd: number; suggested: number; }; expression: { value: string; type: "queryBroadMatches" | "queryPhraseMatches" | "queryExactMatches" | "asinCategorySameAs" | "asinBrandSameAs" | "asinPriceLessThan" | "asinPriceBetween" | "asinPriceGreaterThan" | "asinReviewRatingLessThan" | "asinReviewRatingBetween" | "asinReviewRatingGreaterThan" | "asinSameAs" | "queryBroadRelMatches" | "queryHighRelMatches" | "asinSubstituteRelated" | "asinAccessoryRelated"; }; code: "SUCCESS"; }) | ({ code: "INVALID_ARGUMENT"; }) | ({ code: "INTERNAL_ERROR"; }) | ({ code: "SERVER_IS_BUSY"; }) | ({ code: "UNAUTHORIZED"; }))[] }>
- Defined in src/operations/bidding/sponsored-products-bid-recommendation-operation.ts:64

getKeywordBidRecommendations

getKeywordBidRecommendations(id: number): Promise<{ adGroupId: number; suggestedBid: { rangeStart: number; rangeEnd: number; suggested: number; } } & { keywordId: number }>
Request bid recommendations for specified keyword.

Returns
KeywordBidRecommendationsResponse
Parameters
- id: number
Returns Promise<{ adGroupId: number; suggestedBid: { rangeStart: number; rangeEnd: number; suggested: number; } } & { keywordId: number }>
- Defined in src/operations/bidding/sponsored-products-bid-recommendation-operation.ts:37

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

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: HttpClient

Returns SponsoredProductsBidRecommendationOperation

Methods

createKeywordBidRecommendations

Returns

Parameters

params: { adGroupId: number; keywords: ({ keyword: string; matchType: "exact" | "broad" | "phrase"; })[] }

adGroupId: number

keywords: ({ keyword: string; matchType: "exact" | "broad" | "phrase"; })[]

Returns Promise<{ adGroupId: number; recommendations: (({ code: "SUCCESS"; suggestedBid: { rangeStart: number; rangeEnd: number; suggested: number; }; }) & ({ keyword: string; matchType: "exact" | "broad" | "phrase"; }) | ({ code: "NOT_FOUND"; }))[] }>

getAdGroupBidRecommendations

Returns

Parameters

id: number

Returns Promise<{ adGroupId: number; suggestedBid: { rangeStart: number; rangeEnd: number; suggested: number; } }>

getBidRecommendations

Returns

Parameters

adGroupId: number

getKeywordBidRecommendations

Returns

Parameters

id: number

Returns Promise<{ adGroupId: number; suggestedBid: { rangeStart: number; rangeEnd: number; suggested: number; } } & { keywordId: number }>

Static create

Type Parameters

T extends typeof Operation

Parameters

this: T

httpClient: HttpClient

Returns InstanceType<T>

Settings

Member Visibility

Theme

`Static` create