nodejs-google-adwords
Version:
Google Ads API Client Library for Node.js
77 lines (76 loc) • 2.89 kB
TypeScript
import { SoapService } from '../../core';
import { ISelector, IPaging } from '../../../types/adwords';
import { AdwordsOperartionService } from '../../core/AdwordsOperationService';
import { ICampaignOperation } from './CampaignOperation';
import { ICampaignReturnValue } from './CampaignReturnValue';
import { ICampaignPage } from './CampaignPage';
import { ICampaign } from './Campaign';
import { ICampaignLabelOperation } from './CampaignLabelOperation';
import { ICampaignLabelReturnValue } from './CampaignLabelReturnValue';
import { ICampaignLabel } from './CampaignLabel';
interface ICampaignServiceOpts {
soapService: SoapService;
}
/**
*
* @author dulin
* @class CampaignService
* @extends {AdWordsService}
*/
declare class CampaignService extends AdwordsOperartionService {
static readonly dateFormat: string;
/**
* https://developers.google.com/adwords/api/docs/appendix/selectorfields#v201809-CampaignService
*
* @private
* @static
* @memberof CampaignService
*/
private static readonly selectorFields;
private soapService;
constructor(options: ICampaignServiceOpts);
/**
* get all campaigns
*
* @author dulin
* @returns
* @memberof CampaignService
*/
getAll(): Promise<ICampaignPage | undefined>;
getByPage(paging: IPaging): Promise<ICampaignPage | undefined>;
getById(id: string): Promise<ICampaignPage | undefined>;
/**
* get all enabled campaigns
*
* @author dulin
* @returns
* @memberof CampaignService
*/
getAllEnabled(): Promise<ICampaignPage | undefined>;
/**
* get all campaigns but removed
*
* @author dulin
* @returns
* @memberof CampaignService
*/
getAllButRemoved(): Promise<ICampaignPage | undefined>;
add(campaign: ICampaign): Promise<ICampaignReturnValue>;
update(campaign: ICampaign): Promise<ICampaignReturnValue>;
remove(campaignId: string): Promise<ICampaignReturnValue>;
addLabel(campaignLabel: ICampaignLabel): Promise<ICampaignLabelReturnValue | undefined>;
protected mutateLabelAsync<Operation = ICampaignLabelOperation, Rval = ICampaignLabelReturnValue>(operations: Operation[]): Promise<Rval | undefined>;
protected mutate<Operation = ICampaignOperation, Rval = ICampaignReturnValue>(operations: Operation[]): Promise<Rval>;
protected get<ServiceSelector = ISelector, Rval = ICampaignPage>(serviceSelector: ServiceSelector): Promise<Rval | undefined>;
private setType;
}
export { CampaignService, ICampaignServiceOpts };
export * from './Budget';
export * from './Campaign';
export * from './CampaignPage';
export * from './CampaignOperation';
export * from './CampaignReturnValue';
export * from './enum/CampaignStatus';
export * from './enum/AdvertisingChannelType';
export * from './enum/BidSource';
export * from './enum/ServingStatus';