@niur/google-admanager-api 0.0.5

package/dist/client/services/adjustment/adjustmentService.interface.d.ts

@@ -0,0 +1,96 @@
+import { Statement, UpdateResult } from '../../../common/types';
+import { ForecastAdjustment, ForecastAdjustmentAction, ForecastAdjustmentPage, TrafficForecastSegment, TrafficForecastSegmentPage } from './adjustment.type';
+/**
+ * Provides methods for creating, updating, and retrieving
+ * {@link https://developers.google.com/ad-manager/api/reference/v202202/AdjustmentService.ForecastAdjustment ForecastAdjustment}s and
+ * {@link https://developers.google.com/ad-manager/api/reference/v202202/AdjustmentService.TrafficForecastSegment TrafficForecastSegment}s.
+ *
+ * Forecast adjustments allow editing the volume and traffic composition of forecasted inventory.
+ * Traffic forecast segments divide forecasted inventory into segments to which forecast adjustments can be applied.
+ */
+export interface AdjustmentServiceOperations {
+    /**
+     * Takes a prospective forecast adjustment and calculates the daily ad opportunity counts corresponding to its provided volume settings.
+     *
+     * @param forecastAdjustment the prospective forecast adjustment
+     * @returns a forecast adjustment matching the one passed in, but with its calculatedDailyAdOpportunityCounts field populated
+     */
+    calculateDailyAdOpportunityCounts(forecastAdjustment: ForecastAdjustment): Promise<ForecastAdjustment>;
+    /**
+     * Creates new {@link https://developers.google.com/ad-manager/api/reference/v202202/AdjustmentService.ForecastAdjustment ForecastAdjustment} objects.
+     *
+     * @param forecastAdjustments the forecast adjustments to create
+     * @returns the persisted forecast adjustments with their IDs populated
+     */
+    createForecastAdjustments(forecastAdjustments: ForecastAdjustment[]): Promise<ForecastAdjustment[]>;
+    /**
+     * Creates new {@link https://developers.google.com/ad-manager/api/reference/v202202/AdjustmentService.TrafficForecastSegment TrafficForecastSegment} objects.
+     *
+     * @param trafficForecastSegments the traffic forecast segments to create
+     * @returns the persisted traffic forecast segments with their IDs populated
+     */
+    createTrafficForecastSegments(trafficForecastSegments: TrafficForecastSegment[]): Promise<TrafficForecastSegment[]>;
+    /**
+     * Gets a {@link https://developers.google.com/ad-manager/api/reference/v202202/AdjustmentService.ForecastAdjustmentPage ForecastAdjustmentPage}
+     * of {@link https://developers.google.com/ad-manager/api/reference/v202202/AdjustmentService.ForecastAdjustment ForecastAdjustment}
+     * objects that satisfy the given {@link https://developers.google.com/ad-manager/api/reference/v202202/AdjustmentService.Statement#query Statement.query}.
+     *
+     * The following fields are supported for filtering:
+     *
+     * | PQL Property             | PQL Property                                                                                                                                                                     |
+     * | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+     * | id                       | {@link https://developers.google.com/ad-manager/api/reference/v202202/AdjustmentService.ForecastAdjustment#id ForecastAdjustment.id}                                             |
+     * | trafficForecastSegmentId | {@link https://developers.google.com/ad-manager/api/reference/v202202/AdjustmentService.ForecastAdjustment#trafficForecastSegmentId ForecastAdjustment.trafficForecastSegmentId} |
+     * | name                     | {@link https://developers.google.com/ad-manager/api/reference/v202202/AdjustmentService.ForecastAdjustment#name ForecastAdjustment.name}                                         |
+     * | startDate                | {@link https://developers.google.com/ad-manager/api/reference/v202202/AdjustmentService.ForecastAdjustment#startDate ForecastAdjustment.startDate}                               |
+     * | endDate                  | {@link https://developers.google.com/ad-manager/api/reference/v202202/AdjustmentService.ForecastAdjustment#endDate ForecastAdjustment.endDate}                                   |
+     * | status                   | {@link https://developers.google.com/ad-manager/api/reference/v202202/AdjustmentService.ForecastAdjustment#status ForecastAdjustment.status}                                     |
+     *
+     * @param filterStatement a Publisher Query Language statement to filter a list of traffic forecast segments
+     * @returns a page of forecast adjustments that match the filter
+     */
+    getForecastAdjustmentsByStatement(filterStatement: Statement): Promise<ForecastAdjustmentPage>;
+    /**
+     * Gets a {@link https://developers.google.com/ad-manager/api/reference/v202202/AdjustmentService.TrafficForecastSegmentPage TrafficForecastSegmentPage}
+     * of {@link https://developers.google.com/ad-manager/api/reference/v202202/AdjustmentService.TrafficForecastSegment TrafficForecastSegment}
+     * objects that satisfy the given {@link https://developers.google.com/ad-manager/api/reference/v202202/AdjustmentService.Statement#query Statement.query}.
+     *
+     * The following fields are supported for filtering:
+     *
+     * | PQL Property | PQL Property                                                                                                                                                     |
+     * | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+     * | id           | {@link https://developers.google.com/ad-manager/api/reference/v202202/AdjustmentService.TrafficForecastSegment#id TrafficForecastSegment.id}                     |
+     * | name         | {@link https://developers.google.com/ad-manager/api/reference/v202202/AdjustmentService.TrafficForecastSegment#name TrafficForecastSegment.name}                 |
+     * | creationTime | {@link https://developers.google.com/ad-manager/api/reference/v202202/AdjustmentService.TrafficForecastSegment#creationTime TrafficForecastSegment.creationTime} |
+     *
+     * @param filterStatement a Publisher Query Language statement to filter a list of traffic forecast segments
+     * @returns a page of traffic forecast segments that match the filter
+     */
+    getTrafficForecastSegmentsByStatement(filterStatement: Statement): Promise<TrafficForecastSegmentPage>;
+    /**
+     * Performs actions on {@link https://developers.google.com/ad-manager/api/reference/v202202/AdjustmentService.ForecastAdjustment ForecastAdjustment}
+     *  objects that match the given {@link https://developers.google.com/ad-manager/api/reference/v202202/AdjustmentService.Statement#query Statement.query}.
+     *
+     * @param forecastAdjustmentAction the action to perform
+     * @param filterStatement a Publisher Query Language statement used to filter
+     * a set of forecast adjustments
+     *
+     * @returns the result of the action performed
+     */
+    performForecastAdjustmentAction(forecastAdjustmentAction: ForecastAdjustmentAction, filterStatement: Statement): Promise<UpdateResult>;
+    /**
+     * Updates the specified {@link https://developers.google.com/ad-manager/api/reference/v202202/AdjustmentService.ForecastAdjustment ForecastAdjustment} objects.
+     *
+     * @param forecastAdjustments the forecast adjustments to update
+     * @returns the updated forecast adjustments
+     */
+    updateForecastAdjustments(forecastAdjustments: ForecastAdjustment[]): Promise<ForecastAdjustment[]>;
+    /**
+     * Updates the specified {@link https://developers.google.com/ad-manager/api/reference/v202202/AdjustmentService.TrafficForecastSegment TrafficForecastSegment} objects.
+     *
+     * @param trafficForecastSegments the traffic forecast segments to update
+     * @returns the updated traffic forecast segments
+     */
+    updateTrafficForecastSegments(trafficForecastSegments: TrafficForecastSegment[]): Promise<TrafficForecastSegment[]>;
+}
+//# sourceMappingURL=adjustmentService.interface.d.ts.map

