remove console.log

Author: mrdulin

.vscode/launch.json

@@ -9,7 +9,7 @@
       "request": "launch",
       "name": "Jest Current File",
       "program": "${workspaceFolder}/node_modules/.bin/jest",
-      "args": ["${fileBasenameNoExtension}", "--config", "jest.config.js"],
+      "args": ["${fileBasenameNoExtension}", "--config", "jest.config.js", "--detectOpenHandles"],
       "console": "integratedTerminal",
       "internalConsoleOptions": "neverOpen",
       "disableOptimisticBPs": true,

readme.md

@@ -46,12 +46,79 @@ ADWORDS_REFRESH_TOKEN=<OAuth Refresh Token>
 
 Put above environment variables into `.env` file for local development.
 
+## Usage
+
+Initialize `AdwordsService` with above environment variables
+
+```ts
+const adwordsService = new AdWordsService({
+  clientCustomerId: credentials.ADWORDS_CLIENT_CUSTOMER_ID,
+  developerToken: credentials.ADWORDS_DEVELOPER_TOKEN,
+  userAgent: credentials.ADWORDS_USER_AGENT,
+  clientId: credentials.ADWORDS_CLIENT_ID,
+  clientSecret: credentials.ADWORDS_SECRET,
+  credentials: {
+    refresh_token: credentials.ADWORDS_REFRESH_TOKEN,
+  },
+});
+```
+
+Get budgets by page:
+
+```ts
+async function getByPage() {
+  const budgetService = adwordsService.getService('BudgetService');
+  const paging: IPaging = {
+    startIndex: 0,
+    numberResults: 2,
+  };
+  const actualValue = await budgetService.getByPage(paging);
+}
+```
+
+Create a budget:
+
+```ts
+async function createBudget() {
+  const budgetService = adwordsService.getService('BudgetService');
+
+  const budget: IBudget = {
+    name: faker.lorem.word(),
+    amount: {
+      microAmount: BudgetService.UNIT,
+    },
+    deliveryMethod: Budget.BudgetDeliveryMethod.STANDARD,
+    isExplicitlyShared: false,
+    status: Budget.BudgetStatus.ENABLED,
+  };
+
+  const actualValue = await budgetService.add(budget);
+}
+```
+
+Get campaigns by page:
+
+```ts
+async function getCampaignsByPages() {
+  const paging: IPaging = {
+    startIndex: 0,
+    numberResults: 1,
+  };
+  const actualValue = await campaignService.getByPage(paging);
+}
+```
+
+Same usage for other Google Adwords resources
+
 ## TODO
 
 - [ ] <https://developers.google.com/adwords/api/docs/guides/batch-jobs>
 - [ ] <http://adwordsapi.blogspot.in/2011/03/concurrency-management-in-adwords-api.html>
+- [ ] Add model layer and object schema validation
+- [ ] Improve error handling
+- [ ] Improve `TypeScript` types
 
-## references
+## References
 
 - <https://developers.google.com/adwords/api/docs/reference/release-notes/v201809?refresh=1>
 - <https://github.com/googleads/googleads-python-lib/wiki>

src/__tests__/services/adwords/BudgetService/BudgetService.spec.ts

@@ -2,15 +2,15 @@ import faker from 'faker';
 
 import { adwordsService } from '../../initialize';
 import { IPaging } from '../../../../types/adwords';
