Class SponsoredBrandsAdGroupOperation

Hierarchy

Operation
- SponsoredBrandsAdGroupOperation

Index

Constructors

constructor

Methods

getAdGroup listAdGroups create

Constructors

constructor

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

Methods

getAdGroup

getAdGroup(adGroupId: number): Promise<{ adGroupId: number; campaignId: number; defaultBid: number; name: string; state: "paused" | "enabled" | "archived" }>
Gets an ad group specified by identifier.

Returns
Parameters
- adGroupId: number
Returns Promise<{ adGroupId: number; campaignId: number; defaultBid: number; name: string; state: "paused" | "enabled" | "archived" }>
- Defined in src/operations/ad-groups/sponsored-brands-ad-group-operation.ts:16

listAdGroups

listAdGroups(params?: { count: undefined | number; startIndex: undefined | number } & { adGroupIdFilter: undefined | number[]; campaignIdFilter: undefined | number[]; name: undefined | string; stateFilter: undefined | ("paused" | "enabled" | "archived")[] }): Promise<{ adGroupId: number; campaignId: number; defaultBid: number; name: string; state: "paused" | "enabled" | "archived" }[]>
Gets an array of ad groups associated with the client identifier passed in the authorization header, filtered by specified criteria

Returns
Parameters
- Optional params: { count: undefined | number; startIndex: undefined | number } & { adGroupIdFilter: undefined | number[]; campaignIdFilter: undefined | number[]; name: undefined | string; stateFilter: undefined | ("paused" | "enabled" | "archived")[] }
Returns Promise<{ adGroupId: number; campaignId: number; defaultBid: number; name: string; state: "paused" | "enabled" | "archived" }[]>
- Defined in src/operations/ad-groups/sponsored-brands-ad-group-operation.ts:27

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

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: HttpClient

Returns SponsoredBrandsAdGroupOperation

Methods

getAdGroup

Returns

Parameters

adGroupId: number

Returns Promise<{ adGroupId: number; campaignId: number; defaultBid: number; name: string; state: "paused" | "enabled" | "archived" }>

listAdGroups

Returns

Parameters

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

Returns Promise<{ adGroupId: number; campaignId: number; defaultBid: number; name: string; state: "paused" | "enabled" | "archived" }[]>

`Static` create

Type Parameters

T extends typeof Operation

Parameters

this: T

httpClient: HttpClient

Returns InstanceType<T>

Settings

Member Visibility

Theme

Class SponsoredBrandsAdGroupOperation

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: HttpClient

Returns SponsoredBrandsAdGroupOperation

Methods

getAdGroup

Returns

Parameters

adGroupId: number

Returns Promise<{ adGroupId: number; campaignId: number; defaultBid: number; name: string; state: "paused" | "enabled" | "archived" }>

listAdGroups

Returns

Parameters

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

Returns Promise<{ adGroupId: number; campaignId: number; defaultBid: number; name: string; state: "paused" | "enabled" | "archived" }[]>

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[]; name: undefined | string; stateFilter: undefined | ("paused" | "enabled" | "archived")[] }

`Static` create