package/dist/client/services/adjustment/adjustmentService.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"adjustmentService.interface.d.ts","sourceRoot":"","sources":["../../../../lib/client/services/adjustment/adjustmentService.interface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAChE,OAAO,EACL,kBAAkB,EAClB,wBAAwB,EACxB,sBAAsB,EACtB,sBAAsB,EACtB,0BAA0B,EAC3B,MAAM,mBAAmB,CAAC;AAE3B;;;;;;;GAOG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;;;;OAKG;IACH,iCAAiC,CAAC,kBAAkB,EAAE,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACvG;;;;;OAKG;IACH,yBAAyB,CAAC,mBAAmB,EAAE,kBAAkB,EAAE,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IACpG;;;;;OAKG;IACH,6BAA6B,CAAC,uBAAuB,EAAE,sBAAsB,EAAE,GAAG,OAAO,CAAC,sBAAsB,EAAE,CAAC,CAAC;IACpH;;;;;;;;;;;;;;;;;;OAkBG;IACH,iCAAiC,CAAC,eAAe,EAAE,SAAS,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAC/F;;;;;;;;;;;;;;;OAeG;IACH,qCAAqC,CAAC,eAAe,EAAE,SAAS,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAAC;IACvG;;;;;;;;;OASG;IACH,+BAA+B,CAC7B,wBAAwB,EAAE,wBAAwB,EAClD,eAAe,EAAE,SAAS,GACzB,OAAO,CAAC,YAAY,CAAC,CAAC;IAEzB;;;;;OAKG;IACH,yBAAyB,CAAC,mBAAmB,EAAE,kBAAkB,EAAE,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;IAEpG;;;;;OAKG;IACH,6BAA6B,CAAC,uBAAuB,EAAE,sBAAsB,EAAE,GAAG,OAAO,CAAC,sBAAsB,EAAE,CAAC,CAAC;CACrH"}

package/dist/client/services/adjustment/adjustmentService.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=adjustmentService.interface.js.map

package/dist/client/services/adjustment/adjustmentService.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adjustmentService.interface.js","sourceRoot":"","sources":["../../../../lib/client/services/adjustment/adjustmentService.interface.ts"],"names":[],"mappings":""}

package/dist/client/services/adjustment/index.d.ts

@@ -0,0 +1,2 @@
+export { AdjustmentService } from './adjustment.service';
+//# sourceMappingURL=index.d.ts.map

package/dist/client/services/adjustment/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../lib/client/services/adjustment/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC"}