-import { BudgetService, Budget } from '../../../../services/adwords/BudgetService';
+import { BudgetService, Budget, IBudget } from '../../../../services/adwords/BudgetService';
 
 describe('BudgetService test suites', () => {
   const budgetService = adwordsService.getService('BudgetService', { verbose: false });
-  it.skip('#getAll', async () => {
+  it('#getAll', async () => {
     const actualValue = await budgetService.getAll();
   });
 
-  it('#getByPage', async () => {
+  it.skip('#getByPage', async () => {
     const paging: IPaging = {
       startIndex: 0,
       numberResults: 2,
@@ -49,4 +49,9 @@ describe('BudgetService test suites', () => {
     };
     const actualValue = await budgetService.update(budget);
   });
+
+  it.skip('#remove', async () => {
+    const budgetIds: string[] = ['1902117292'];
+    const actualValue = await budgetService.remove(budgetIds);
+  });
 });

src/__tests__/services/adwords/CampaignService/CampaignService.spec.ts

@@ -1,6 +1,20 @@
+import faker from 'faker';
+import moment from 'moment';
+
 import { adwordsService } from '../../initialize';
 import { IPaging } from '../../../../types/adwords';
 import { ICampaignLabel } from '../../../../services/adwords/CampaignService/CampaignLabel';
+import {
+  ICampaign,
+  CampaignStatus,
+  CampaignService,
+  IBudget,
+  AdvertisingChannelType,
+} from '../../../../services/adwords/CampaignService';
+import { TimeUnit, Level } from '../../../../services/adwords/CampaignService/FrequencyCap';
+import { IGeoTargetTypeSetting } from '../../../../services/adwords/CampaignService/Setting';
+import { GeoTargetTypeSetting } from '../../../../services/adwords/CampaignService/enum/GeoTargetTypeSetting';
+import { BiddingStrategyType } from '../../../../services/adwords/CampaignService/BiddingStrategyConfiguration';
 
 describe('CampaignService test suites', () => {
   const campaignService = adwordsService.getService('CampaignService', {
@@ -10,7 +24,7 @@ describe('CampaignService test suites', () => {
     const actualValue = await campaignService.getAll();
   });
 
-  it('#getByPage', async () => {
+  it.skip('#getByPage', async () => {
     const paging: IPaging = {
       startIndex: 0,
       numberResults: 1,
@@ -35,6 +49,49 @@ describe('CampaignService test suites', () => {
     const actualValue = await campaignService.remove(campaignId);
   });
 
+  it('#add', async () => {
+    const budget: IBudget = {
+      budgetId: '1865779148',
+    };
+    const settings: IGeoTargetTypeSetting = {
+      positiveGeoTargetType: GeoTargetTypeSetting.PositiveGeoTargetType.DONT_CARE,
+      negativeGeoTargetType: GeoTargetTypeSetting.NegativeGeoTargetType.DONT_CARE,
+      attributes: {
+        'xsi:type': 'GeoTargetTypeSetting',
+      },
+    };
+    const campaign: ICampaign = {
+      name: faker.company.bs(),
+      status: CampaignStatus.ENABLED,
+      startDate: moment()
+        .add(1, 'd')
+        .format(CampaignService.dateFormat),
+      endDate: moment()
+        .add(2, 'd')
+        .format(CampaignService.dateFormat),
+      budget,
+      biddingStrategyConfiguration: {
+        biddingStrategyName: faker.lorem.word(),
+        biddingStrategyType: BiddingStrategyType.MANUAL_CPC,
+      },
+      frequencyCap: {
+        impressions: 10,
+        timeUnit: TimeUnit.DAY,
+        level: Level.CAMPAIGN,
+      },
+      settings,
+      advertisingChannelType: AdvertisingChannelType.SEARCH,
+      networkSetting: {
+        targetContentNetwork: true,
+        targetGoogleSearch: true,
+        targetPartnerSearchNetwork: false,
+        targetSearchNetwork: true,
+      },
+    };
+
+    const actualValue = await campaignService.add(campaign);
+  });
+
   it.skip('#addLabel', async () => {
     // properties order is important
     const campaignLabel: ICampaignLabel = {

src/__tests__/services/initialize.ts

@@ -10,8 +10,6 @@ const adwordsService = new AdWordsService({
   credentials: {
     refresh_token: credentials.ADWORDS_REFRESH_TOKEN,
   },
-  // validateOnly: true,
-  // partialFailure: true
 });
 adwordsService.setVerbose(false);
 

src/services/adwords/AdGroupAdService/Ad.ts

@@ -8,7 +8,7 @@ import { IImage } from './Media';
 import { IDynamicSettings } from './DynamicSettings';
 import { DisplayAdFormatSetting } from './enum/DisplayAdFormatSetting';
 
-interface IAdRaw<Type> {
+interface IAdRaw<Type> extends IAttributes<Type> {
   id: string;
   url: string;
   displayUrl: string;
@@ -24,7 +24,6 @@ interface IAdRaw<Type> {
   devicePreference: string;
   readonly systemManagedEntitySource: SystemManagedEntitySource;
   'Ad.Type': string;
-  attributes: IAttributes<Type>;
 }
 
 interface IAd<Type = ''> extends Partial<IAdRaw<Type>> {}

src/services/adwords/AdGroupAdService/Media.ts

@@ -3,7 +3,7 @@ import { IMedia_Size_DimensionsMapEntry } from './Media_Size_DimensionsMapEntry'
 import { IMedia_Size_StringMapEntry } from './Media_Size_StringMapEntry';
 import { IAttributes } from '../../../types/adwords/Attributes';
 
-interface IMediaRaw<Type> {
+interface IMediaRaw<Type> extends IAttributes<Type> {
   mediaId: string;
   type: Media.MediaType;
   referenceId: string;
@@ -15,7 +15,6 @@ interface IMediaRaw<Type> {
   fileSize: string;
   creationTime: string;
   'Media.Type': string;
-  attributes: IAttributes<Type>;
 }
 
 interface IMedia<Type> extends Partial<IMediaRaw<Type>> {}

src/services/adwords/AdGroupCriterionService/AdGroupCriterionOperation.ts

@@ -1,11 +1,8 @@
 import { IOperation } from '../../../types/adwords';
 import { IBiddableAdGroupCriterion, INegativeAdGroupCriterion } from './AdGroupCriterion';
 
-export interface IAdGroupCriterionOperation extends IOperation {
+export interface IAdGroupCriterionOperation extends IOperation<'AdGroupCriterionOperation'> {
   operand: IBiddableAdGroupCriterion | INegativeAdGroupCriterion;
   // TODO:
   exemptionRequests?: any[];
-  attributes?: {
-    'xsi:type': 'AdGroupCriterionOperation';
-  };
 }

src/services/adwords/AdGroupService/AdGroupOperation.ts

@@ -1,6 +1,6 @@
 import { IOperation } from '../../../types/adwords';
 import { IAdGroup } from './AdGroup';
 
-export interface IAdGroupOperation extends IOperation {
+export interface IAdGroupOperation extends IOperation<'AdGroupOperation'> {
   operand: IAdGroup;
 }

src/services/adwords/AdGroupService/index.ts

@@ -10,6 +10,14 @@ import { IAdGroup } from './AdGroup';
 interface IAdGroupServiceOpts {
   soapService: SoapService;
 }
+
+/**
+ * https://developers.google.com/adwords/api/docs/reference/v201809/AdGroupService
+ *
+ * @author dulin
+ * @class AdGroupService
+ * @extends {AdwordsOperartionService}
+ */
 class AdGroupService extends AdwordsOperartionService {
   /**
    * https://developers.google.com/adwords/api/docs/appendix/selectorfields?hl=zh-cn#v201809-AdGroupService
@@ -87,6 +95,9 @@ class AdGroupService extends AdwordsOperartionService {
       {
         operator: Operator.ADD,
         operand: adGroup,
+        attributes: {
+          'xsi:type': 'AdGroupOperation',
+        },
       },
     ];
     return this.mutate(operations);

src/services/adwords/BudgetService/index.ts

@@ -96,11 +96,14 @@ class BudgetService extends AdwordsOperartionService {
 
   public async add(budget: IBudget) {
     // TODO: validate budget
-    const operation: IBudgetOperation = {
-      operator: Operator.ADD,
-      operand: budget,
-    };
-    return this.mutate([operation]);
+    // TODO: support multiple add
+    const operations: IBudgetOperation[] = [
+      {
+        operator: Operator.ADD,
+        operand: budget,
+      },
+    ];
+    return this.mutate(operations);
   }
 
   public async update(budget: IBudget) {
@@ -111,6 +114,19 @@ class BudgetService extends AdwordsOperartionService {
     return this.mutate([operation]);
   }
 
+  public async remove(budgetIds: string[]) {
+    const operations: IBudgetOperation[] = budgetIds.map((budgetId: string) => {
+      const operand: IBudget = { budgetId };
+      const operation: IBudgetOperation = {
+        operator: Operator.REMOVE,
+        operand,
+      };
+      return operation;
+    });
+
+    return this.mutate(operations);
+  }
+
   protected async get<ServiceSelector = ISelector, Rval = IBudgetPage>(
     serviceSelector: ServiceSelector,
   ): Promise<Rval | undefined> {

src/services/adwords/CampaignCriterionService/CampaignCriterionOperation.ts

@@ -1,9 +1,6 @@
 import { IOperation } from '../../../types/adwords';
 import { INegativeCampaignCriterion, ICampaignCriterion } from './CampaignCriterion';
 
-export interface ICampaignCriterionOperation extends IOperation {
+export interface ICampaignCriterionOperation extends IOperation<'CampaignCriterionOperation'> {
   operand: INegativeCampaignCriterion | ICampaignCriterion;
-  attributes: {
-    'xsi:type': 'CampaignCriterionOperation';
-  };
 }

src/services/adwords/CampaignService/BiddingStrategyConfiguration.ts

@@ -21,14 +21,14 @@ enum BiddingStrategySource {
 }
 
 interface IBiddingStrategyConfiguration {
-  biddingStrategyId: string;
+  biddingStrategyId?: string;
   biddingStrategyName: string;
   biddingStrategyType: BiddingStrategyType;
   readonly biddingStrategySource?: BiddingStrategySource;
   // TODO:
-  biddingScheme: any;
-  bids: Array<ICpcBid | ICpaBid | ICpmBid>;
-  targetRoasOverride: number;
+  biddingScheme?: any;
+  bids?: Array<ICpcBid | ICpaBid | ICpmBid>;
+  targetRoasOverride?: number;
 }
 
-export { IBiddingStrategyConfiguration };
+export { IBiddingStrategyConfiguration, BiddingStrategyType };

src/services/adwords/CampaignService/Campaign.ts

@@ -3,7 +3,7 @@ import { INetworkSetting } from './NetworkSetting';
 import { ITextLabel } from './Label';
 import { IFrequencyCap } from './FrequencyCap';
 import { IConversionOptimizerEligibility } from './ConversionOptimizerEligibility';
-import { ISetting } from './Setting';
+import { IGeoTargetTypeSetting } from './Setting';
 import { IBiddingStrategyConfiguration } from './BiddingStrategyConfiguration';
 import { CampaignStatus } from './enum/CampaignStatus';
 import { ServingStatus } from './enum/ServingStatus';
@@ -23,10 +23,11 @@ interface ICampaignRaw {
   startDate: string;
   endDate: string;
   budget: IBudget;
-  conversionOptimizerEligibility: IConversionOptimizerEligibility;
+  readonly conversionOptimizerEligibility: IConversionOptimizerEligibility;
   adServingOptimizationStatus: AdServingOptimizationStatus;
   frequencyCap: IFrequencyCap;
-  settings: ISetting[];
+  // TODO: add more settings
+  settings: IGeoTargetTypeSetting | any;
   advertisingChannelType: AdvertisingChannelType;
   advertisingChannelSubType: AdvertisingChannelSubType;
   networkSetting: INetworkSetting;
@@ -39,7 +40,7 @@ interface ICampaignRaw {
   finalUrlSuffix: string;
   urlCustomParameters: ICustomParameters;
 
-  // TODO
+  // TODO: add types
   vanityPharma: any;
   universalAppCampaignInfo: any;
   selectiveOptimization: any;

src/services/adwords/CampaignService/CampaignLabelOperation.ts

@@ -1,6 +1,6 @@
 import { IOperation } from '../../../types/adwords';
 import { ICampaignLabel } from './CampaignLabel';
 
-export interface ICampaignLabelOperation extends IOperation {
+export interface ICampaignLabelOperation extends IOperation<'CampaignLabelOperation'> {
   operand: ICampaignLabel;
 }