nodejs-google-adwords
Version:
Google Ads API Client Library for Node.js
254 lines (253 loc) • 10.7 kB
JavaScript
;
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 };
}
};
Object.defineProperty(exports, "__esModule", { value: true });
var core_1 = require("../../core");
var adwords_1 = require("../../../types/adwords");
var Criterion_1 = require("./enum/Criterion");
exports.Criterion = Criterion_1.Criterion;
var CriterionUse_1 = require("./enum/CriterionUse");
var AdGroupCriterionService = /** @class */ (function (_super) {
__extends(AdGroupCriterionService, _super);
function AdGroupCriterionService(options) {
var _this = _super.call(this) || this;
_this.soapService = options.soapService;
return _this;
}
AdGroupCriterionService.setType = function (operand) {
if (AdGroupCriterionService.isBiddableAdGroupCriterion(operand)) {
operand.attributes = { 'xsi:type': 'BiddableAdGroupCriterion' };
}
else if (AdGroupCriterionService.isNegativeAdGroupCriterion(operand)) {
operand.attributes = { 'xsi:type': 'NegativeAdGroupCriterion' };
}
if (operand.criterion) {
if (AdGroupCriterionService.isKeyword(operand.criterion)) {
operand.criterion.attributes = { 'xsi:type': 'Keyword' };
}
else if (AdGroupCriterionService.isGender(operand.criterion)) {
operand.criterion.attributes = { 'xsi:type': 'Gender' };
}
else if (AdGroupCriterionService.isAgeRange(operand.criterion)) {
operand.criterion.attributes = { 'xsi:type': 'AgeRange' };
}
}
return operand;
};
AdGroupCriterionService.isBiddableAdGroupCriterion = function (operand) {
return operand.criterionUse === CriterionUse_1.CriterionUse.BIDDABLE;
};
AdGroupCriterionService.isNegativeAdGroupCriterion = function (operand) {
return operand.criterionUse === CriterionUse_1.CriterionUse.NEGATIVE;
};
AdGroupCriterionService.isKeyword = function (criterion) {
return 'matchType' in criterion;
};
AdGroupCriterionService.isGender = function (criterion) {
return 'genderType' in criterion;
};
AdGroupCriterionService.isAgeRange = function (criterion) {
return 'ageRangeType' in criterion;
};
AdGroupCriterionService.prototype.getByAdGroupIds = function (adGroupIds) {
return __awaiter(this, void 0, void 0, function () {
var serviceSelector;
return __generator(this, function (_a) {
serviceSelector = {
fields: AdGroupCriterionService.selectorFields,
predicates: [
{
field: 'AdGroupId',
operator: adwords_1.Predicate.Operator.IN,
values: adGroupIds,
},
],
};
return [2 /*return*/, this.get(serviceSelector)];
});
});
};
AdGroupCriterionService.prototype.getKeywordCriterionByAdGroupIds = function (adGroupIds) {
return __awaiter(this, void 0, void 0, function () {
var serviceSelector;
return __generator(this, function (_a) {
serviceSelector = {
fields: AdGroupCriterionService.selectorFields,
predicates: [
{
field: 'AdGroupId',
operator: adwords_1.Predicate.Operator.IN,
values: adGroupIds,
},
{
field: 'CriteriaType',
operator: adwords_1.Predicate.Operator.EQUALS,
values: [Criterion_1.Criterion.Type.KEYWORD],
},
],
};
return [2 /*return*/, this.get(serviceSelector)];
});
});
};
/**
* add ad group criterion such as Keyword, Gender. Support partial failure
* https://developers.google.com/adwords/api/docs/guides/partial-failure
*
* @author dulin
* @param {(Array<IBiddableAdGroupCriterion | INegativeAdGroupCriterion>)} adGroupCriterions
* @returns
* @memberof AdGroupCriterionService
*/
AdGroupCriterionService.prototype.add = function (adGroupCriterions) {
return __awaiter(this, void 0, void 0, function () {
var operaions;
return __generator(this, function (_a) {
operaions = adGroupCriterions.map(function (adGroupCriterion) {
var adGroupCriterionOperation = {
operator: adwords_1.Operator.ADD,
operand: AdGroupCriterionService.setType(adGroupCriterion),
};
return adGroupCriterionOperation;
});
return [2 /*return*/, this.mutate(operaions)];
});
});
};
AdGroupCriterionService.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;
})];
});
});
};
AdGroupCriterionService.prototype.mutate = function (operaions) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
return [2 /*return*/, this.soapService
.mutateAsync(operaions, /** operationType = */ 'AdGroupCriterionOperation')
.then(function (rval) {
return rval;
})];
});
});
};
AdGroupCriterionService.selectorFields = [
'AdGroupId',
'AgeRangeType',
'AppId',
'AppPaymentModelType',
'ApprovalStatus',
'BaseAdGroupId',
'BaseCampaignId',
'BidModifier',
'BiddingStrategyId',
'BiddingStrategyName',
'BiddingStrategySource',
'BiddingStrategyType',
'CaseValue',
'ChannelId',
'ChannelName',
'CpcBid',
'CpcBidSource',
'CpmBid',
'CpmBidSource',
'CriteriaCoverage',
'CriteriaSamples',
'CriteriaType',
'CriterionUse',
'CustomAffinityId',
'CustomIntentId',
'DisapprovalReasons',
'DisplayName',
'EnhancedCpcEnabled',
'FinalAppUrls',
'FinalMobileUrls',
'FinalUrlSuffix',
'FinalUrls',
'FirstPageCpc',
'FirstPositionCpc',
'GenderType',
'Id',
'IncomeRangeType',
'KeywordMatchType',
'KeywordText',
'Labels',
'MobileAppCategoryId',
'Parameter',
'ParentCriterionId',
'ParentType',
'PartitionType',
'Path',
'PlacementUrl',
'QualityScore',
'Status',
'SystemServingStatus',
'TopOfPageCpc',
'TrackingUrlTemplate',
'UrlCustomParameters',
'UserInterestId',
'UserInterestName',
'UserInterestParentId',
'UserListEligibleForDisplay',
'UserListEligibleForSearch',
'UserListId',
'UserListMembershipStatus',
'UserListName',
'VerticalId',
'VerticalParentId',
'VideoId',
'VideoName',
];
return AdGroupCriterionService;
}(core_1.AdwordsOperartionService));
exports.AdGroupCriterionService = AdGroupCriterionService;