package/dist/client/services/adjustment/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AdjustmentService = void 0;
+var adjustment_service_1 = require("./adjustment.service");
+Object.defineProperty(exports, "AdjustmentService", { enumerable: true, get: function () { return adjustment_service_1.AdjustmentService; } });
+//# sourceMappingURL=index.js.map

package/dist/client/services/adjustment/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../lib/client/services/adjustment/index.ts"],"names":[],"mappings":";;;AAAA,2DAAyD;AAAhD,uHAAA,iBAAiB,OAAA"}

package/dist/client/services/audienceSegment/audienceSegment.enum.d.ts

@@ -0,0 +1,73 @@
+/**
+ * Specifies the statuses for {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.AudienceSegment AudienceSegment} objects.
+ */
+export declare enum AudienceSegmentStatus {
+    /**
+     * Active status means this audience segment is available for targeting.
+     */
+    ACTIVE = "ACTIVE",
+    /**
+     * Inactive status means this audience segment is not available for targeting.
+     */
+    INACTIVE = "INACTIVE"
+}
+/**
+ * Specifies types for {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.AudienceSegment AudienceSegment} objects.
+ */
+export declare enum AudienceSegmentType {
+    /**
+     * First party segments created and owned by the publisher.
+     */
+    FIRST_PARTY = "FIRST_PARTY",
+    /**
+     * First party segments shared by other clients.
+     */
+    SHARED = "SHARED",
+    /**
+     * Third party segments licensed by the publisher from data providers. This doesn't include Google-provided licensed segments.
+     */
+    THIRD_PARTY = "THIRD_PARTY",
+    /**
+     * The value returned if the actual value is not exposed by the requested API version.
+     */
+    UNKNOWN = "UNKNOWN"
+}
+/**
+ * Approval status values for {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.ThirdPartyAudienceSegment ThirdPartyAudienceSegment} objects.
+ */
+export declare enum AudienceSegmentApprovalStatus {
+    /**
+     * Specifies that this segment is waiting to be approved or rejected. It cannot be targeted.
+     */
+    UNAPPROVED = "UNAPPROVED",
+    /**
+     * Specifies that this segment is approved and can be targeted.
+     */
+    APPROVED = "APPROVED",
+    /**
+     * Specifies that this segment is rejected and cannot be targeted.
+     */
+    REJECTED = "REJECTED",
+    /**
+     * The value returned if the actual value is not exposed by the requested API version.
+     */
+    UNKNOWN = "UNKNOWN"
+}
+/**
+ * Specifies the license type of a {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.ThirdPartyAudienceSegment ThirdPartyAudienceSegment}.
+ */
+export declare enum LicenseType {
+    /**
+     * A direct license is the result of a direct contract between the data provider and the publisher.
+     */
+    DIRECT_LICENSE = "DIRECT_LICENSE",
+    /**
+     * A global license is the result of an agreement between Google and the data provider, which agrees to license their audience segments to all the publishers and/or advertisers of the Google ecosystem.
+     */
+    GLOBAL_LICENSE = "GLOBAL_LICENSE",
+    /**
+     * The value returned if the actual value is not exposed by the requested API version.
+     */
+    UNKNOWN = "UNKNOWN"
+}
+//# sourceMappingURL=audienceSegment.enum.d.ts.map

package/dist/client/services/audienceSegment/audienceSegment.enum.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"audienceSegment.enum.d.ts","sourceRoot":"","sources":["../../../../lib/client/services/audienceSegment/audienceSegment.enum.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,qBAAqB;IAC/B;;OAEG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,QAAQ,aAAa;CACtB;AAED;;GAEG;AACH,oBAAY,mBAAmB;IAC7B;;OAEG;IACH,WAAW,gBAAgB;IAC3B;;OAEG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,WAAW,gBAAgB;IAC3B;;OAEG;IACH,OAAO,YAAY;CACpB;AAED;;GAEG;AACH,oBAAY,6BAA6B;IACvC;;OAEG;IACH,UAAU,eAAe;IACzB;;OAEG;IACH,QAAQ,aAAa;IACrB;;OAEG;IACH,QAAQ,aAAa;IACrB;;OAEG;IACH,OAAO,YAAY;CACpB;AAED;;GAEG;AACH,oBAAY,WAAW;IACrB;;OAEG;IACH,cAAc,mBAAmB;IACjC;;OAEG;IACH,cAAc,mBAAmB;IACjC;;OAEG;IACH,OAAO,YAAY;CACpB"}

