@niur/google-admanager-api 0.0.5

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

@@ -0,0 +1,396 @@
+import { DateRange, DateTime } from '../../../common/types';
+import { UnitType } from '../../common/enums';
+import { CreativePlaceholder, Targeting } from '../../common/types';
+import { LineItem } from '../lineItem/lineItem.type';
+import { ProposalLineItem } from '../proposalLineItem/proposalLineItem.type';
+import { GrpAge, GrpGender, GrpUnitType, TargetingDimension } from './forecast.enum';
+/**
+ * Represents a prospective line item to be forecasted.
+ */
+export declare type ProspectiveLineItem = {
+    /**
+     * The target of the forecast. If LineItem.id is null or no line item exists with that ID, then a forecast is computed for the subject,
+     * predicting what would happen if it were added to the network. If a line item already exists with LineItem.id,
+     * the forecast is computed for the subject, predicting what would happen if the existing line item's settings were modified to match the subject.
+     */
+    lineItem: LineItem;
+    /**
+     * The target of the forecast if this prospective line item is a proposal line item.
+     *
+     * If ProposalLineItem.id is null or no proposal line item exists with that ID, then a forecast is computed for the subject,
+     * predicting what would happen if it were added to the network.
+     * If a proposal line item already exists with ProposalLineItem.id, the forecast is computed for the subject,
+     * predicting what would happen if the existing proposal line item's settings were modified to match the subject.
+     *
+     * A proposal line item can optionally correspond to an order LineItem, in which case,
+     * by forecasting a proposal line item, the corresponding line item is implicitly ignored in the forecasting.
+     *
+     * Either lineItem or proposalLineItem should be specified but not both.
+     */
+    proposalLineItem: ProposalLineItem;
+    /**
+     * When set, the line item is assumed to be from this advertiser, and unified blocking rules will apply accordingly. If absent, line items without an existing order won't be subject to unified blocking rules.
+     */
+    advertiserId: number;
+};
+/**
+ * Specifies inventory targeted by a breakdown entry.
+ */
+export declare type ForecastBreakdownTarget = {
+    /**
+     * An optional name for this breakdown target, to be populated in the corresponding ForecastBreakdownEntry.name field.
+     */
+    name: string;
+    /**
+     * If specified, the targeting for this breakdown.
+     */
+    targeting: Targeting;
+    /**
+     * If specified, restrict the breakdown to only inventory matching this creative.
+     */
+    creative: CreativePlaceholder;
+};
+/**
+ * Configuration of forecast breakdown.
+ */
+export declare type ForecastBreakdownOptions = {
+    /**
+     * The boundaries of time windows to configure time breakdown.
+     *
+     * By default, the time window of the forecasted LineItem is assumed if none are explicitly specified in this field.
+     * But if set, at least two DateTimes are needed to define the boundaries of minimally one time window.
+     *
+     * Also, the time boundaries are required to be in the same time zone, in strictly ascending order.
+     */
+    timeWindows: DateTime[];
+    /**
+     * For each time window, these are the breakdown targets. If none specified, the targeting of the forecasted LineItem is assumed.
+     */
+    targets: ForecastBreakdownTarget[];
+};
+/**
+ * Forecasting options for line item availability forecasts.
+ */
+export declare type AvailabilityForecastOptions = {
+    /**
+     * When specified, forecast result for the availability line item will also include breakdowns by its targeting in AvailabilityForecast.targetingCriteriaBreakdowns.
+     */
+    includeTargetingCriteriaBreakdown: boolean;
+    /**
+     * When specified, the forecast result for the availability line item will also include contending line items in AvailabilityForecast.contendingLineItems.
+     */
+    includeContendingLineItems: boolean;
+    breakdown: ForecastBreakdownOptions;
+};
+/**
+ * Represents a single delivery data point, with both available and forecast number.
+ */
+export declare type BreakdownForecast = {
+    matched: number;
+    available: number;
+    possible: number;
+};
+/**
+ * A single forecast breakdown entry.
+ */
+export declare type ForecastBreakdownEntry = {
+    /**
+     * The optional name of this entry, as specified in the corresponding ForecastBreakdownTarget.name field.
+     */
+    name: string;
+    /**
+     * The forecast of this entry.
+     */
+    forecast: BreakdownForecast;
+};
+/**
+ * Represents the breakdown entries for a list of targetings and/or creatives.
+ */
+export declare type ForecastBreakdown = {
+    /**
+     * The starting time of the represented breakdown.
+     */
+    startTime: DateTime;
+    /**
+     * The end time of the represented breakdown.
+     */
+    endTime: DateTime;
+    /**
+     * The forecast breakdown entries in the same order as in the ForecastBreakdownOptions.targets field.
+     */
+    breakdownEntries: ForecastBreakdownEntry[];
+};
+/**
+ * A single targeting criteria breakdown result.
+ */
+export declare type TargetingCriteriaBreakdown = {
+    /**
+     * The dimension of this breakdown
+     */
+    targetingDimension: TargetingDimension;
+    /**
+     * The unique ID of the targeting criteria.
+     */
+    targetingCriteriaId: number;
+    /**
+     * The name of the targeting criteria.
+     */
+    targetingCriteriaName: string;
+    /**
+     * When true, the breakdown is negative.
+     */
+    excluded: boolean;
+    /**
+     * The available units for this breakdown.
+     */
+    availableUnits: number;
+    /**
+     * The matched units for this breakdown.
+     */
+    matchedUnits: number;
+};
+/**
+ * Describes contending line items for a Forecast.
+ */
+export declare type ContendingLineItem = {
+    /**
+     * The Id of the contending line item.
+     */
+    lineItemId: number;
+    /**
+     * Number of impressions contended for by both the forecasted line item and this line item, but served to this line item in the forecast simulation.
+     */
+    contendingImpressions: number;
+};
+/**
+ * A view of the forecast in terms of an alternative unit type.
+ *
+ * For example, a forecast for an impressions goal may include this to express the matched, available, and possible viewable impressions.
+ */
+export declare type AlternativeUnitTypeForecast = {
+    /**
+     * The alternative unit type being presented.
+     */
+    unitType: UnitType;
+    /**
+     * The number of units, defined by unitType, that match the specified targeting and delivery settings.
+     */
+    matchedUnits: number;
+    /**
+     * The number of units, defined by unitType, that can be booked without affecting the delivery of any reserved line items. Exceeding this value will not cause an overbook, but lower-priority line items may not run.
+     */
+    availableUnits: number;
+    /**
+     * The maximum number of units, defined by unitType, that could be booked by taking inventory away from lower-priority line items.
+     */
+    possibleUnits: number;
+};
+/**
+ * GRP forecast breakdown counts associated with a gender and age demographic.
+ */
+export declare type GrpDemographicBreakdown = {
+    /**
+     * The number of units matching the demographic breakdown that can be booked without affecting the delivery of any reserved line items.
+     */
+    availableUnits: number;
+    /**
+     * The number of units matching the demographic and matching specified targeting and delivery settings.
+     */
+    matchedUnits: number;
+    /**
+     * The GrpUnitType associated with this demographic breakdown.
+     */
+    unitType: GrpUnitType;
+    /**
+     * The GrpGender associated with this demographic breakdown.
+     */
+    gender: GrpGender;
+    /**
+     *  The GrpAge associated with this demographic breakdown.
+     */
+    age: GrpAge;
+};
+/**
+ * Describes predicted inventory availability for a {@link https://developers.google.com/ad-manager/api/reference/v202202/ForecastService.ProspectiveLineItem ProspectiveLineItem}.
+ *
+ * Inventory has three threshold values along a line of possible inventory. From least to most, these are:
+ *
+ * - Available units -- How many units can be booked without affecting any other line items. Booking more than this number can cause lower and same priority line items to underdeliver.
+ * - Possible units -- How many units can be booked without affecting any higher priority line items. Booking more than this number can cause the line item to underdeliver.
+ * - Matched (forecast) units -- How many units satisfy all specified criteria.
+ *
+ * Underdelivery is caused by overbooking. However, if more impressions are served than are predicted, the extra available inventory might enable all inventory guarantees to be met without overbooking.
+ */
+export declare type AvailabilityForecast = {
+    /**
+     * Uniquely identifies this availability forecast. This value is read-only and is assigned by Google when the forecast is created. The attribute will be either the ID of the LineItem object it represents, or null if the forecast represents a prospective line item.
+     */
+    lineItemId: number;
+    /**
+     * The unique ID for the Order object that this line item belongs to, or null if the forecast represents a prospective line item without an LineItem.orderId set.
+     */
+    orderId: number;
+    /**
+     * The unit with which the goal or cap of the LineItem is defined. Will be the same value as Goal.unitType for both a set line item or a prospective one.
+     */
+    unitType: UnitType;
+    /**
+     * The number of units, defined by Goal.unitType, that can be booked without affecting the delivery of any reserved line items. Exceeding this value will not cause an overbook, but lower priority line items may not run.
+     */
+    availableUnits: number;
+    /**
+     * The number of units, defined by Goal.unitType, that have already been served if the reservation is already running.
+     */
+    deliveredUnits: number;
+    /**
+     * The number of units, defined by Goal.unitType, that match the specified targeting and delivery settings.
+     */
+    matchedUnits: number;
+    /**
+     * The maximum number of units, defined by Goal.unitType, that could be booked by taking inventory away from lower priority line items and some same priority line items.
+     *
+     * Please note: booking this number may cause lower priority line items and some same priority line items to underdeliver.
+     */
+    possibleUnits: number;
+    /**
+     * The number of reserved units, defined by Goal.unitType, requested. This can be an absolute or percentage value.
+     */
+    reservedUnits: number;
+    /**
+     * The breakdowns for each time window defined in ForecastBreakdownOptions.timeWindows.
+     */
+    breakdowns: ForecastBreakdown[];
+    /**
+     * The forecast result broken down by the targeting of the forecasted line item.
+     */
+    targetingCriteriaBreakdowns: TargetingCriteriaBreakdown[];
+    /**
+     * List of contending line items for this forecast.
+     */
+    contendingLineItems: ContendingLineItem[];
+    /**
+     * Views of this forecast, with alternative unit types.
+     */
+    alternativeUnitTypeForecasts: AlternativeUnitTypeForecast[];
+    /**
+     * The forecast result broken down by demographics.
+     */
+    demographicBreakdowns: GrpDemographicBreakdown[];
+};
+/**
+ * Forecasting options for line item delivery forecasts.
+ */
+export declare type DeliveryForecastOptions = {
+    /**
+     * Line item IDs to be ignored while performing the delivery simulation.
+     */
+    ignoredLineItemIds: number[];
+};
+/**
+ * The forecasted delivery of a ProspectiveLineItem.
+ */
+export declare type LineItemDeliveryForecast = {
+    /**
+     * Uniquely identifies this line item delivery forecast. This value is read-only and will be either the ID of the LineItem object it represents, or null if the forecast represents a prospective line item.
+     */
+    lineItemId: number;
+    /**
+     * The unique ID for the Order object that this line item belongs to, or null if the forecast represents a prospective line item without an LineItem.orderId set.
+     */
+    orderId: number;
+    /**
+     * The unit with which the goal or cap of the LineItem is defined. Will be the same value as Goal.unitType for both a set line item or a prospective one.
+     */
+    unitType: UnitType;
+    /**
+     * The number of units, defined by Goal.unitType, that will be delivered by the line item. Delivery of existing line items that are of same or lower priorities may be impacted.
+     */
+    predictedDeliveryUnits: number;
+    /**
+     * The number of units, defined by Goal.unitType, that have already been served if the reservation is already running.
+     */
+    deliveredUnits: number;
+    /**
+     * The number of units, defined by Goal.unitType, that match the specified LineItem.targeting and delivery settings.
+     */
+    matchedUnits: number;
+};
+/**
+ * The forecast of delivery for a list of ProspectiveLineItem objects to be reserved at the same time.
+ */
+export declare type DeliveryForecast = {
+    /**
+     * The delivery forecasts of the forecasted line items.
+     */
+    lineItemDeliveryForecasts: LineItemDeliveryForecast[];
+};
+/**
+ * Defines a segment of traffic for which traffic data should be returned.
+ */
+export declare type TrafficDataRequest = {
+    /**
+     * The TargetingDto that defines a segment of traffic.
+     *
+     * This attribute is required.
+     */
+    targeting: Targeting;
+    /**
+     * The date range for which traffic data are requested. This range may cover historical dates, future dates, or both.
+     *
+     * The data returned are not guaranteed to cover the entire requested date range.
+     * If sufficient data are not available to cover the entire requested date range, a response may be returned with a later start date, earlier end date, or both.
+     *
+     * This attribute is required.
+     */
+    requestedDateRange: DateRange;
+};
+/**
+ * Represents a chronological sequence of daily values.
+ */
+export declare type TimeSeries = {
+    /**
+     * The date range of the time series.
+     */
+    timeSeriesDateRange: DateRange;
+    /**
+     * The daily values constituting the time series.
+     *
+     * The number of time series values must equal the number of days spanned by the time series date range, inclusive.
+     * E.g.: timeSeriesDateRange of 2001-08-15 to 2001-08-17 should contain one value for the 15th, one value for the 16th, and one value for the 17th.
+     */
+    values: number[];
+};
+/**
+ *
+ */
+export declare type TrafficDataResponse = {
+    /**
+     * Time series of historical traffic ad opportunity counts.
+     *
+     * This may be null if the requested date range did not contain any historical dates, or if no historical data are available for the requested traffic segment. This attribute is read-only.
+     */
+    historicalTimeSeries: TimeSeries;
+    /**
+     * Time series of forecasted traffic ad opportunity counts.
+     *
+     * This may be null if the requested date range did not contain any future dates, or if no forecasted data are available for the requested traffic segment.
+     * This attribute is read-only.
+     */
+    forecastedTimeSeries: TimeSeries;
+    /**
+     * Time series of future traffic volumes forecasted to be sold.
+     *
+     * This may be null if the requested date range did not contain any future dates, or if no sell-through data are available for the requested traffic segment.
+     * This attribute is read-only.
+     */
+    forecastedAssignedTimeSeries: TimeSeries;
+    /**
+     * The overall date range spanned by the union of all time series in the response.
+     *
+     * This is a summary field for convenience. The value will be set such that the start date is equal to the earliest start date of all time series included, and the end date is equal to the latest end date of all time series included.
+     *
+     * If all time series fields are null, this field will also be null. This attribute is read-only.
+     */
+    overallDateRange: DateRange;
+};
+//# sourceMappingURL=forecast.type.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"forecast.type.d.ts","sourceRoot":"","sources":["../../../../lib/client/services/forecast/forecast.type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,mBAAmB,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACpE,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AACrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,2CAA2C,CAAC;AAC7E,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAErF;;GAEG;AACH,oBAAY,mBAAmB,GAAG;IAChC;;;;OAIG;IACH,QAAQ,EAAE,QAAQ,CAAC;IAEnB;;;;;;;;;;;;OAYG;IACH,gBAAgB,EAAE,gBAAgB,CAAC;IAEnC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,oBAAY,uBAAuB,GAAG;IACpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,EAAE,SAAS,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE,mBAAmB,CAAC;CAC/B,CAAC;AAEF;;GAEG;AACH,oBAAY,wBAAwB,GAAG;IACrC;;;;;;;OAOG;IACH,WAAW,EAAE,QAAQ,EAAE,CAAC;IAExB;;OAEG;IACH,OAAO,EAAE,uBAAuB,EAAE,CAAC;CACpC,CAAC;AAEF;;GAEG;AACH,oBAAY,2BAA2B,GAAG;IACxC;;OAEG;IACH,iCAAiC,EAAE,OAAO,CAAC;IAE3C;;OAEG;IACH,0BAA0B,EAAE,OAAO,CAAC;IAEpC,SAAS,EAAE,wBAAwB,CAAC;CACrC,CAAC;AAEF;;GAEG;AACH,oBAAY,iBAAiB,GAAG;IAC9B,OAAO,EAAE,MAAM,CAAC;IAEhB,SAAS,EAAE,MAAM,CAAC;IAElB,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,oBAAY,sBAAsB,GAAG;IACnC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,iBAAiB,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,oBAAY,iBAAiB,GAAG;IAC9B;;OAEG;IACH,SAAS,EAAE,QAAQ,CAAC;IAEpB;;OAEG;IACH,OAAO,EAAE,QAAQ,CAAC;IAElB;;OAEG;IACH,gBAAgB,EAAE,sBAAsB,EAAE,CAAC;CAC5C,CAAC;AAEF;;GAEG;AACH,oBAAY,0BAA0B,GAAG;IACvC;;OAEG;IACH,kBAAkB,EAAE,kBAAkB,CAAC;IAEvC;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,oBAAY,kBAAkB,GAAG;IAC/B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;CAC/B,CAAC;AAEF;;;;GAIG;AACH,oBAAY,2BAA2B,GAAG;IACxC;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,oBAAY,uBAAuB,GAAG;IACpC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE,WAAW,CAAC;IAEtB;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;IAElB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;;;;;;;;;GAUG;AACH,oBAAY,oBAAoB,GAAG;IACjC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;IAEnB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,EAAE,iBAAiB,EAAE,CAAC;IAEhC;;OAEG;IACH,2BAA2B,EAAE,0BAA0B,EAAE,CAAC;IAE1D;;OAEG;IACH,mBAAmB,EAAE,kBAAkB,EAAE,CAAC;IAE1C;;OAEG;IACH,4BAA4B,EAAE,2BAA2B,EAAE,CAAC;IAE5D;;OAEG;IACH,qBAAqB,EAAE,uBAAuB,EAAE,CAAC;CAClD,CAAC;AAEF;;GAEG;AACH,oBAAY,uBAAuB,GAAG;IACpC;;OAEG;IACH,kBAAkB,EAAE,MAAM,EAAE,CAAC;CAC9B,CAAC;AAEF;;GAEG;AACH,oBAAY,wBAAwB,GAAG;IACrC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;IAEnB;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,oBAAY,gBAAgB,GAAG;IAC7B;;OAEG;IACH,yBAAyB,EAAE,wBAAwB,EAAE,CAAC;CACvD,CAAC;AAEF;;GAEG;AACH,oBAAY,kBAAkB,GAAG;IAC/B;;;;OAIG;IACH,SAAS,EAAE,SAAS,CAAC;IAErB;;;;;;;OAOG;IACH,kBAAkB,EAAE,SAAS,CAAC;CAC/B,CAAC;AAEF;;GAEG;AACH,oBAAY,UAAU,GAAG;IACvB;;OAEG;IACH,mBAAmB,EAAE,SAAS,CAAC;IAE/B;;;;;OAKG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,oBAAY,mBAAmB,GAAG;IAChC;;;;OAIG;IACH,oBAAoB,EAAE,UAAU,CAAC;IAEjC;;;;;OAKG;IACH,oBAAoB,EAAE,UAAU,CAAC;IAEjC;;;;;OAKG;IACH,4BAA4B,EAAE,UAAU,CAAC;IAEzC;;;;;;OAMG;IACH,gBAAgB,EAAE,SAAS,CAAC;CAC7B,CAAC"}

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

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

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

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

