Class BaseAdGroupOperation

Hierarchy

Operation
- BaseAdGroupOperation
  - SponsoredDisplayAdGroupOperation
  - SponsoredProductsAdGroupOperation

Index

Constructors

constructor

Methods

archiveAdGroup createAdGroups getAdGroup getAdGroupExtended listAdGroups listAdGroupsExtended updateAdGroups create

Constructors

constructor

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

Methods

archiveAdGroup

archiveAdGroup(adGroupId: number): Promise<{ adGroupId: number; code: "NOT_FOUND" | "SUCCESS" | "INVALID_ARGUMENT" } & { details: undefined | string }>
Sets the ad group status to archived. This same operation can be performed via an update, but is included for completeness Archived entities cannot be made active again. See developer notes for more information.

Returns
Parameters
- adGroupId: number
Returns Promise<{ adGroupId: number; code: "NOT_FOUND" | "SUCCESS" | "INVALID_ARGUMENT" } & { details: undefined | string }>
- Defined in src/operations/ad-groups/base-ad-group-operation.ts:73

createAdGroups

createAdGroups(adGroups: { campaignId: number; defaultBid: number; name: string; state: "paused" | "enabled" | "archived" }[]): Promise<({ adGroupId: number; code: "NOT_FOUND" | "SUCCESS" | "INVALID_ARGUMENT" } & { details: undefined | string })[]>
Creates one or more ad groups. Successfully created ad groups will be assigned a unique adGroupId

Returns
Parameters
- adGroups: { campaignId: number; defaultBid: number; name: string; state: "paused" | "enabled" | "archived" }[]
Returns Promise<({ adGroupId: number; code: "NOT_FOUND" | "SUCCESS" | "INVALID_ARGUMENT" } & { details: undefined | string })[]>
- Defined in src/operations/ad-groups/base-ad-group-operation.ts:49

getAdGroup

getAdGroup(adGroupId: number): Promise<{ adGroupId: number; campaignId: number; defaultBid: number; name: string; state: "paused" | "enabled" | "archived" }>
Retrieves an ad group by ID. Note that this call returns the minimal set of ad group fields, but is more efficient than getAdGroupExtended

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

getAdGroupExtended

getAdGroupExtended(adGroupId: number): Promise<{ adGroupId: number; campaignId: number; defaultBid: number; name: string; state: "paused" | "enabled" | "archived" } & { creationDate: Date; lastUpdatedDate: Date; servingStatus: "CAMPAIGN_ARCHIVED" | "CAMPAIGN_PAUSED" | "ADVERTISER_PAYMENT_FAILURE" | "CAMPAIGN_OUT_OF_BUDGET" | "ACCOUNT_OUT_OF_BUDGET" | "PORTFOLIO_ENDED" | "CAMPAIGN_INCOMPLETE" | "ENDED" | "AD_GROUP_ARCHIVED" | "AD_GROUP_INCOMPLETE" | "AD_GROUP_PAUSED" | "AD_GROUP_STATUS_ENABLED" | "AD_POLICING_SUSPENDED" | "PORTFOLIO_PENDING_START_DATE" }>
Retrieves an ad group and its extended fields by ID. Note that this call returns the complete set of ad group fields (including serving status and other read-only fields), but is less efficient than getAdGroup

Returns
Parameters
- adGroupId: number
Returns Promise<{ adGroupId: number; campaignId: number; defaultBid: number; name: string; state: "paused" | "enabled" | "archived" } & { creationDate: Date; lastUpdatedDate: Date; servingStatus: "CAMPAIGN_ARCHIVED" | "CAMPAIGN_PAUSED" | "ADVERTISER_PAYMENT_FAILURE" | "CAMPAIGN_OUT_OF_BUDGET" | "ACCOUNT_OUT_OF_BUDGET" | "PORTFOLIO_ENDED" | "CAMPAIGN_INCOMPLETE" | "ENDED" | "AD_GROUP_ARCHIVED" | "AD_GROUP_INCOMPLETE" | "AD_GROUP_PAUSED" | "AD_GROUP_STATUS_ENABLED" | "AD_POLICING_SUSPENDED" | "PORTFOLIO_PENDING_START_DATE" }>
- Defined in src/operations/ad-groups/base-ad-group-operation.ts:38

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" }[]>
Retrieves a list of ad groups satisfying optional 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/base-ad-group-operation.ts:84

