nodejs-google-adwords
Version:
Google Ads API Client Library for Node.js
376 lines (375 loc) • 14.7 kB
JavaScript
"use strict";
var __extends = (this && this.__extends) || (function () {
var extendStatics = function (d, b) {
extendStatics = Object.setPrototypeOf ||
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
return extendStatics(d, b);
};
return function (d, b) {
extendStatics(d, b);
function __() { this.constructor = d; }
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
};
})();
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
function __export(m) {
for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
}
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
var lodash_1 = __importDefault(require("lodash"));
var adwords_1 = require("../../../types/adwords");
var AdwordsOperationService_1 = require("../../core/AdwordsOperationService");
var Predicate_1 = require("./enum/Predicate");
var CampaignStatus_1 = require("./enum/CampaignStatus");
var ServingStatus_1 = require("./enum/ServingStatus");
/**
*
* @author dulin
* @class CampaignService
* @extends {AdWordsService}
*/
var CampaignService = /** @class */ (function (_super) {
__extends(CampaignService, _super);
function CampaignService(options) {
var _this = _super.call(this) || this;
_this.soapService = options.soapService;
return _this;
}
/**
* get all campaigns
*
* @author dulin
* @returns
* @memberof CampaignService
*/
CampaignService.prototype.getAll = function () {
return __awaiter(this, void 0, void 0, function () {
var serviceSelector;
return __generator(this, function (_a) {
serviceSelector = {
fields: CampaignService.selectorFields,
predicates: [
{
field: 'Status',
operator: Predicate_1.Predicate.Operator.IN,
values: [CampaignStatus_1.CampaignStatus.ENABLED, CampaignStatus_1.CampaignStatus.PAUSED, CampaignStatus_1.CampaignStatus.REMOVED],
},
],
};
return [2 /*return*/, this.get(serviceSelector)];
});
});
};
CampaignService.prototype.getByPage = function (paging) {
return __awaiter(this, void 0, void 0, function () {
var defaultPaging, serviceSelector;
return __generator(this, function (_a) {
defaultPaging = {
startIndex: 0,
numberResults: 5,
};
serviceSelector = {
fields: CampaignService.selectorFields,
paging: lodash_1.default.defaults(paging, defaultPaging),
};
return [2 /*return*/, this.get(serviceSelector)];
});
});
};
CampaignService.prototype.getById = function (id) {
return __awaiter(this, void 0, void 0, function () {
var serviceSelector;
return __generator(this, function (_a) {
serviceSelector = {
fields: CampaignService.selectorFields,
predicates: [
{
field: 'Id',
operator: Predicate_1.Predicate.Operator.EQUALS,
values: [id],
},
],
};
return [2 /*return*/, this.get(serviceSelector)];
});
});
};
/**
* get all enabled campaigns
*
* @author dulin
* @returns
* @memberof CampaignService
*/
CampaignService.prototype.getAllEnabled = function () {
return __awaiter(this, void 0, void 0, function () {
var serviceSelector;
return __generator(this, function (_a) {
serviceSelector = {
fields: ['Id', 'BudgetId', 'Name'],
predicates: [
{
field: 'ServingStatus',
operator: Predicate_1.Predicate.Operator.IN,
values: [ServingStatus_1.ServingStatus.SERVING],
},
],
};
return [2 /*return*/, this.get(serviceSelector)];
});
});
};
/**
* get all campaigns but removed
*
* @author dulin
* @returns
* @memberof CampaignService
*/
CampaignService.prototype.getAllButRemoved = function () {
return __awaiter(this, void 0, void 0, function () {
var serviceSelector;
return __generator(this, function (_a) {
serviceSelector = {
fields: ['Id', 'BudgetId', 'Name'],
predicates: [
{
field: 'Status',
operator: Predicate_1.Predicate.Operator.NOT_IN,
values: [CampaignStatus_1.CampaignStatus.REMOVED],
},
],
};
return [2 /*return*/, this.get(serviceSelector)];
});
});
};
CampaignService.prototype.add = function (campaign) {
return __awaiter(this, void 0, void 0, function () {
var operations;
return __generator(this, function (_a) {
operations = [
{
operator: adwords_1.Operator.ADD,
operand: this.setType(campaign),
},
];
return [2 /*return*/, this.mutate(operations)];
});
});
};
CampaignService.prototype.update = function (campaign) {
return __awaiter(this, void 0, void 0, function () {
var operation;
return __generator(this, function (_a) {
operation = [
{
operator: adwords_1.Operator.SET,
operand: campaign,
},
];
return [2 /*return*/, this.mutate(operation)];
});
});
};
CampaignService.prototype.remove = function (campaignId) {
return __awaiter(this, void 0, void 0, function () {
var campaign, operations;
return __generator(this, function (_a) {
campaign = {
id: campaignId,
status: CampaignStatus_1.CampaignStatus.REMOVED,
};
operations = [
{
operator: adwords_1.Operator.SET,
operand: campaign,
},
];
return [2 /*return*/, this.mutate(operations)];
});
});
};
CampaignService.prototype.addLabel = function (campaignLabel) {
return __awaiter(this, void 0, void 0, function () {
var operations;
return __generator(this, function (_a) {
operations = [
{
operator: adwords_1.Operator.ADD,
operand: campaignLabel,
},
];
return [2 /*return*/, this.mutateLabelAsync(operations)];
});
});
};
CampaignService.prototype.mutateLabelAsync = function (operations) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
return [2 /*return*/, this.soapService
.mutateLabelAsync(operations, 'CampaignLabelOperation')
.then(function (rval) {
return rval;
})];
});
});
};
CampaignService.prototype.mutate = function (operations) {
return __awaiter(this, void 0, void 0, function () {
var rval, error_1;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
_a.trys.push([0, 2, , 3]);
return [4 /*yield*/, this.soapService.mutateAsync(operations, 'CampaignOperation')];
case 1:
rval = _a.sent();
return [2 /*return*/, rval];
case 2:
error_1 = _a.sent();
throw error_1;
case 3: return [2 /*return*/];
}
});
});
};
CampaignService.prototype.get = function (serviceSelector) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
return [2 /*return*/, this.soapService.get(serviceSelector).then(function (rval) {
return rval;
})];
});
});
};
CampaignService.prototype.setType = function (operand) {
if (operand.settings) {
operand.settings.attributes = {
'xsi:type': 'GeoTargetTypeSetting',
};
}
if (operand.biddingStrategyConfiguration &&
operand.biddingStrategyConfiguration.bids &&
operand.biddingStrategyConfiguration.bids.length) {
var bids = operand.biddingStrategyConfiguration.bids;
bids = bids.map(function (bid) {
bid.attributes = {
'xsi:type': bid['Bids.Type'],
};
delete bid['Bids.Type'];
return bid;
});
operand.biddingStrategyConfiguration.bids = bids;
}
return operand;
};
CampaignService.dateFormat = 'YYYYMMDD';
/**
* https://developers.google.com/adwords/api/docs/appendix/selectorfields#v201809-CampaignService
*
* @private
* @static
* @memberof CampaignService
*/
CampaignService.selectorFields = [
'AdServingOptimizationStatus',
'AdvertisingChannelSubType',
'AdvertisingChannelType',
'Amount',
'AppId',
'AppVendor',
'BaseCampaignId',
'BiddingStrategyGoalType',
'BiddingStrategyId',
'BiddingStrategyName',
'BiddingStrategyType',
'BudgetId',
'BudgetName',
'BudgetReferenceCount',
'BudgetStatus',
'CampaignGroupId',
'CampaignTrialType',
'DeliveryMethod',
'Eligible',
'EndDate',
'EnhancedCpcEnabled',
'FinalUrlSuffix',
'FrequencyCapMaxImpressions',
'Id',
'IsBudgetExplicitlyShared',
'Labels',
'Level',
'MaximizeConversionValueTargetRoas',
'Name',
'RejectionReasons',
'SelectiveOptimization',
'ServingStatus',
'Settings',
'StartDate',
'Status',
'TargetContentNetwork',
'TargetCpa',
'TargetCpaMaxCpcBidCeiling',
'TargetCpaMaxCpcBidFloor',
'TargetGoogleSearch',
'TargetPartnerSearchNetwork',
'TargetRoas',
'TargetRoasBidCeiling',
'TargetRoasBidFloor',
'TargetSearchNetwork',
'TargetSpendBidCeiling',
'TargetSpendSpendTarget',
'TimeUnit',
'TrackingUrlTemplate',
'UrlCustomParameters',
'VanityPharmaDisplayUrlMode',
'VanityPharmaText',
'ViewableCpmEnabled',
];
return CampaignService;
}(AdwordsOperationService_1.AdwordsOperartionService));
exports.CampaignService = CampaignService;
__export(require("./enum/CampaignStatus"));
__export(require("./enum/AdvertisingChannelType"));
__export(require("./enum/BidSource"));
__export(require("./enum/ServingStatus"));