Class SponsoredDisplayNegativeTargetingOperation

Hierarchy

Operation
- SponsoredDisplayNegativeTargetingOperation

Index

Constructors

Methods

archiveNegativeTargetingClause createNegativeTargetingClauses getNegativeTargetingClause getNegativeTargetingClauseExtended listNegativeTargetingClauses listNegativeTargetingClausesExtended updateNegativeTargetingClauses create

Constructors

constructor

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

Methods

archiveNegativeTargetingClause

archiveNegativeTargetingClause(id: number): Promise<{ code: undefined | string; details: undefined | string; targetId: undefined | number }>
Sets the state of a negative targeting clause to archived.

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

createNegativeTargetingClauses

createNegativeTargetingClauses(params: { adGroupId: number; expression: ({ type: "asinBrandSameAs" | "asinSameAs"; value: string; })[]; expressionType: "auto" | "manual"; state: "paused" | "enabled" | "archived" }[]): Promise<{ code: undefined | string; details: undefined | string; targetId: undefined | number }[]>
Creates one or more negative targeting clauses.

Returns
Parameters
- params: { adGroupId: number; expression: ({ type: "asinBrandSameAs" | "asinSameAs"; value: 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-display-negative-targeting-operation.ts:47

getNegativeTargetingClause

getNegativeTargetingClause(id: number): Promise<{ adGroupId: number; expression: ({ type: "asinBrandSameAs" | "asinSameAs"; value: string; })[]; expressionType: "auto" | "manual"; state: "paused" | "enabled" | "archived" } & { targetId: number }>
Gets a negative targeting clause specified by identifier.

Returns
Parameters
- id: number
Returns Promise<{ adGroupId: number; expression: ({ type: "asinBrandSameAs" | "asinSameAs"; value: string; })[]; expressionType: "auto" | "manual"; state: "paused" | "enabled" | "archived" } & { targetId: number }>
- Defined in src/operations/negative-targeting/sponsored-display-negative-targeting-operation.ts:23

getNegativeTargetingClauseExtended

getNegativeTargetingClauseExtended(id: number): Promise<{ adGroupId: number; expression: ({ type: "asinBrandSameAs" | "asinSameAs"; value: 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" }>
Gets extended information for a negative targeting clause.

Returns
Parameters
- id: number
Returns Promise<{ adGroupId: number; expression: ({ type: "asinBrandSameAs" | "asinSameAs"; value: 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-display-negative-targeting-operation.ts:34

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; expression: ({ type: "asinBrandSameAs" | "asinSameAs"; value: string; })[]; expressionType: "auto" | "manual"; state: "paused" | "enabled" | "archived" } & { targetId: number })[]>
Gets 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; expression: ({ type: "asinBrandSameAs" | "asinSameAs"; value: string; })[]; expressionType: "auto" | "manual"; state: "paused" | "enabled" | "archived" } & { targetId: number })[]>
- Defined in src/operations/negative-targeting/sponsored-display-negative-targeting-operation.ts:73

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; expression: ({ type: "asinBrandSameAs" | "asinSameAs"; value: 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" })[]>
Gets a list of negative targeting clause objects with extended fields.

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; expression: ({ type: "asinBrandSameAs" | "asinSameAs"; value: 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-display-negative-targeting-operation.ts:86

updateNegativeTargetingClauses

updateNegativeTargetingClauses(params: { state: "paused" | "enabled" | "archived"; targetId: number }[]): Promise<{ code: undefined | string; details: undefined | string; targetId: undefined | number }[]>
Updates one or more negative targeting clauses.

Returns
Parameters
- params: { state: "paused" | "enabled" | "archived"; targetId: number }[]
Returns Promise<{ code: undefined | string; details: undefined | string; targetId: undefined | number }[]>
- Defined in src/operations/negative-targeting/sponsored-display-negative-targeting-operation.ts:60

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

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: HttpClient

Returns SponsoredDisplayNegativeTargetingOperation

Methods

archiveNegativeTargetingClause

Returns

Parameters

id: number

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

createNegativeTargetingClauses

Returns

Parameters

params: { adGroupId: number; expression: ({ type: "asinBrandSameAs" | "asinSameAs"; value: string; })[]; expressionType: "auto" | "manual"; state: "paused" | "enabled" | "archived" }[]

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

getNegativeTargetingClause

Returns

Parameters

id: number

Returns Promise<{ adGroupId: number; expression: ({ type: "asinBrandSameAs" | "asinSameAs"; value: string; })[]; expressionType: "auto" | "manual"; state: "paused" | "enabled" | "archived" } & { targetId: number }>

getNegativeTargetingClauseExtended

Returns

Parameters

id: 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[] }

Returns Promise<({ adGroupId: number; expression: ({ type: "asinBrandSameAs" | "asinSameAs"; value: string; })[]; expressionType: "auto" | "manual"; state: "paused" | "enabled" | "archived" } & { targetId: 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

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

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