Class SponsoredProductsNegativeTargetingOperation

Hierarchy

Operation
- SponsoredProductsNegativeTargetingOperation

Index

Constructors

Methods

archiveNegativeTargetingClause createNegativeTargetingClauses getNegativeTargetingClause getNegativeTargetingClauseExtended listNegativeTargetingClauses listNegativeTargetingClausesExtended updateNegativeTargetingClauses create

Constructors

constructor

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

Methods

archiveNegativeTargetingClause

archiveNegativeTargetingClause(targetId: number): Promise<{ code: undefined | string; details: undefined | string; targetId: undefined | number }>
Archive negative targeting clauses.

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

createNegativeTargetingClauses

createNegativeTargetingClauses(params: { 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" }[]): Promise<{ code: undefined | string; details: undefined | string; targetId: undefined | number }[]>
Create negative targeting clauses at the campaign level.

Returns
Parameters
- params: { 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" }[]
Returns Promise<{ code: undefined | string; details: undefined | string; targetId: undefined | number }[]>
- Defined in src/operations/negative-targeting/sponsored-products-negative-targeting-operation.ts:46

getNegativeTargetingClause

getNegativeTargetingClause(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 }>
Get a specific negative targeting clause by targetId.

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 }>
- Defined in src/operations/negative-targeting/sponsored-products-negative-targeting-operation.ts:24

getNegativeTargetingClauseExtended

getNegativeTargetingClauseExtended(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 } & { 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 negative 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 } & { 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/negative-targeting/sponsored-products-negative-targeting-operation.ts:35

listNegativeTargetingClauses

listNegativeTargetingClauses(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 }[]>
Retrieves a list of negative 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 }[]>
- Defined in src/operations/negative-targeting/sponsored-products-negative-targeting-operation.ts:57

listNegativeTargetingClausesExtended

listNegativeTargetingClausesExtended(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 } & { 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 } & { 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/negative-targeting/sponsored-products-negative-targeting-operation.ts:68

updateNegativeTargetingClauses

updateNegativeTargetingClauses(params: { adGroupId: 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 negative targeting clauses.

Returns
Parameters
- params: { adGroupId: 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/negative-targeting/sponsored-products-negative-targeting-operation.ts:92

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

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: HttpClient

Returns SponsoredProductsNegativeTargetingOperation

Methods

archiveNegativeTargetingClause

Returns

Parameters

targetId: number

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

createNegativeTargetingClauses

Returns

Parameters

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

getNegativeTargetingClause

Returns

Parameters

targetId: number

getNegativeTargetingClauseExtended

Returns

Parameters

targetId: number

listNegativeTargetingClauses

Returns

Parameters

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

listNegativeTargetingClausesExtended

Returns

Parameters

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

updateNegativeTargetingClauses

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