package/dist/client/services/forecast/forecastService.interface.d.ts

@@ -0,0 +1,58 @@
+import { AvailabilityForecast, AvailabilityForecastOptions, DeliveryForecast, DeliveryForecastOptions, ProspectiveLineItem, TrafficDataRequest, TrafficDataResponse } from './forecast.type';
+/**
+ * Provides methods for estimating traffic (clicks/impressions) for line items.
+ * Forecasts can be provided for {@link https://developers.google.com/ad-manager/api/reference/v202202/ForecastService.LineItem LineItem}
+ * objects that exist in the system or which have not had an ID set yet.
+ */
+export interface ForecastServiceOperations {
+    /**
+     * Gets the availability forecast for a {@link https://developers.google.com/ad-manager/api/reference/v202202/ForecastService.ProspectiveLineItem ProspectiveLineItem}.
+     * An availability forecast reports the maximum number of available units that the line item can book, and the total number of units matching the line item's targeting.
+     *
+     * @param lineItem the prospective line item (new or existing) to be forecasted for availability
+     * @param forecastOptions options controlling the forecast
+     */
+    getAvailabilityForecast(lineItem: ProspectiveLineItem, forecastOptions: AvailabilityForecastOptions): Promise<AvailabilityForecast>;
+    /**
+     * Gets an {@link https://developers.google.com/ad-manager/api/reference/v202202/ForecastService.AvailabilityForecast AvailabilityForecast}
+     * for an existing {@link https://developers.google.com/ad-manager/api/reference/v202202/ForecastService.LineItem LineItem} object.
+     * An availability forecast reports the maximum number of available units that the line item can be booked with,
+     * and also the total number of units matching the line item's targeting.
+     *
+     * Only line items having type {@link https://developers.google.com/ad-manager/api/reference/v202202/ForecastService.LineItemType#SPONSORSHIP LineItemType.SPONSORSHIP}
+     * or {@link https://developers.google.com/ad-manager/api/reference/v202202/ForecastService.LineItemType#STANDARD LineItemType.STANDARD} are valid.
+     * Other types will result in {@link https://developers.google.com/ad-manager/api/reference/v202202/ForecastService.ReservationDetailsError.Reason#LINE_ITEM_TYPE_NOT_ALLOWED ReservationDetailsError.Reason.LINE_ITEM_TYPE_NOT_ALLOWED}.
+     *
+     * @param lineItemId the ID of a LineItem to run the forecast on.
+     * @param forecastOptions options controlling the forecast
+     */
+    getAvailabilityForecastById(lineItemId: number, forecastOptions: AvailabilityForecastOptions): Promise<AvailabilityForecast>;
+    /**
+     * Gets the delivery forecast for a list of {@link https://developers.google.com/ad-manager/api/reference/v202202/ForecastService.ProspectiveLineItem ProspectiveLineItem}
+     * objects in a single delivery simulation with line items potentially contending with each other.
+     * A delivery forecast reports the number of units that will be delivered to each line item given the line item goals and contentions from other line items.
+     *
+     * @param lineItems line items to be forecasted for delivery
+     * @param forecastOptions options controlling the forecast
+     */
+    getDeliveryForecast(lineItems: ProspectiveLineItem[], forecastOptions: DeliveryForecastOptions): Promise<DeliveryForecast>;
+    /**
+     * Gets the delivery forecast for a list of existing {@link https://developers.google.com/ad-manager/api/reference/v202202/ForecastService.LineItem LineItem}
+     * objects in a single delivery simulation.
+     * A delivery forecast reports the number of units that will be delivered to each line item given the line item goals and contentions from other line items.
+     *
+     * @param lineItemIds the IDs of line items to be forecasted for delivery
+     * @param forecastOptions options controlling the forecast
+     */
+    getDeliveryForecastByIds(lineItemIds: number[], forecastOptions: DeliveryForecastOptions): Promise<DeliveryForecast>;
+    /**
+     * Returns forecasted and historical traffic data for the segment of traffic specified by the provided request.
+     *
+     * Calling this endpoint programmatically is only available for Ad Manager 360 networks.
+     *
+     * @param trafficDataRequest the request specifying the segment of traffic for which data should be returned
+     * @returns a dto containing forecasted and historical traffic data for the specified segment of traffic
+     */
+    getTrafficData(trafficDataRequest: TrafficDataRequest): Promise<TrafficDataResponse>;
+}
+//# sourceMappingURL=forecastService.interface.d.ts.map