listAdGroupsExtended

listAdGroupsExtended(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" } & { creationDate: Date; lastUpdatedDate: Date; servingStatus: "CAMPAIGN_ARCHIVED" | "CAMPAIGN_PAUSED" | "ADVERTISER_PAYMENT_FAILURE" | "CAMPAIGN_OUT_OF_BUDGET" | "ACCOUNT_OUT_OF_BUDGET" | "PORTFOLIO_ENDED" | "CAMPAIGN_INCOMPLETE" | "ENDED" | "AD_GROUP_ARCHIVED" | "AD_GROUP_INCOMPLETE" | "AD_GROUP_PAUSED" | "AD_GROUP_STATUS_ENABLED" | "AD_POLICING_SUSPENDED" | "PORTFOLIO_PENDING_START_DATE" })[]>
Retrieves a list of ad groups with extended fields satisfying optional filtering 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" } & { creationDate: Date; lastUpdatedDate: Date; servingStatus: "CAMPAIGN_ARCHIVED" | "CAMPAIGN_PAUSED" | "ADVERTISER_PAYMENT_FAILURE" | "CAMPAIGN_OUT_OF_BUDGET" | "ACCOUNT_OUT_OF_BUDGET" | "PORTFOLIO_ENDED" | "CAMPAIGN_INCOMPLETE" | "ENDED" | "AD_GROUP_ARCHIVED" | "AD_GROUP_INCOMPLETE" | "AD_GROUP_PAUSED" | "AD_GROUP_STATUS_ENABLED" | "AD_POLICING_SUSPENDED" | "PORTFOLIO_PENDING_START_DATE" })[]>
- Defined in src/operations/ad-groups/base-ad-group-operation.ts:95

updateAdGroups

updateAdGroups(adGroups: ({ adGroupId: number } & { defaultBid: undefined | number; name: undefined | string; state: undefined | "paused" | "enabled" | "archived" })[]): Promise<({ adGroupId: number; code: "NOT_FOUND" | "SUCCESS" | "INVALID_ARGUMENT" } & { details: undefined | string })[]>
Updates one or more ad groups. Ad groups are identified using their adGroupId

Returns
Parameters
- adGroups: ({ adGroupId: number } & { defaultBid: undefined | number; name: undefined | string; state: undefined | "paused" | "enabled" | "archived" })[]
Returns Promise<({ adGroupId: number; code: "NOT_FOUND" | "SUCCESS" | "INVALID_ARGUMENT" } & { details: undefined | string })[]>
- Defined in src/operations/ad-groups/base-ad-group-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 BaseAdGroupOperation

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: HttpClient

Returns BaseAdGroupOperation

Methods

archiveAdGroup

Returns

Parameters

adGroupId: number

Returns Promise<{ adGroupId: number; code: "NOT_FOUND" | "SUCCESS" | "INVALID_ARGUMENT" } & { details: undefined | string }>

createAdGroups

Returns

Parameters

adGroups: { campaignId: number; defaultBid: number; name: string; state: "paused" | "enabled" | "archived" }[]

Returns Promise<({ adGroupId: number; code: "NOT_FOUND" | "SUCCESS" | "INVALID_ARGUMENT" } & { details: undefined | string })[]>

getAdGroup

Returns

Parameters

adGroupId: number

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

getAdGroupExtended

Returns

Parameters

adGroupId: number

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" }[]>

listAdGroupsExtended

Returns

Parameters

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

updateAdGroups

Returns

Parameters

adGroups: ({ adGroupId: number } & { defaultBid: undefined | number; name: undefined | string; state: undefined | "paused" | "enabled" | "archived" })[]

Returns Promise<({ adGroupId: number; code: "NOT_FOUND" | "SUCCESS" | "INVALID_ARGUMENT" } & { details: undefined | string })[]>

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")[] }

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

`Static` create