package/dist/client/services/audienceSegment/audienceSegment.enum.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LicenseType = exports.AudienceSegmentApprovalStatus = exports.AudienceSegmentType = exports.AudienceSegmentStatus = void 0;
+/**
+ * Specifies the statuses for {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.AudienceSegment AudienceSegment} objects.
+ */
+var AudienceSegmentStatus;
+(function (AudienceSegmentStatus) {
+    /**
+     * Active status means this audience segment is available for targeting.
+     */
+    AudienceSegmentStatus["ACTIVE"] = "ACTIVE";
+    /**
+     * Inactive status means this audience segment is not available for targeting.
+     */
+    AudienceSegmentStatus["INACTIVE"] = "INACTIVE";
+})(AudienceSegmentStatus = exports.AudienceSegmentStatus || (exports.AudienceSegmentStatus = {}));
+/**
+ * Specifies types for {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.AudienceSegment AudienceSegment} objects.
+ */
+var AudienceSegmentType;
+(function (AudienceSegmentType) {
+    /**
+     * First party segments created and owned by the publisher.
+     */
+    AudienceSegmentType["FIRST_PARTY"] = "FIRST_PARTY";
+    /**
+     * First party segments shared by other clients.
+     */
+    AudienceSegmentType["SHARED"] = "SHARED";
+    /**
+     * Third party segments licensed by the publisher from data providers. This doesn't include Google-provided licensed segments.
+     */
+    AudienceSegmentType["THIRD_PARTY"] = "THIRD_PARTY";
+    /**
+     * The value returned if the actual value is not exposed by the requested API version.
+     */
+    AudienceSegmentType["UNKNOWN"] = "UNKNOWN";
+})(AudienceSegmentType = exports.AudienceSegmentType || (exports.AudienceSegmentType = {}));
+/**
+ * Approval status values for {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.ThirdPartyAudienceSegment ThirdPartyAudienceSegment} objects.
+ */
+var AudienceSegmentApprovalStatus;
+(function (AudienceSegmentApprovalStatus) {
+    /**
+     * Specifies that this segment is waiting to be approved or rejected. It cannot be targeted.
+     */
+    AudienceSegmentApprovalStatus["UNAPPROVED"] = "UNAPPROVED";
+    /**
+     * Specifies that this segment is approved and can be targeted.
+     */
+    AudienceSegmentApprovalStatus["APPROVED"] = "APPROVED";
+    /**
+     * Specifies that this segment is rejected and cannot be targeted.
+     */
+    AudienceSegmentApprovalStatus["REJECTED"] = "REJECTED";
+    /**
+     * The value returned if the actual value is not exposed by the requested API version.
+     */
+    AudienceSegmentApprovalStatus["UNKNOWN"] = "UNKNOWN";
+})(AudienceSegmentApprovalStatus = exports.AudienceSegmentApprovalStatus || (exports.AudienceSegmentApprovalStatus = {}));
+/**
+ * Specifies the license type of a {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.ThirdPartyAudienceSegment ThirdPartyAudienceSegment}.
+ */
+var LicenseType;
+(function (LicenseType) {
+    /**
+     * A direct license is the result of a direct contract between the data provider and the publisher.
+     */
+    LicenseType["DIRECT_LICENSE"] = "DIRECT_LICENSE";
+    /**
+     * A global license is the result of an agreement between Google and the data provider, which agrees to license their audience segments to all the publishers and/or advertisers of the Google ecosystem.
+     */
+    LicenseType["GLOBAL_LICENSE"] = "GLOBAL_LICENSE";
+    /**
+     * The value returned if the actual value is not exposed by the requested API version.
+     */
+    LicenseType["UNKNOWN"] = "UNKNOWN";
+})(LicenseType = exports.LicenseType || (exports.LicenseType = {}));
+//# sourceMappingURL=audienceSegment.enum.js.map

package/dist/client/services/audienceSegment/audienceSegment.enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"audienceSegment.enum.js","sourceRoot":"","sources":["../../../../lib/client/services/audienceSegment/audienceSegment.enum.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,IAAY,qBASX;AATD,WAAY,qBAAqB;IAC/B;;OAEG;IACH,0CAAiB,CAAA;IACjB;;OAEG;IACH,8CAAqB,CAAA;AACvB,CAAC,EATW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAShC;AAED;;GAEG;AACH,IAAY,mBAiBX;AAjBD,WAAY,mBAAmB;IAC7B;;OAEG;IACH,kDAA2B,CAAA;IAC3B;;OAEG;IACH,wCAAiB,CAAA;IACjB;;OAEG;IACH,kDAA2B,CAAA;IAC3B;;OAEG;IACH,0CAAmB,CAAA;AACrB,CAAC,EAjBW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAiB9B;AAED;;GAEG;AACH,IAAY,6BAiBX;AAjBD,WAAY,6BAA6B;IACvC;;OAEG;IACH,0DAAyB,CAAA;IACzB;;OAEG;IACH,sDAAqB,CAAA;IACrB;;OAEG;IACH,sDAAqB,CAAA;IACrB;;OAEG;IACH,oDAAmB,CAAA;AACrB,CAAC,EAjBW,6BAA6B,GAA7B,qCAA6B,KAA7B,qCAA6B,QAiBxC;AAED;;GAEG;AACH,IAAY,WAaX;AAbD,WAAY,WAAW;IACrB;;OAEG;IACH,gDAAiC,CAAA;IACjC;;OAEG;IACH,gDAAiC,CAAA;IACjC;;OAEG;IACH,kCAAmB,CAAA;AACrB,CAAC,EAbW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAatB"}

package/dist/client/services/audienceSegment/audienceSegment.service.d.ts