package/dist/client/services/forecast/forecastService.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"forecastService.interface.d.ts","sourceRoot":"","sources":["../../../../lib/client/services/forecast/forecastService.interface.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,2BAA2B,EAC3B,gBAAgB,EAChB,uBAAuB,EACvB,mBAAmB,EACnB,kBAAkB,EAClB,mBAAmB,EACpB,MAAM,iBAAiB,CAAC;AAEzB;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;;;;OAMG;IACH,uBAAuB,CACrB,QAAQ,EAAE,mBAAmB,EAC7B,eAAe,EAAE,2BAA2B,GAC3C,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACjC;;;;;;;;;;;;OAYG;IACH,2BAA2B,CACzB,UAAU,EAAE,MAAM,EAClB,eAAe,EAAE,2BAA2B,GAC3C,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACjC;;;;;;;OAOG;IACH,mBAAmB,CACjB,SAAS,EAAE,mBAAmB,EAAE,EAChC,eAAe,EAAE,uBAAuB,GACvC,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC7B;;;;;;;OAOG;IACH,wBAAwB,CAAC,WAAW,EAAE,MAAM,EAAE,EAAE,eAAe,EAAE,uBAAuB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACrH;;;;;;;OAOG;IACH,cAAc,CAAC,kBAAkB,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;CACtF"}

