Class SponsoredDisplayCampaignOperation

Hierarchy

Operation
- SponsoredDisplayCampaignOperation

Index

Constructors

Methods

archiveCampaign createCampaigns getCampaign getCampaignExtended listCampaigns listCampaignsExtended updateCampaigns create

Constructors

constructor

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

Methods

archiveCampaign

archiveCampaign(id: number): Promise<{ code: string } & { campaignId: undefined | number; description: undefined | string; details: undefined | string }>
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
- id: number
Returns Promise<{ code: string } & { campaignId: undefined | number; description: undefined | string; details: undefined | string }>
- Defined in src/operations/campaigns/sponsored-display-campaign-operation.ts:99

createCampaigns

createCampaigns(params: ({ budget: number; budgetType: "daily"; name: string; startDate: string; state: "paused" | "enabled" | "archived"; tactic: "T00001" | "T00020" | "T00030" | "remarketing" } & { endDate: undefined | string })[]): Promise<({ code: string } & { campaignId: undefined | number; description: undefined | string; details: undefined | string })[]>
Creates one or more campaigns. Successfully created campaigns will be assigned a unique campaignId.

Returns
Parameters
- params: ({ budget: number; budgetType: "daily"; name: string; startDate: string; state: "paused" | "enabled" | "archived"; tactic: "T00001" | "T00020" | "T00030" | "remarketing" } & { endDate: undefined | string })[]
Returns Promise<({ code: string } & { campaignId: undefined | number; description: undefined | string; details: undefined | string })[]>
- Defined in src/operations/campaigns/sponsored-display-campaign-operation.ts:62

getCampaign

getCampaign(id: number): Promise<{ budget: number; budgetType: "daily"; campaignId: number; name: string; startDate: string; state: "paused" | "enabled" | "archived"; tactic: "T00001" | "T00020" | "T00030" | "remarketing" } & { costType: undefined | "cpc" | "vcpm"; deliveryProfile: undefined | "as_soon_as_possible"; endDate: undefined | string }>
Returns a Campaign object for a requested campaign. Note that the Campaign object is designed for performance, with a small set of commonly used campaign fields to reduce size. If the extended set of fields is required, use the campaign operations that return the CampaignResponseEx object.

Returns
Parameters
- id: number
Returns Promise<{ budget: number; budgetType: "daily"; campaignId: number; name: string; startDate: string; state: "paused" | "enabled" | "archived"; tactic: "T00001" | "T00020" | "T00030" | "remarketing" } & { costType: undefined | "cpc" | "vcpm"; deliveryProfile: undefined | "as_soon_as_possible"; endDate: undefined | string }>
- Defined in src/operations/campaigns/sponsored-display-campaign-operation.ts:75

getCampaignExtended

getCampaignExtended(id: number): Promise<{ budget: number; budgetType: "daily"; campaignId: number; name: string; startDate: string; state: "paused" | "enabled" | "archived"; tactic: "T00001" | "T00020" | "T00030" | "remarketing" } & { costType: undefined | "cpc" | "vcpm"; deliveryProfile: undefined | "as_soon_as_possible"; endDate: undefined | string } & { creationDate: undefined | Date; lastUpdatedDate: undefined | Date; servingStatus: undefined | "CAMPAIGN_ARCHIVED" | "CAMPAIGN_PAUSED" | "CAMPAIGN_STATUS_ENABLED" | "ADVERTISER_PAYMENT_FAILURE" | "CAMPAIGN_OUT_OF_BUDGET" | "ACCOUNT_OUT_OF_BUDGET" | "PORTFOLIO_ENDED" | "CAMPAIGN_INCOMPLETE" | "PENDING_START_DATE" | "ENDED" }>
Gets an array of CampaignResponseEx objects for a set of requested campaigns.

Returns
Parameters
- id: number
Returns Promise<{ budget: number; budgetType: "daily"; campaignId: number; name: string; startDate: string; state: "paused" | "enabled" | "archived"; tactic: "T00001" | "T00020" | "T00030" | "remarketing" } & { costType: undefined | "cpc" | "vcpm"; deliveryProfile: undefined | "as_soon_as_possible"; endDate: undefined | string } & { creationDate: undefined | Date; lastUpdatedDate: undefined | Date; servingStatus: undefined | "CAMPAIGN_ARCHIVED" | "CAMPAIGN_PAUSED" | "CAMPAIGN_STATUS_ENABLED" | "ADVERTISER_PAYMENT_FAILURE" | "CAMPAIGN_OUT_OF_BUDGET" | "ACCOUNT_OUT_OF_BUDGET" | "PORTFOLIO_ENDED" | "CAMPAIGN_INCOMPLETE" | "PENDING_START_DATE" | "ENDED" }>
- Defined in src/operations/campaigns/sponsored-display-campaign-operation.ts:86

listCampaigns

listCampaigns(params?: { count: undefined | number; startIndex: undefined | number } & { campaignIdFilter: undefined | number[]; name: undefined | string; stateFilter: undefined | "paused" | "enabled" | "archived" }): Promise<({ budget: number; budgetType: "daily"; campaignId: number; name: string; startDate: string; state: "paused" | "enabled" | "archived"; tactic: "T00001" | "T00020" | "T00030" | "remarketing" } & { costType: undefined | "cpc" | "vcpm"; deliveryProfile: undefined | "as_soon_as_possible"; endDate: undefined | string })[]>
Gets an array of Campaign objects for a requested set of Sponsored Display campaigns. Note that the Campaign object is designed for performance, and includes a small set of commonly used fields to reduce size. If the extended set of fields is required, use the campaign operations that return the CampaignResponseEx object.