@@ -0,0 +1,13 @@
+import { Client } from 'soap';
+import { AudienceSegmentServiceOperations } from './audienceSegmentService.interface';
+import { Statement, UpdateResult } from '../../../common/types';
+import { AudienceSegmentAction, AudienceSegmentPage, FirstPartyAudienceSegment } from './audienceSegment.type';
+export declare class AudienceSegmentService implements AudienceSegmentServiceOperations {
+    private _client;
+    constructor(client: Client);
+    createAudienceSegments(segments: FirstPartyAudienceSegment[]): Promise<FirstPartyAudienceSegment[]>;
+    getAudienceSegmentsByStatement(filterStatement: Statement): Promise<AudienceSegmentPage>;
+    performAudienceSegmentAction(action: AudienceSegmentAction, filterStatement: Statement): Promise<UpdateResult>;
+    updateAudienceSegments(segments: FirstPartyAudienceSegment[]): Promise<FirstPartyAudienceSegment[]>;
+}
+//# sourceMappingURL=audienceSegment.service.d.ts.map

package/dist/client/services/audienceSegment/audienceSegment.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"audienceSegment.service.d.ts","sourceRoot":"","sources":["../../../../lib/client/services/audienceSegment/audienceSegment.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAE9B,OAAO,EAAE,gCAAgC,EAAE,MAAM,oCAAoC,CAAC;AACtF,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAChE,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AAE/G,qBAAa,sBAAuB,YAAW,gCAAgC;IAC7E,OAAO,CAAC,OAAO,CAAS;gBAEZ,MAAM,EAAE,MAAM;IAIpB,sBAAsB,CAAC,QAAQ,EAAE,yBAAyB,EAAE,GAAG,OAAO,CAAC,yBAAyB,EAAE,CAAC;IAInG,8BAA8B,CAAC,eAAe,EAAE,SAAS,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAMxF,4BAA4B,CAAC,MAAM,EAAE,qBAAqB,EAAE,eAAe,EAAE,SAAS,GAAG,OAAO,CAAC,YAAY,CAAC;IAW9G,sBAAsB,CAAC,QAAQ,EAAE,yBAAyB,EAAE,GAAG,OAAO,CAAC,yBAAyB,EAAE,CAAC;CAG1G"}

package/dist/client/services/audienceSegment/audienceSegment.service.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AudienceSegmentService = void 0;
+class AudienceSegmentService {
+    constructor(client) {
+        this._client = client;
+    }
+    async createAudienceSegments(segments) {
+        return this._client.createAudienceSegments({ segments });
+    }
+    async getAudienceSegmentsByStatement(filterStatement) {
+        return this._client.getAudienceSegmentsByStatement({
+            filterStatement,
+        });
+    }
+    async performAudienceSegmentAction(action, filterStatement) {
+        return this._client.performAudienceSegmentAction({
+            action: {
+                attributes: {
+                    'xsi:type': action,
+                },
+            },
+            filterStatement,
+        });
+    }
+    async updateAudienceSegments(segments) {
+        return this._client.updateAudienceSegments({ segments });
+    }
+}
+exports.AudienceSegmentService = AudienceSegmentService;
+//# sourceMappingURL=audienceSegment.service.js.map

package/dist/client/services/audienceSegment/audienceSegment.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"audienceSegment.service.js","sourceRoot":"","sources":["../../../../lib/client/services/audienceSegment/audienceSegment.service.ts"],"names":[],"mappings":";;;AAMA,MAAa,sBAAsB;IAGjC,YAAY,MAAc;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED,KAAK,CAAC,sBAAsB,CAAC,QAAqC;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED,KAAK,CAAC,8BAA8B,CAAC,eAA0B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,8BAA8B,CAAC;YACjD,eAAe;SAChB,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,4BAA4B,CAAC,MAA6B,EAAE,eAA0B;QAC1F,OAAO,IAAI,CAAC,OAAO,CAAC,4BAA4B,CAAC;YAC/C,MAAM,EAAE;gBACN,UAAU,EAAE;oBACV,UAAU,EAAE,MAAM;iBACnB;aACF;YACD,eAAe;SAChB,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,sBAAsB,CAAC,QAAqC;QAChE,OAAO,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC3D,CAAC;CACF;AA/BD,wDA+BC"}

package/dist/client/services/audienceSegment/audienceSegment.type.d.ts

