dfp-lib/build/src/dfp/service/productService.js

This project hosts the Node.JS client library for the SOAP-based DFP API at Google.

"use strict";
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
    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) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
        step((generator = generator.apply(thisArg, _arguments || [])).next());
    });
};
const xmlElement_1 = require("../../common/soap/xmlElement");
const product_1 = require("../soap/product");
const updateResult_1 = require("../soap/updateResult");
const productAction_1 = require("../soap/productAction");
const statement_1 = require("../soap/statement");
const productPage_1 = require("../soap/productPage");
const dfpService_1 = require("../lib/dfpService");
const objectValue_1 = require("../soap/objectValue");
const adExchangeEnvironment_1 = require("../soap/adExchangeEnvironment");
const activateProducts_1 = require("../soap/activateProducts");
const adUnitTargeting_1 = require("../soap/adUnitTargeting");
const apiError_1 = require("../soap/apiError");
const apiException_1 = require("../soap/apiException");
const technologyTargeting_1 = require("../soap/technologyTargeting");
const apiVersionError_1 = require("../soap/apiVersionError");
const applicationException_1 = require("../soap/applicationException");
const appliedLabel_1 = require("../soap/appliedLabel");
const authenticationError_1 = require("../soap/authenticationError");
const bandwidthGroup_1 = require("../soap/bandwidthGroup");
const bandwidthGroupTargeting_1 = require("../soap/bandwidthGroupTargeting");
const baseCustomFieldValue_1 = require("../soap/baseCustomFieldValue");
const baseRateError_1 = require("../soap/baseRateError");
const booleanValue_1 = require("../soap/booleanValue");
const browser_1 = require("../soap/browser");
const browserLanguage_1 = require("../soap/browserLanguage");
const browserLanguageTargeting_1 = require("../soap/browserLanguageTargeting");
const browserTargeting_1 = require("../soap/browserTargeting");
const collectionSizeError_1 = require("../soap/collectionSizeError");
const commonError_1 = require("../soap/commonError");
const contentMetadataKeyHierarchyTargeting_1 = require("../soap/contentMetadataKeyHierarchyTargeting");
const contentMetadataTargetingError_1 = require("../soap/contentMetadataTargetingError");
const contentTargeting_1 = require("../soap/contentTargeting");
const creativePlaceholder_1 = require("../soap/creativePlaceholder");
const customCriteria_1 = require("../soap/customCriteria");
const customCriteriaSet_1 = require("../soap/customCriteriaSet");
const customFieldValue_1 = require("../soap/customFieldValue");
const customFieldValueError_1 = require("../soap/customFieldValueError");
const customTargetingError_1 = require("../soap/customTargetingError");
const customCriteriaLeaf_1 = require("../soap/customCriteriaLeaf");
const customCriteriaNode_1 = require("../soap/customCriteriaNode");
const audienceSegmentCriteria_1 = require("../soap/audienceSegmentCriteria");
const customizableAttributes_1 = require("../soap/customizableAttributes");
const dfpDate_1 = require("../soap/dfpDate");
const dfpDateTime_1 = require("../soap/dfpDateTime");
const dateTimeRangeTargetingError_1 = require("../soap/dateTimeRangeTargetingError");
const dateTimeValue_1 = require("../soap/dateTimeValue");
const dateValue_1 = require("../soap/dateValue");
const dayPart_1 = require("../soap/dayPart");
const dayPartTargeting_1 = require("../soap/dayPartTargeting");
const dayPartTargetingError_1 = require("../soap/dayPartTargetingError");
const deactivateProducts_1 = require("../soap/deactivateProducts");
const deviceCapability_1 = require("../soap/deviceCapability");
const deviceCapabilityTargeting_1 = require("../soap/deviceCapabilityTargeting");
const deviceCategory_1 = require("../soap/deviceCategory");
const deviceCategoryTargeting_1 = require("../soap/deviceCategoryTargeting");
const deviceManufacturer_1 = require("../soap/deviceManufacturer");
const deviceManufacturerTargeting_1 = require("../soap/deviceManufacturerTargeting");
const dropDownCustomFieldValue_1 = require("../soap/dropDownCustomFieldValue");
const entityChildrenLimitReachedError_1 = require("../soap/entityChildrenLimitReachedError");
const featureError_1 = require("../soap/featureError");
const forecastError_1 = require("../soap/forecastError");
const frequencyCap_1 = require("../soap/frequencyCap");
const genericTargetingError_1 = require("../soap/genericTargetingError");
const geoTargeting_1 = require("../soap/geoTargeting");
const geoTargetingError_1 = require("../soap/geoTargetingError");
const internalApiError_1 = require("../soap/internalApiError");
const inventoryTargeting_1 = require("../soap/inventoryTargeting");
const inventoryTargetingError_1 = require("../soap/inventoryTargetingError");
const dfpLocation_1 = require("../soap/dfpLocation");
const mobileCarrier_1 = require("../soap/mobileCarrier");
const mobileCarrierTargeting_1 = require("../soap/mobileCarrierTargeting");
const mobileDevice_1 = require("../soap/mobileDevice");
const mobileDeviceSubmodel_1 = require("../soap/mobileDeviceSubmodel");
const mobileDeviceSubmodelTargeting_1 = require("../soap/mobileDeviceSubmodelTargeting");
const mobileDeviceTargeting_1 = require("../soap/mobileDeviceTargeting");
const money_1 = require("../soap/money");
const nonProgrammaticProductError_1 = require("../soap/nonProgrammaticProductError");
const notNullError_1 = require("../soap/notNullError");
const numberValue_1 = require("../soap/numberValue");
const operatingSystem_1 = require("../soap/operatingSystem");
const operatingSystemTargeting_1 = require("../soap/operatingSystemTargeting");
const operatingSystemVersion_1 = require("../soap/operatingSystemVersion");
const operatingSystemVersionTargeting_1 = require("../soap/operatingSystemVersionTargeting");
const parseError_1 = require("../soap/parseError");
const permissionError_1 = require("../soap/permissionError");
const productActionError_1 = require("../soap/productActionError");
const productError_1 = require("../soap/productError");
const productMarketplaceInfo_1 = require("../soap/productMarketplaceInfo");
const programmaticEntitiesError_1 = require("../soap/programmaticEntitiesError");
const programmaticProductError_1 = require("../soap/programmaticProductError");
const publisherQueryLanguageContextError_1 = require("../soap/publisherQueryLanguageContextError");
const publisherQueryLanguageSyntaxError_1 = require("../soap/publisherQueryLanguageSyntaxError");
const publishProducts_1 = require("../soap/publishProducts");
const quotaError_1 = require("../soap/quotaError");
const rangeError_1 = require("../soap/rangeError");
const requiredCollectionError_1 = require("../soap/requiredCollectionError");
const requiredError_1 = require("../soap/requiredError");
const requiredNumberError_1 = require("../soap/requiredNumberError");
const serverError_1 = require("../soap/serverError");
const setValue_1 = require("../soap/setValue");
const size_1 = require("../soap/size");
const soapRequestHeader_1 = require("../../common/soap/soapRequestHeader");
const soapResponseHeader_1 = require("../../common/soap/soapResponseHeader");
const statementError_1 = require("../soap/statementError");
const stringLengthError_1 = require("../soap/stringLengthError");
const stringValueMapEntry_1 = require("../soap/stringValueMapEntry");
const targeting_1 = require("../soap/targeting");
const technology_1 = require("../soap/technology");
const technologyTargetingError_1 = require("../soap/technologyTargetingError");
const textValue_1 = require("../soap/textValue");
const timeOfDay_1 = require("../soap/timeOfDay");
const typeError_1 = require("../soap/typeError");
const uniqueError_1 = require("../soap/uniqueError");
const userDomainTargeting_1 = require("../soap/userDomainTargeting");
const userDomainTargetingError_1 = require("../soap/userDomainTargetingError");
const value_1 = require("../soap/value");
const videoPosition_1 = require("../soap/videoPosition");
const videoPositionTargeting_1 = require("../soap/videoPositionTargeting");
const videoPositionTargetingError_1 = require("../soap/videoPositionTargetingError");
const videoPositionWithinPod_1 = require("../soap/videoPositionWithinPod");
const videoPositionTarget_1 = require("../soap/videoPositionTarget");
const withdrawProducts_1 = require("../soap/withdrawProducts");
const creativeSizeType_1 = require("../soap/creativeSizeType");
const mobileApplicationTargeting_1 = require("../soap/mobileApplicationTargeting");
class UpdateProductsResponse extends xmlElement_1.XMLElement {
    constructor(rval = null) {
        super();
        this.rval = rval;
    }
}
UpdateProductsResponse.XSI_TYPE = "";
class UpdateProducts extends xmlElement_1.XMLElement {
    constructor(products = null) {
        super();
        this.products = products;
    }
}
UpdateProducts.XSI_TYPE = "";
class PerformProductActionResponse extends xmlElement_1.XMLElement {
    constructor(rval = null) {
        super();
        this.rval = rval;
    }
}
PerformProductActionResponse.XSI_TYPE = "";
class PerformProductAction extends xmlElement_1.XMLElement {
    constructor(productAction = null, filterStatement = null) {
        super();
        this.productAction = productAction;
        this.filterStatement = filterStatement;
    }
}
PerformProductAction.XSI_TYPE = "";
class GetProductsByStatementResponse extends xmlElement_1.XMLElement {
    constructor(rval = null) {
        super();
        this.rval = rval;
    }
}
GetProductsByStatementResponse.XSI_TYPE = "";
class GetProductsByStatement extends xmlElement_1.XMLElement {
    constructor(statement = null) {
        super();
        this.statement = statement;
    }
}
GetProductsByStatement.XSI_TYPE = "";
class CreateProducts extends xmlElement_1.XMLElement {
    constructor(products = null) {
        super();
        this.products = products;
    }
}
CreateProducts.XSI_TYPE = "";
class CreateProductsResponse extends xmlElement_1.XMLElement {
    constructor(rval = null) {
        super();
        this.rval = rval;
    }
}
CreateProductsResponse.XSI_TYPE = "";
class ProductService extends dfpService_1.DfpService {
    constructor(user, options = {}) {
        options['classmap'] = ProductService.CLASS_MAP;
        super(ProductService.SERVICE_NAME, user, ProductService.ENDPOINT, options);
    }
    createProducts(products) {
        return __awaiter(this, void 0, void 0, function* () {
            const args = new CreateProducts(products);
            const result = (yield this.client.__soapCall("createProducts", args)).createProductsResponse;
            return (Array.isArray(result.rval)) ? result.rval :
                (result.rval == null) ? [] : [result.rval];
        });
    }
    getProductsByStatement(statement) {
        return __awaiter(this, void 0, void 0, function* () {
            const args = new GetProductsByStatement(statement);
            const result = (yield this.client.__soapCall("getProductsByStatement", args)).getProductsByStatementResponse;
            result.rval.results = (Array.isArray(result.rval.results)) ? result.rval.results :
                (result.rval.results == null) ? [] : [result.rval.results];
            return result.rval;
        });
    }
    performProductAction(productAction, filterStatement) {
        return __awaiter(this, void 0, void 0, function* () {
            const args = new PerformProductAction(productAction, filterStatement);
            const result = (yield this.client.__soapCall("performProductAction", args)).performProductActionResponse;
            return result.rval;
        });
    }
    updateProducts(products) {
        return __awaiter(this, void 0, void 0, function* () {
            const args = new UpdateProducts(products);
            const result = (yield this.client.__soapCall("updateProducts", args)).updateProductsResponse;
            return (Array.isArray(result.rval)) ? result.rval :
                (result.rval == null) ? [] : [result.rval];
        });
    }
}
ProductService.SERVICE_NAME = "ProductService";
ProductService.ENDPOINT = "https://ads.google.com/apis/ads/publisher/v201611/ProductService";
ProductService.CLASS_MAP = {
    "ObjectValue": objectValue_1.ObjectValue,
    "ActivateProducts": activateProducts_1.ActivateProducts,
    "AdUnitTargeting": adUnitTargeting_1.AdUnitTargeting,
    "ApiError": apiError_1.ApiError,
    "ApiException": apiException_1.ApiException,
    "TechnologyTargeting": technologyTargeting_1.TechnologyTargeting,
    "ApiVersionError": apiVersionError_1.ApiVersionError,
    "ApplicationException": applicationException_1.ApplicationException,
    "AppliedLabel": appliedLabel_1.AppliedLabel,
    "AuthenticationError": authenticationError_1.AuthenticationError,
    "BandwidthGroup": bandwidthGroup_1.BandwidthGroup,
    "BandwidthGroupTargeting": bandwidthGroupTargeting_1.BandwidthGroupTargeting,
    "BaseCustomFieldValue": baseCustomFieldValue_1.BaseCustomFieldValue,
    "BaseRateError": baseRateError_1.BaseRateError,
    "BooleanValue": booleanValue_1.BooleanValue,
    "Browser": browser_1.Browser,
    "BrowserLanguage": browserLanguage_1.BrowserLanguage,
    "BrowserLanguageTargeting": browserLanguageTargeting_1.BrowserLanguageTargeting,
    "BrowserTargeting": browserTargeting_1.BrowserTargeting,
    "CollectionSizeError": collectionSizeError_1.CollectionSizeError,
    "CommonError": commonError_1.CommonError,
    "ContentMetadataKeyHierarchyTargeting": contentMetadataKeyHierarchyTargeting_1.ContentMetadataKeyHierarchyTargeting,
    "ContentMetadataTargetingError": contentMetadataTargetingError_1.ContentMetadataTargetingError,
    "ContentTargeting": contentTargeting_1.ContentTargeting,
    "CreativePlaceholder": creativePlaceholder_1.CreativePlaceholder,
    "CustomCriteria": customCriteria_1.CustomCriteria,
    "CustomCriteriaSet": customCriteriaSet_1.CustomCriteriaSet,
    "CustomFieldValue": customFieldValue_1.CustomFieldValue,
    "CustomFieldValueError": customFieldValueError_1.CustomFieldValueError,
    "CustomTargetingError": customTargetingError_1.CustomTargetingError,
    "CustomCriteriaLeaf": customCriteriaLeaf_1.CustomCriteriaLeaf,
    "CustomCriteriaNode": customCriteriaNode_1.CustomCriteriaNode,
    "AudienceSegmentCriteria": audienceSegmentCriteria_1.AudienceSegmentCriteria,
    "CustomizableAttributes": customizableAttributes_1.CustomizableAttributes,
    "Date": dfpDate_1.DfpDate,
    "DateTime": dfpDateTime_1.DfpDateTime,
    "DateTimeRangeTargetingError": dateTimeRangeTargetingError_1.DateTimeRangeTargetingError,
    "DateTimeValue": dateTimeValue_1.DateTimeValue,
    "DateValue": dateValue_1.DateValue,
    "DayPart": dayPart_1.DayPart,
    "DayPartTargeting": dayPartTargeting_1.DayPartTargeting,
    "DayPartTargetingError": dayPartTargetingError_1.DayPartTargetingError,
    "DeactivateProducts": deactivateProducts_1.DeactivateProducts,
    "DeviceCapability": deviceCapability_1.DeviceCapability,
    "DeviceCapabilityTargeting": deviceCapabilityTargeting_1.DeviceCapabilityTargeting,
    "DeviceCategory": deviceCategory_1.DeviceCategory,
    "DeviceCategoryTargeting": deviceCategoryTargeting_1.DeviceCategoryTargeting,
    "DeviceManufacturer": deviceManufacturer_1.DeviceManufacturer,
    "DeviceManufacturerTargeting": deviceManufacturerTargeting_1.DeviceManufacturerTargeting,
    "DropDownCustomFieldValue": dropDownCustomFieldValue_1.DropDownCustomFieldValue,
    "EntityChildrenLimitReachedError": entityChildrenLimitReachedError_1.EntityChildrenLimitReachedError,
    "FeatureError": featureError_1.FeatureError,
    "ForecastError": forecastError_1.ForecastError,
    "FrequencyCap": frequencyCap_1.FrequencyCap,
    "GenericTargetingError": genericTargetingError_1.GenericTargetingError,
    "GeoTargeting": geoTargeting_1.GeoTargeting,
    "GeoTargetingError": geoTargetingError_1.GeoTargetingError,
    "InternalApiError": internalApiError_1.InternalApiError,
    "InventoryTargeting": inventoryTargeting_1.InventoryTargeting,
    "InventoryTargetingError": inventoryTargetingError_1.InventoryTargetingError,
    "Location": dfpLocation_1.DfpLocation,
    "MobileApplicationTargeting": mobileApplicationTargeting_1.MobileApplicationTargeting,
    "Money": money_1.Money,
    "NonProgrammaticProductError": nonProgrammaticProductError_1.NonProgrammaticProductError,
    "MobileCarrier": mobileCarrier_1.MobileCarrier,
    "MobileCarrierTargeting": mobileCarrierTargeting_1.MobileCarrierTargeting,
    "MobileDevice": mobileDevice_1.MobileDevice,
    "MobileDeviceSubmodel": mobileDeviceSubmodel_1.MobileDeviceSubmodel,
    "MobileDeviceSubmodelTargeting": mobileDeviceSubmodelTargeting_1.MobileDeviceSubmodelTargeting,
    "MobileDeviceTargeting": mobileDeviceTargeting_1.MobileDeviceTargeting,
    "NotNullError": notNullError_1.NotNullError,
    "NumberValue": numberValue_1.NumberValue,
    "OperatingSystem": operatingSystem_1.OperatingSystem,
    "OperatingSystemTargeting": operatingSystemTargeting_1.OperatingSystemTargeting,
    "OperatingSystemVersion": operatingSystemVersion_1.OperatingSystemVersion,
    "OperatingSystemVersionTargeting": operatingSystemVersionTargeting_1.OperatingSystemVersionTargeting,
    "ParseError": parseError_1.ParseError,
    "PermissionError": permissionError_1.PermissionError,
    "ProductAction": productAction_1.ProductAction,
    "ProductActionError": productActionError_1.ProductActionError,
    "Product": product_1.Product,
    "ProductError": productError_1.ProductError,
    "ProductMarketplaceInfo": productMarketplaceInfo_1.ProductMarketplaceInfo,
    "ProductPage": productPage_1.ProductPage,
    "ProgrammaticEntitiesError": programmaticEntitiesError_1.ProgrammaticEntitiesError,
    "ProgrammaticProductError": programmaticProductError_1.ProgrammaticProductError,
    "PublishProducts": publishProducts_1.PublishProducts,
    "PublisherQueryLanguageContextError": publisherQueryLanguageContextError_1.PublisherQueryLanguageContextError,
    "PublisherQueryLanguageSyntaxError": publisherQueryLanguageSyntaxError_1.PublisherQueryLanguageSyntaxError,
    "QuotaError": quotaError_1.QuotaError,
    "RangeError": rangeError_1.RangeError,
    "RequiredCollectionError": requiredCollectionError_1.RequiredCollectionError,
    "RequiredError": requiredError_1.RequiredError,
    "RequiredNumberError": requiredNumberError_1.RequiredNumberError,
    "ServerError": serverError_1.ServerError,
    "SetValue": setValue_1.SetValue,
    "Size": size_1.Size,
    "SoapRequestHeader": soapRequestHeader_1.SoapRequestHeader,
    "SoapResponseHeader": soapResponseHeader_1.SoapResponseHeader,
    "Statement": statement_1.Statement,
    "StatementError": statementError_1.StatementError,
    "StringLengthError": stringLengthError_1.StringLengthError,
    "String_ValueMapEntry": stringValueMapEntry_1.StringValueMapEntry,
    "Targeting": targeting_1.Targeting,
    "Technology": technology_1.Technology,
    "TechnologyTargetingError": technologyTargetingError_1.TechnologyTargetingError,
    "TextValue": textValue_1.TextValue,
    "TimeOfDay": timeOfDay_1.TimeOfDay,
    "TypeError": typeError_1.TypeError,
    "UniqueError": uniqueError_1.UniqueError,
    "UpdateResult": updateResult_1.UpdateResult,
    "UserDomainTargeting": userDomainTargeting_1.UserDomainTargeting,
    "UserDomainTargetingError": userDomainTargetingError_1.UserDomainTargetingError,
    "Value": value_1.Value,
    "VideoPosition": videoPosition_1.VideoPosition,
    "VideoPositionTargeting": videoPositionTargeting_1.VideoPositionTargeting,
    "VideoPositionTargetingError": videoPositionTargetingError_1.VideoPositionTargetingError,
    "VideoPositionWithinPod": videoPositionWithinPod_1.VideoPositionWithinPod,
    "VideoPositionTarget": videoPositionTarget_1.VideoPositionTarget,
    "WithdrawProducts": withdrawProducts_1.WithdrawProducts,
    "AdExchangeEnvironment": adExchangeEnvironment_1.AdExchangeEnvironment,
    "CreativeSizeType": creativeSizeType_1.CreativeSizeType,
    "getProductsByStatement": GetProductsByStatement,
    "getProductsByStatementResponse": GetProductsByStatementResponse,
    "performProductAction": PerformProductAction,
    "performProductActionResponse": PerformProductActionResponse,
    "updateProducts": UpdateProducts,
    "updateProductsResponse": UpdateProductsResponse,
    "createProducts": CreateProducts,
    "createProductsResponse": CreateProductsResponse,
};
exports.ProductService = ProductService;