package/dist/client/services/forecast/forecastService.interface.js

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

package/dist/client/services/forecast/forecastService.interface.js.map

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

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

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

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

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

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../lib/client/services/forecast/index.ts"],"names":[],"mappings":";;;AAAA,uDAAqD;AAA5C,mHAAA,eAAe,OAAA"}

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

@@ -0,0 +1,44 @@
+export { ActivityGroupService } from './activityGroup';
+export { ActivityService } from './activity';
+export { AdjustmentService } from './adjustment';
+export { AdRuleService } from './adRule';
+export { AudienceSegmentService } from './audienceSegment';
+export { CdnConfigurationService } from './cdnConfiguration';
+export { CmsMetadataService } from './cmsMetadata';
+export { CompanyService } from './company';
+export { ContactService } from './contact';
+export { ContentBundleService } from './contentBundles';
+export { ContentService } from './content';
+export { CreativeReviewService } from './creativeReview';
+export { CreativeService } from './creative';
+export { CreativeSetService } from './creativeSet';
+export { CreativeTemplateService } from './creativeTemplate';
+export { CreativeWrapperService } from './creativeWrapper';
+export { CustomFieldService } from './customField';
+export { CustomTargetingService } from './customTargeting';
+export { DaiAuthenticationKeyService } from './daiAuthenticationKey';
+export { DaiEncodingProfileService } from './daiEncodingProfile';
+export { ForecastService } from './forecast';
+export { InventoryService } from './inventory';
+export { LabelService } from './label';
+export { LineItemCreativeAssociationService } from './lineItemCreativeAssociation';
+export { LineItemService } from './lineItem';
+export { LineItemTemplateService } from './lineItemTemplate';
+export { LiveStreamEventService } from './liveStreamEvent';
+export { MobileApplicationService } from './mobileApplication';
+export { NativeStyleService } from './nativeStyle';
+export { NetworkService } from './network';
+export { OrderService } from './order';
+export { PlacementService } from './placement';
+export { ProposalLineItemService } from './proposalLineItem';
+export { ProposalService } from './proposal';
+export { PublisherQueryLanguageService } from './publisherQueryLanguage';
+export { ReportService } from './report';
+export { SiteService } from './site';
+export { StreamActivityMonitorService } from './streamActivityMonitor';
+export { SuggestedAdUnitService } from './suggestedAdUnit';
+export { TargetingPresetService } from './targetingPresent';
+export { TeamService } from './team';
+export { UserService } from './user';
+export { UserTeamAssociationService } from './userTeamAssociation';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../lib/client/services/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAC3D,OAAO,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAC7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAC7D,OAAO,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAC3D,OAAO,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AACrE,OAAO,EAAE,yBAAyB,EAAE,MAAM,sBAAsB,CAAC;AACjE,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,kCAAkC,EAAE,MAAM,+BAA+B,CAAC;AACnF,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAC7D,OAAO,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAC3D,OAAO,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,6BAA6B,EAAE,MAAM,0BAA0B,CAAC;AACzE,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AACrC,OAAO,EAAE,4BAA4B,EAAE,MAAM,yBAAyB,CAAC;AACvE,OAAO,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAC3D,OAAO,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AACrC,OAAO,EAAE,0BAA0B,EAAE,MAAM,uBAAuB,CAAC"}