@@ -0,0 +1,154 @@
+import { DateTime, PageResult } from '../../../common/types';
+import { Money } from '../../common/types';
+import { AudienceSegmentApprovalStatus, AudienceSegmentStatus, AudienceSegmentType, LicenseType } from './audienceSegment.enum';
+/**
+ * Data provider that owns this segment.
+ * For a {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.FirstPartyAudienceSegment FirstPartyAudienceSegment}, it would be the
+ * publisher network. For a {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.SharedAudienceSegment SharedAudienceSegment}
+ * or a {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.ThirdPartyAudienceSegment ThirdPartyAudienceSegment},
+ * it would be the entity that provides that {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.AudienceSegment AudienceSegment}.
+ */
+declare type AudienceSegmentDataProvider = {
+    /**
+     * Name of the data provider. This attribute is readonly and is assigned by Google.
+     */
+    name: string;
+};
+/**
+ * An {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.AudienceSegment AudienceSegment} represents audience segment object.
+ */
+declare type AudienceSegment = {
+    /**
+     * Id of the AudienceSegment.
+     * This attribute is readonly and is populated by Google.
+     */
+    id: number;
+    /**
+     * Name of the AudienceSegment. This attribute is required and has a maximum length of 255 characters.
+     */
+    name: string;
+    /**
+     * The ids of the categories this segment belongs to. This field is optional, it may be empty.
+     */
+    categoryIds: number[];
+    /**
+     * Description of the AudienceSegment. This attribute is optional and has a maximum length of 8192 characters.
+     */
+    description: string;
+    /**
+     * Status of the AudienceSegment. This controls whether the given segment is available for targeting or not.
+     * During creation this attribute is optional and defaults to **ACTIVE**.
+     * This attribute is readonly for updates.
+     */
+    status: AudienceSegmentStatus;
+    /**
+     * Number of unique identifiers in the AudienceSegment. This attribute is readonly and is populated by Google.
+     */
+    size: number;
+    /**
+     * Number of unique identifiers in the AudienceSegment for mobile web. This attribute is read-only.
+     */
+    mobileWebSize: number;
+    /**
+     * Number of unique IDFA identifiers in the AudienceSegment. This attribute is read-only.
+     */
+    idfaSize: number;
+    /**
+     * Number of unique AdID identifiers in the AudienceSegment. This attribute is read-only.
+     */
+    adIdSize: number;
+    /**
+     * Number of unique PPID (publisher provided identifiers) in the AudienceSegment. This attribute is read-only.
+     */
+    ppidSize: number;
+    /**
+     * Owner data provider of this segment. This attribute is readonly and is assigned by Google.
+     */
+    dataProvider: AudienceSegmentDataProvider;
+    /**
+     * Type of the segment. This attribute is readonly and is assigned by Google.
+     */
+    type: AudienceSegmentType;
+};
+/**
+ * A {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.SharedAudienceSegment SharedAudienceSegment}
+ * is an {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.AudienceSegment AudienceSegment}
+ * owned by another entity and shared with the publisher network.
+ */
+declare type SharedAudienceSegment = AudienceSegment & {};
+/**
+ * A {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.ThirdPartyAudienceSegment ThirdPartyAudienceSegment} is an
+ * {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.AudienceSegment AudienceSegment}
+ * owned by a data provider and licensed to the Ad Manager publisher.
+ */
+declare type ThirdPartyAudienceSegment = AudienceSegment & {
+    /**
+     * Specifies if the publisher has approved or rejected the segment.
+     */
+    approvalStatus: AudienceSegmentApprovalStatus;
+    /**
+     * Specifies CPM cost for the given segment. This attribute is readonly and is assigned by the data provider.
+     *
+     * The CPM cost comes from the active pricing, if there is one; otherwise it comes from the latest pricing.
+     */
+    cost: Money;
+    /**
+     * Specifies the license type of the external segment. This attribute is read-only.
+     */
+    licenseType: LicenseType;
+    /**
+     * Specifies the date and time at which this segment becomes available for use. This attribute is readonly and is assigned by the data provider.
+     */
+    startDateTime: DateTime;
+    /**
+     * Specifies the date and time at which this segment ceases to be available for use. This attribute is readonly and is assigned by the data provider.
+     */
+    endDateTime: DateTime;
+};
+/**
+ * A {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.NonRuleBasedFirstPartyAudienceSegment NonRuleBasedFirstPartyAudienceSegment}
+ * is a {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.FirstPartyAudienceSegment FirstPartyAudienceSegment}
+ * owned by the publisher network. It doesn't contain a rule. Cookies are usually added to this segment via cookie upload.
+ */
+declare type NonRuleBasedFirstPartyAudienceSegment = AudienceSegment & {
+    /**
+     * Specifies the number of days after which a user's cookie will be removed from the audience segment due to inactivity.
+     * This attribute is required and can be between 1 and 540.
+     */
+    membershipExpirationDays: number;
+};
+/**
+ * A {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.RuleBasedFirstPartyAudienceSegmentSummary RuleBasedFirstPartyAudienceSegmentSummary}
+ * is a {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.FirstPartyAudienceSegment FirstPartyAudienceSegment}
+ * owned by the publisher network.
+ */
+declare type RuleBasedFirstPartyAudienceSegmentSummary = AudienceSegment & {
+    /**
+     * Specifies the number of times a user's cookie must match the segment rule before it's associated with the audience segment.
+     * This is used in combination with FirstPartyAudienceSegment.recencyDays to determine eligibility of the association.
+     * This attribute is required and can be between 1 and 12.
+     */
+    pageViews: number;
+    /**
+     * Specifies the number of days within which a user's cookie must match the segment rule before it's associated with the audience segment.
+     * This is used in combination with FirstPartyAudienceSegment.pageViews to determine eligibility of the association.
+     * This attribute is required only if FirstPartyAudienceSegment.pageViews is greater than 1. When required, it can be between 1 and 90.
+     */
+    recencyDays: number;
+    /**
+     * Specifies the number of days after which a user's cookie will be removed from the audience segment due to inactivity.
+     * This attribute is required and can be between 1 and 540.
+     */
+    membershipExpirationDays: number;
+};
+export declare type FirstPartyAudienceSegment = NonRuleBasedFirstPartyAudienceSegment | RuleBasedFirstPartyAudienceSegmentSummary;
+/**
+ * Action that can be performed on {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.AudienceSegment AudienceSegment} objects.
+ */
+export declare type AudienceSegmentAction = 'ActivateAudienceSegments' | 'ApproveAudienceSegments' | 'DeactivateAudienceSegments' | 'PopulateAudienceSegments' | 'RejectAudienceSegments';
+/**
+ * Represents a page of {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.AudienceSegment AudienceSegment} objects.
+ */
+export declare type AudienceSegmentPage = PageResult<FirstPartyAudienceSegment | ThirdPartyAudienceSegment | SharedAudienceSegment>;
+export {};
+//# sourceMappingURL=audienceSegment.type.d.ts.map

