Class SponsoredBrandsNegativeKeywordsOperation

Hierarchy

Operation
- SponsoredBrandsNegativeKeywordsOperation

Index

Constructors

constructor

Methods

archiveNegativeKeyword createNegativeKeywords getNegativeKeyword updateNegativeKeywords create

Constructors

constructor

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

Methods

archiveNegativeKeyword

archiveNegativeKeyword(keywordId: number): Promise<{ code: string; keywordId: number } & { details: undefined | string }>
Archives a negative keyword specified by identifier. 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
- keywordId: number
Returns Promise<{ code: string; keywordId: number } & { details: undefined | string }>
- Defined in src/operations/keywords/sponsored-brands-negative-keywords-operation.ts:62

createNegativeKeywords

createNegativeKeywords(params: { adGroupId: number; campaignId: number; keywordText: string; matchType: "negativeExact" | "negativePhrase" }[]): Promise<({ code: string; keywordId: number } & { details: undefined | string })[]>
Creates one or more negative keywords. Note that bid and state can't be set at negative keyword creation. Negative keywords submitted for creation have state set to pending while under moderation review. Note that moderation review may take up to 72 hours.

Returns
Parameters
- params: { adGroupId: number; campaignId: number; keywordText: string; matchType: "negativeExact" | "negativePhrase" }[]
Returns Promise<({ code: string; keywordId: number } & { details: undefined | string })[]>
- Defined in src/operations/keywords/sponsored-brands-negative-keywords-operation.ts:38

getNegativeKeyword

getNegativeKeyword(keywordId: number): Promise<{ adGroupId: number; campaignId: number; keywordId: number; keywordText: string; matchType: "negativeExact" | "negativePhrase"; state: "pending" | "enabled" | "archived" | "draft" }>
Gets a negative keyword specified by identifier.

Returns
Parameters
- keywordId: number
Returns Promise<{ adGroupId: number; campaignId: number; keywordId: number; keywordText: string; matchType: "negativeExact" | "negativePhrase"; state: "pending" | "enabled" | "archived" | "draft" }>
- Defined in src/operations/keywords/sponsored-brands-negative-keywords-operation.ts:49

updateNegativeKeywords

updateNegativeKeywords(params: { adGroupId: undefined | number; campaignId: undefined | number; keywordId: undefined | number; state: undefined | "pending" | "enabled" | "archived" | "draft" }[]): Promise<({ code: string; keywordId: number } & { details: undefined | string })[]>
Updates one or more negative keywords. Negative keywords submitted for update have state set to pending while under moderation review. Note that moderation may take up to 72 hours.

Returns
Parameters
- params: { adGroupId: undefined | number; campaignId: undefined | number; keywordId: undefined | number; state: undefined | "pending" | "enabled" | "archived" | "draft" }[]
Returns Promise<({ code: string; keywordId: number } & { details: undefined | string })[]>
- Defined in src/operations/keywords/sponsored-brands-negative-keywords-operation.ts:24

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

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: HttpClient

Returns SponsoredBrandsNegativeKeywordsOperation

Methods

archiveNegativeKeyword

Returns

Parameters

keywordId: number

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

createNegativeKeywords

Returns

Parameters

params: { adGroupId: number; campaignId: number; keywordText: string; matchType: "negativeExact" | "negativePhrase" }[]

Returns Promise<({ code: string; keywordId: number } & { details: undefined | string })[]>

getNegativeKeyword

Returns

Parameters

keywordId: number

Returns Promise<{ adGroupId: number; campaignId: number; keywordId: number; keywordText: string; matchType: "negativeExact" | "negativePhrase"; state: "pending" | "enabled" | "archived" | "draft" }>

updateNegativeKeywords

Returns

Parameters

params: { adGroupId: undefined | number; campaignId: undefined | number; keywordId: undefined | number; state: undefined | "pending" | "enabled" | "archived" | "draft" }[]

Returns Promise<({ code: string; keywordId: number } & { details: undefined | string })[]>

Static create

Type Parameters

T extends typeof Operation

Parameters

this: T

httpClient: HttpClient

Returns InstanceType<T>

Settings

Member Visibility

Theme

`Static` create