package/dist/client/services/index.js

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserTeamAssociationService = exports.UserService = exports.TeamService = exports.TargetingPresetService = exports.SuggestedAdUnitService = exports.StreamActivityMonitorService = exports.SiteService = exports.ReportService = exports.PublisherQueryLanguageService = exports.ProposalService = exports.ProposalLineItemService = exports.PlacementService = exports.OrderService = exports.NetworkService = exports.NativeStyleService = exports.MobileApplicationService = exports.LiveStreamEventService = exports.LineItemTemplateService = exports.LineItemService = exports.LineItemCreativeAssociationService = exports.LabelService = exports.InventoryService = exports.ForecastService = exports.DaiEncodingProfileService = exports.DaiAuthenticationKeyService = exports.CustomTargetingService = exports.CustomFieldService = exports.CreativeWrapperService = exports.CreativeTemplateService = exports.CreativeSetService = exports.CreativeService = exports.CreativeReviewService = exports.ContentService = exports.ContentBundleService = exports.ContactService = exports.CompanyService = exports.CmsMetadataService = exports.CdnConfigurationService = exports.AudienceSegmentService = exports.AdRuleService = exports.AdjustmentService = exports.ActivityService = exports.ActivityGroupService = void 0;
+var activityGroup_1 = require("./activityGroup");
+Object.defineProperty(exports, "ActivityGroupService", { enumerable: true, get: function () { return activityGroup_1.ActivityGroupService; } });
+var activity_1 = require("./activity");
+Object.defineProperty(exports, "ActivityService", { enumerable: true, get: function () { return activity_1.ActivityService; } });
+var adjustment_1 = require("./adjustment");
+Object.defineProperty(exports, "AdjustmentService", { enumerable: true, get: function () { return adjustment_1.AdjustmentService; } });
+var adRule_1 = require("./adRule");
+Object.defineProperty(exports, "AdRuleService", { enumerable: true, get: function () { return adRule_1.AdRuleService; } });
+var audienceSegment_1 = require("./audienceSegment");
+Object.defineProperty(exports, "AudienceSegmentService", { enumerable: true, get: function () { return audienceSegment_1.AudienceSegmentService; } });
+var cdnConfiguration_1 = require("./cdnConfiguration");
+Object.defineProperty(exports, "CdnConfigurationService", { enumerable: true, get: function () { return cdnConfiguration_1.CdnConfigurationService; } });
+var cmsMetadata_1 = require("./cmsMetadata");
+Object.defineProperty(exports, "CmsMetadataService", { enumerable: true, get: function () { return cmsMetadata_1.CmsMetadataService; } });
+var company_1 = require("./company");
+Object.defineProperty(exports, "CompanyService", { enumerable: true, get: function () { return company_1.CompanyService; } });
+var contact_1 = require("./contact");
+Object.defineProperty(exports, "ContactService", { enumerable: true, get: function () { return contact_1.ContactService; } });
+var contentBundles_1 = require("./contentBundles");
+Object.defineProperty(exports, "ContentBundleService", { enumerable: true, get: function () { return contentBundles_1.ContentBundleService; } });
+var content_1 = require("./content");
+Object.defineProperty(exports, "ContentService", { enumerable: true, get: function () { return content_1.ContentService; } });
+var creativeReview_1 = require("./creativeReview");
+Object.defineProperty(exports, "CreativeReviewService", { enumerable: true, get: function () { return creativeReview_1.CreativeReviewService; } });
+var creative_1 = require("./creative");
+Object.defineProperty(exports, "CreativeService", { enumerable: true, get: function () { return creative_1.CreativeService; } });
+var creativeSet_1 = require("./creativeSet");
+Object.defineProperty(exports, "CreativeSetService", { enumerable: true, get: function () { return creativeSet_1.CreativeSetService; } });
+var creativeTemplate_1 = require("./creativeTemplate");
+Object.defineProperty(exports, "CreativeTemplateService", { enumerable: true, get: function () { return creativeTemplate_1.CreativeTemplateService; } });
+var creativeWrapper_1 = require("./creativeWrapper");
+Object.defineProperty(exports, "CreativeWrapperService", { enumerable: true, get: function () { return creativeWrapper_1.CreativeWrapperService; } });
+var customField_1 = require("./customField");
+Object.defineProperty(exports, "CustomFieldService", { enumerable: true, get: function () { return customField_1.CustomFieldService; } });
+var customTargeting_1 = require("./customTargeting");
+Object.defineProperty(exports, "CustomTargetingService", { enumerable: true, get: function () { return customTargeting_1.CustomTargetingService; } });
+var daiAuthenticationKey_1 = require("./daiAuthenticationKey");
+Object.defineProperty(exports, "DaiAuthenticationKeyService", { enumerable: true, get: function () { return daiAuthenticationKey_1.DaiAuthenticationKeyService; } });
+var daiEncodingProfile_1 = require("./daiEncodingProfile");
+Object.defineProperty(exports, "DaiEncodingProfileService", { enumerable: true, get: function () { return daiEncodingProfile_1.DaiEncodingProfileService; } });
+var forecast_1 = require("./forecast");
+Object.defineProperty(exports, "ForecastService", { enumerable: true, get: function () { return forecast_1.ForecastService; } });
+var inventory_1 = require("./inventory");
+Object.defineProperty(exports, "InventoryService", { enumerable: true, get: function () { return inventory_1.InventoryService; } });
+var label_1 = require("./label");
+Object.defineProperty(exports, "LabelService", { enumerable: true, get: function () { return label_1.LabelService; } });
+var lineItemCreativeAssociation_1 = require("./lineItemCreativeAssociation");
+Object.defineProperty(exports, "LineItemCreativeAssociationService", { enumerable: true, get: function () { return lineItemCreativeAssociation_1.LineItemCreativeAssociationService; } });
+var lineItem_1 = require("./lineItem");
+Object.defineProperty(exports, "LineItemService", { enumerable: true, get: function () { return lineItem_1.LineItemService; } });
+var lineItemTemplate_1 = require("./lineItemTemplate");
+Object.defineProperty(exports, "LineItemTemplateService", { enumerable: true, get: function () { return lineItemTemplate_1.LineItemTemplateService; } });
+var liveStreamEvent_1 = require("./liveStreamEvent");
+Object.defineProperty(exports, "LiveStreamEventService", { enumerable: true, get: function () { return liveStreamEvent_1.LiveStreamEventService; } });
+var mobileApplication_1 = require("./mobileApplication");
+Object.defineProperty(exports, "MobileApplicationService", { enumerable: true, get: function () { return mobileApplication_1.MobileApplicationService; } });
+var nativeStyle_1 = require("./nativeStyle");
+Object.defineProperty(exports, "NativeStyleService", { enumerable: true, get: function () { return nativeStyle_1.NativeStyleService; } });
+var network_1 = require("./network");
+Object.defineProperty(exports, "NetworkService", { enumerable: true, get: function () { return network_1.NetworkService; } });
+var order_1 = require("./order");
+Object.defineProperty(exports, "OrderService", { enumerable: true, get: function () { return order_1.OrderService; } });
+var placement_1 = require("./placement");
+Object.defineProperty(exports, "PlacementService", { enumerable: true, get: function () { return placement_1.PlacementService; } });
+var proposalLineItem_1 = require("./proposalLineItem");
+Object.defineProperty(exports, "ProposalLineItemService", { enumerable: true, get: function () { return proposalLineItem_1.ProposalLineItemService; } });
+var proposal_1 = require("./proposal");
+Object.defineProperty(exports, "ProposalService", { enumerable: true, get: function () { return proposal_1.ProposalService; } });
+var publisherQueryLanguage_1 = require("./publisherQueryLanguage");
+Object.defineProperty(exports, "PublisherQueryLanguageService", { enumerable: true, get: function () { return publisherQueryLanguage_1.PublisherQueryLanguageService; } });
+var report_1 = require("./report");
+Object.defineProperty(exports, "ReportService", { enumerable: true, get: function () { return report_1.ReportService; } });
+var site_1 = require("./site");
+Object.defineProperty(exports, "SiteService", { enumerable: true, get: function () { return site_1.SiteService; } });
+var streamActivityMonitor_1 = require("./streamActivityMonitor");
+Object.defineProperty(exports, "StreamActivityMonitorService", { enumerable: true, get: function () { return streamActivityMonitor_1.StreamActivityMonitorService; } });
+var suggestedAdUnit_1 = require("./suggestedAdUnit");
+Object.defineProperty(exports, "SuggestedAdUnitService", { enumerable: true, get: function () { return suggestedAdUnit_1.SuggestedAdUnitService; } });
+var targetingPresent_1 = require("./targetingPresent");
+Object.defineProperty(exports, "TargetingPresetService", { enumerable: true, get: function () { return targetingPresent_1.TargetingPresetService; } });
+var team_1 = require("./team");
+Object.defineProperty(exports, "TeamService", { enumerable: true, get: function () { return team_1.TeamService; } });
+var user_1 = require("./user");
+Object.defineProperty(exports, "UserService", { enumerable: true, get: function () { return user_1.UserService; } });
+var userTeamAssociation_1 = require("./userTeamAssociation");
+Object.defineProperty(exports, "UserTeamAssociationService", { enumerable: true, get: function () { return userTeamAssociation_1.UserTeamAssociationService; } });
+//# sourceMappingURL=index.js.map