Returns
Parameters
- Optional params: { count: undefined | number; startIndex: undefined | number } & { campaignIdFilter: undefined | number[]; name: undefined | string; stateFilter: undefined | "paused" | "enabled" | "archived" }
Returns Promise<({ budget: number; budgetType: "daily"; campaignId: number; name: string; startDate: string; state: "paused" | "enabled" | "archived"; tactic: "T00001" | "T00020" | "T00030" | "remarketing" } & { costType: undefined | "cpc" | "vcpm"; deliveryProfile: undefined | "as_soon_as_possible"; endDate: undefined | string })[]>
- Defined in src/operations/campaigns/sponsored-display-campaign-operation.ts:26

listCampaignsExtended

listCampaignsExtended(params?: { count: undefined | number; startIndex: undefined | number } & { campaignIdFilter: undefined | number[]; name: undefined | string; stateFilter: undefined | "paused" | "enabled" | "archived" }): Promise<({ budget: number; budgetType: "daily"; campaignId: number; name: string; startDate: string; state: "paused" | "enabled" | "archived"; tactic: "T00001" | "T00020" | "T00030" | "remarketing" } & { costType: undefined | "cpc" | "vcpm"; deliveryProfile: undefined | "as_soon_as_possible"; endDate: undefined | string } & { creationDate: undefined | Date; lastUpdatedDate: undefined | Date; servingStatus: undefined | "CAMPAIGN_ARCHIVED" | "CAMPAIGN_PAUSED" | "CAMPAIGN_STATUS_ENABLED" | "ADVERTISER_PAYMENT_FAILURE" | "CAMPAIGN_OUT_OF_BUDGET" | "ACCOUNT_OUT_OF_BUDGET" | "PORTFOLIO_ENDED" | "CAMPAIGN_INCOMPLETE" | "PENDING_START_DATE" | "ENDED" })[]>
Gets an array of CampaignResponseEx objects for a set of requested campaigns.

Returns
Parameters
- Optional params: { count: undefined | number; startIndex: undefined | number } & { campaignIdFilter: undefined | number[]; name: undefined | string; stateFilter: undefined | "paused" | "enabled" | "archived" }
Returns Promise<({ budget: number; budgetType: "daily"; campaignId: number; name: string; startDate: string; state: "paused" | "enabled" | "archived"; tactic: "T00001" | "T00020" | "T00030" | "remarketing" } & { costType: undefined | "cpc" | "vcpm"; deliveryProfile: undefined | "as_soon_as_possible"; endDate: undefined | string } & { creationDate: undefined | Date; lastUpdatedDate: undefined | Date; servingStatus: undefined | "CAMPAIGN_ARCHIVED" | "CAMPAIGN_PAUSED" | "CAMPAIGN_STATUS_ENABLED" | "ADVERTISER_PAYMENT_FAILURE" | "CAMPAIGN_OUT_OF_BUDGET" | "ACCOUNT_OUT_OF_BUDGET" | "PORTFOLIO_ENDED" | "CAMPAIGN_INCOMPLETE" | "PENDING_START_DATE" | "ENDED" })[]>
- Defined in src/operations/campaigns/sponsored-display-campaign-operation.ts:37

updateCampaigns

updateCampaigns(params: ({ campaignId: number } & { budget: undefined | number; endDate: undefined | string; name: undefined | string; startDate: undefined | string; state: undefined | "paused" | "enabled" | "archived" })[]): Promise<({ code: string } & { campaignId: undefined | number; description: undefined | string; details: undefined | string })[]>
Updates one or more campaigns.

Returns
Parameters
- params: ({ campaignId: number } & { budget: undefined | number; endDate: undefined | string; name: undefined | string; startDate: undefined | string; state: undefined | "paused" | "enabled" | "archived" })[]
Returns Promise<({ code: string } & { campaignId: undefined | number; description: undefined | string; details: undefined | string })[]>
- Defined in src/operations/campaigns/sponsored-display-campaign-operation.ts:50

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

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: HttpClient

Returns SponsoredDisplayCampaignOperation

Methods

archiveCampaign

Returns

Parameters

id: number

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

createCampaigns

Returns

Parameters

params: ({ budget: number; budgetType: "daily"; name: string; startDate: string; state: "paused" | "enabled" | "archived"; tactic: "T00001" | "T00020" | "T00030" | "remarketing" } & { endDate: undefined | string })[]

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

getCampaign

Returns

Parameters

id: number

getCampaignExtended

Returns

Parameters

id: number

listCampaigns

Returns

Parameters

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

listCampaignsExtended

Returns

Parameters

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

updateCampaigns

Returns

Parameters

params: ({ campaignId: number } & { budget: undefined | number; endDate: undefined | string; name: undefined | string; startDate: undefined | string; state: undefined | "paused" | "enabled" | "archived" })[]

Returns Promise<({ code: string } & { campaignId: undefined | number; description: undefined | string; 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 } & { campaignIdFilter: undefined | number[]; name: undefined | string; stateFilter: undefined | "paused" | "enabled" | "archived" }

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

`Static` create