package/dist/client/services/audienceSegment/audienceSegment.type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"audienceSegment.type.d.ts","sourceRoot":"","sources":["../../../../lib/client/services/audienceSegment/audienceSegment.type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAC3C,OAAO,EACL,6BAA6B,EAC7B,qBAAqB,EACrB,mBAAmB,EACnB,WAAW,EACZ,MAAM,wBAAwB,CAAC;AAEhC;;;;;;GAMG;AACH,aAAK,2BAA2B,GAAG;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;GAEG;AACH,aAAK,eAAe,GAAG;IACrB;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,MAAM,EAAE,qBAAqB,CAAC;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,YAAY,EAAE,2BAA2B,CAAC;IAC1C;;OAEG;IACH,IAAI,EAAE,mBAAmB,CAAC;CAC3B,CAAC;AAEF;;;;GAIG;AACH,aAAK,qBAAqB,GAAG,eAAe,GAAG,EAAE,CAAC;AAElD;;;;GAIG;AACH,aAAK,yBAAyB,GAAG,eAAe,GAAG;IACjD;;OAEG;IACH,cAAc,EAAE,6BAA6B,CAAC;IAC9C;;;;OAIG;IACH,IAAI,EAAE,KAAK,CAAC;IACZ;;OAEG;IACH,WAAW,EAAE,WAAW,CAAC;IACzB;;OAEG;IACH,aAAa,EAAE,QAAQ,CAAC;IACxB;;OAEG;IACH,WAAW,EAAE,QAAQ,CAAC;CACvB,CAAC;AAEF;;;;GAIG;AACH,aAAK,qCAAqC,GAAG,eAAe,GAAG;IAC7D;;;OAGG;IACH,wBAAwB,EAAE,MAAM,CAAC;CAClC,CAAC;AAEF;;;;GAIG;AACH,aAAK,yCAAyC,GAAG,eAAe,GAAG;IACjE;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,wBAAwB,EAAE,MAAM,CAAC;CAClC,CAAC;AAEF,oBAAY,yBAAyB,GACjC,qCAAqC,GACrC,yCAAyC,CAAC;AAE9C;;GAEG;AACH,oBAAY,qBAAqB,GAC7B,0BAA0B,GAC1B,yBAAyB,GACzB,4BAA4B,GAC5B,0BAA0B,GAC1B,wBAAwB,CAAC;AAE7B;;GAEG;AACH,oBAAY,mBAAmB,GAAG,UAAU,CAC1C,yBAAyB,GAAG,yBAAyB,GAAG,qBAAqB,CAC9E,CAAC"}

package/dist/client/services/audienceSegment/audienceSegment.type.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=audienceSegment.type.js.map

package/dist/client/services/audienceSegment/audienceSegment.type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"audienceSegment.type.js","sourceRoot":"","sources":["../../../../lib/client/services/audienceSegment/audienceSegment.type.ts"],"names":[],"mappings":""}

package/dist/client/services/audienceSegment/audienceSegmentService.interface.d.ts

@@ -0,0 +1,56 @@
+import { Statement, UpdateResult } from '../../../common/types';
+import { AudienceSegmentAction, AudienceSegmentPage, FirstPartyAudienceSegment } from './audienceSegment.type';
+/**
+ * Provides operations for creating, updating and retrieving
+ * {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.AudienceSegment AudienceSegment} objects.
+ *
+ */
+export interface AudienceSegmentServiceOperations {
+    /**
+     * Creates new {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.FirstPartyAudienceSegment FirstPartyAudienceSegment} objects.
+     *
+     * @param segments first-party audience segments to create
+     * @returns created first-party audience segments
+     */
+    createAudienceSegments(segments: FirstPartyAudienceSegment[]): Promise<FirstPartyAudienceSegment[]>;
+    /**
+     * Gets an {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.AudienceSegmentPage AudienceSegmentPage}
+     * of {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.AudienceSegment AudienceSegment}
+     * objects that satisfy the given {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.Statement#query Statement.query}.
+     * The following fields are supported for filtering:
+     *
+     * | PQL Property     | PQL Property                                                                                                                                                                    |
+     * | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+     * | id               | {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.AudienceSegment#id AudienceSegment.id}                                             |
+     * | name             | {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.AudienceSegment#name AudienceSegment.name}                                         |
+     * | status           | {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.AudienceSegment#status AudienceSegment.status}                                     |
+     * | type             | {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.AudienceSegment#type AudienceSegment.type}                                         |
+     * | size             | {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.AudienceSegment#size AudienceSegment.size}                                         |
+     * | dataProviderName | {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.AudienceSegmentDataProvider#name AudienceSegmentDataProvider.name}                 |
+     * | segmentType      | {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.AudienceSegment#type AudienceSegment.type}                                         |
+     * | approvalStatus   | {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.ThirdPartyAudienceSegment#approvalStatus ThirdPartyAudienceSegment.approvalStatus} |
+     * | cost             | {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.ThirdPartyAudienceSegment#cost ThirdPartyAudienceSegment.cost}                     |
+     * | startDateTime    | {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.ThirdPartyAudienceSegment#startDateTime ThirdPartyAudienceSegment.startDateTime}   |
+     * | endDateTime      | {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.ThirdPartyAudienceSegment#endDateTime ThirdPartyAudienceSegment.endDateTime}       |
+     *
+     * @param filterStatement a Publisher Query Language statement used to filter a set of audience segments (the only supported operator is AND)
+     * @returns the audience segments that match the given filter
+     */
+    getAudienceSegmentsByStatement(filterStatement: Statement): Promise<AudienceSegmentPage>;
+    /**
+     * Performs the given AudienceSegmentAction on the set of segments identified by the given statement.
+     *
+     * @param action AudienceSegmentAction to perform
+     * @param filterStatement a Publisher Query Language statement used to filter a set of audience segments (the only supported operator is AND)
+     * @returns UpdateResult indicating the result
+     */
+    performAudienceSegmentAction(action: AudienceSegmentAction, filterStatement: Statement): Promise<UpdateResult>;
+    /**
+     * Updates the given {@link https://developers.google.com/ad-manager/api/reference/v202202/AudienceSegmentService.FirstPartyAudienceSegment FirstPartyAudienceSegment} objects.
+     *
+     * @param segments first-party audience segments to update
+     * @returns updated first-party audience segments
+     */
+    updateAudienceSegments(segments: FirstPartyAudienceSegment[]): Promise<FirstPartyAudienceSegment[]>;
+}
+//# sourceMappingURL=audienceSegmentService.interface.d.ts.map

package/dist/client/services/audienceSegment/audienceSegmentService.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"audienceSegmentService.interface.d.ts","sourceRoot":"","sources":["../../../../lib/client/services/audienceSegment/audienceSegmentService.interface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAChE,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AAE/G;;;;GAIG;AACH,MAAM,WAAW,gCAAgC;IAC/C;;;;;OAKG;IACH,sBAAsB,CAAC,QAAQ,EAAE,yBAAyB,EAAE,GAAG,OAAO,CAAC,yBAAyB,EAAE,CAAC,CAAC;IACpG;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,8BAA8B,CAAC,eAAe,EAAE,SAAS,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACzF;;;;;;OAMG;IACH,4BAA4B,CAAC,MAAM,EAAE,qBAAqB,EAAE,eAAe,EAAE,SAAS,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAC/G;;;;;OAKG;IACH,sBAAsB,CAAC,QAAQ,EAAE,yBAAyB,EAAE,GAAG,OAAO,CAAC,yBAAyB,EAAE,CAAC,CAAC;CACrG"}

package/dist/client/services/audienceSegment/audienceSegmentService.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=audienceSegmentService.interface.js.map

package/dist/client/services/audienceSegment/audienceSegmentService.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"audienceSegmentService.interface.js","sourceRoot":"","sources":["../../../../lib/client/services/audienceSegment/audienceSegmentService.interface.ts"],"names":[],"mappings":""}

package/dist/client/services/audienceSegment/index.d.ts

@@ -0,0 +1,2 @@
+export { AudienceSegmentService } from './audienceSegment.service';
+//# sourceMappingURL=index.d.ts.map

package/dist/client/services/audienceSegment/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../lib/client/services/audienceSegment/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAC"}

package/dist/client/services/audienceSegment/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AudienceSegmentService = void 0;
+var audienceSegment_service_1 = require("./audienceSegment.service");
+Object.defineProperty(exports, "AudienceSegmentService", { enumerable: true, get: function () { return audienceSegment_service_1.AudienceSegmentService; } });
+//# sourceMappingURL=index.js.map

package/dist/client/services/audienceSegment/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../lib/client/services/audienceSegment/index.ts"],"names":[],"mappings":";;;AAAA,qEAAmE;AAA1D,iIAAA,sBAAsB,OAAA"}