@guardian/google-admanager-api 6.0.3 → 6.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +17 -0
- package/dist/client/common/enums/delivery.enum.d.ts +1 -1
- package/dist/client/common/enums/delivery.enum.js +1 -1
- package/dist/client/common/enums/general.enum.d.ts +7 -7
- package/dist/client/common/enums/general.enum.js +7 -7
- package/dist/client/common/enums/lineItemSummary.enum.d.ts +4 -4
- package/dist/client/common/enums/lineItemSummary.enum.js +4 -4
- package/dist/client/common/types/general.type.d.ts +21 -21
- package/dist/client/common/types/label.type.d.ts +2 -2
- package/dist/client/common/types/lineItemSummary.type.d.ts +7 -7
- package/dist/client/common/types/targeting.type.d.ts +77 -42
- package/dist/client/common/types/targeting.type.d.ts.map +1 -1
- package/dist/client/common/types/targeting.type.js +48 -19
- package/dist/client/common/types/targeting.type.js.map +1 -1
- package/dist/client/services/activity/activity.type.d.ts +4 -4
- package/dist/client/services/activity/activityService.interface.d.ts +12 -12
- package/dist/client/services/activityGroup/activityGroup.type.d.ts +4 -4
- package/dist/client/services/activityGroup/activityGroupService.interface.d.ts +11 -11
- package/dist/client/services/adRule/adRule.type.d.ts +2 -2
- package/dist/client/services/adRule/adSpot.type.d.ts +1 -1
- package/dist/client/services/adjustment/adjustment.enum.d.ts +1 -1
- package/dist/client/services/adjustment/adjustment.enum.js +1 -1
- package/dist/client/services/adjustment/adjustment.type.d.ts +1 -1
- package/dist/client/services/adjustment/adjustmentService.interface.d.ts +23 -23
- package/dist/client/services/audienceSegment/audienceSegment.action.d.ts +6 -6
- package/dist/client/services/audienceSegment/audienceSegment.action.js +6 -6
- package/dist/client/services/audienceSegment/audienceSegment.enum.d.ts +4 -4
- package/dist/client/services/audienceSegment/audienceSegment.enum.js +4 -4
- package/dist/client/services/audienceSegment/audienceSegment.type.d.ts +14 -14
- package/dist/client/services/audienceSegment/audienceSegmentService.interface.d.ts +17 -17
- package/dist/client/services/cdnConfiguration/cdnConfiguration.action.d.ts +3 -3
- package/dist/client/services/cdnConfiguration/cdnConfiguration.action.js +3 -3
- package/dist/client/services/cdnConfiguration/cdnConfiguration.enum.d.ts +3 -3
- package/dist/client/services/cdnConfiguration/cdnConfiguration.enum.js +3 -3
- package/dist/client/services/cdnConfiguration/cdnConfiguration.interface.d.ts +11 -11
- package/dist/client/services/cdnConfiguration/cdnConfiguration.type.d.ts +1 -1
- package/dist/client/services/cmsMetadata/cmsMetadata.action.d.ts +6 -6
- package/dist/client/services/cmsMetadata/cmsMetadata.action.js +6 -6
- package/dist/client/services/cmsMetadata/cmsMetadataService.interface.d.ts +16 -16
- package/dist/client/services/company/company.type.d.ts +3 -3
- package/dist/client/services/company/companyService.interface.d.ts +11 -11
- package/dist/client/services/contact/contact.type.d.ts +2 -2
- package/dist/client/services/contact/contactService.interface.d.ts +15 -15
- package/dist/client/services/content/content.enum.d.ts +2 -2
- package/dist/client/services/content/content.enum.js +2 -2
- package/dist/client/services/content/content.type.d.ts +1 -1
- package/dist/client/services/content/contentService.interface.d.ts +15 -15
- package/dist/client/services/contentBundle/contentBundle.action.d.ts +3 -3
- package/dist/client/services/contentBundle/contentBundle.action.js +3 -3
- package/dist/client/services/contentBundle/contentBundle.type.d.ts +2 -2
- package/dist/client/services/contentBundle/contentBundleService.interface.d.ts +10 -10
- package/dist/client/services/creative/creative.action.d.ts +3 -3
- package/dist/client/services/creative/creative.action.js +3 -3
- package/dist/client/services/creative/creative.type.d.ts +1 -1
- package/dist/client/services/creative/creativeService.interface.d.ts +15 -15
- package/dist/client/services/creativeReview/creativeReviewService.interface.d.ts +4 -4
- package/dist/client/services/creativeSet/creativeSet.type.d.ts +1 -1
- package/dist/client/services/creativeSet/creativeSetService.interface.d.ts +10 -10
- package/dist/client/services/creativeTemplate/creativeTemplate.type.d.ts +1 -1
- package/dist/client/services/creativeTemplate/creativeTemplateService.interface.d.ts +8 -8
- package/dist/client/services/creativeWrapper/creativeWrapper.action.d.ts +3 -3
- package/dist/client/services/creativeWrapper/creativeWrapper.action.js +3 -3
- package/dist/client/services/creativeWrapper/creativeWrapper.type.d.ts +1 -1
- package/dist/client/services/creativeWrapper/creativeWrapperService.interface.d.ts +15 -15
- package/dist/client/services/customField/customField.action.d.ts +3 -3
- package/dist/client/services/customField/customField.action.js +3 -3
- package/dist/client/services/customField/customField.enum.d.ts +1 -1
- package/dist/client/services/customField/customField.enum.js +1 -1
- package/dist/client/services/customField/customField.type.d.ts +3 -3
- package/dist/client/services/customField/customFieldService.interface.d.ts +22 -22
- package/dist/client/services/customTargeting/customTargeting.action.d.ts +6 -6
- package/dist/client/services/customTargeting/customTargeting.action.js +6 -6
- package/dist/client/services/customTargeting/customTargeting.enum.d.ts +1 -1
- package/dist/client/services/customTargeting/customTargeting.enum.js +1 -1
- package/dist/client/services/customTargeting/customTargeting.interface.d.ts +29 -29
- package/dist/client/services/customTargeting/customTargeting.type.d.ts +2 -2
- package/dist/client/services/daiAuthenticationKey/daiAuthenticationKey.action.d.ts +3 -3
- package/dist/client/services/daiAuthenticationKey/daiAuthenticationKey.action.js +3 -3
- package/dist/client/services/daiAuthenticationKey/daiAuthenticationKey.type.d.ts +1 -1
- package/dist/client/services/daiAuthenticationKey/daiAuthenticationKeyService.interface.d.ts +13 -13
- package/dist/client/services/daiEncodingProfile/daiEncodingProfile.action.d.ts +3 -3
- package/dist/client/services/daiEncodingProfile/daiEncodingProfile.action.js +3 -3
- package/dist/client/services/daiEncodingProfile/daiEncodingProfile.enum.d.ts +1 -1
- package/dist/client/services/daiEncodingProfile/daiEncodingProfile.enum.js +1 -1
- package/dist/client/services/daiEncodingProfile/daiEncodingProfile.type.d.ts +2 -2
- package/dist/client/services/daiEncodingProfile/daiEncodingProfileService.interface.d.ts +11 -11
- package/dist/client/services/forecast/forecast.type.d.ts +1 -1
- package/dist/client/services/forecast/forecastService.interface.d.ts +9 -9
- package/dist/client/services/inventory/adUnit.action.d.ts +4 -4
- package/dist/client/services/inventory/adUnit.action.js +4 -4
- package/dist/client/services/inventory/adUnit.enum.d.ts +2 -2
- package/dist/client/services/inventory/adUnit.enum.js +2 -2
- package/dist/client/services/inventory/adUnit.type.d.ts +2 -2
- package/dist/client/services/inventory/inventoryService.interface.d.ts +16 -16
- package/dist/client/services/label/label.action.d.ts +3 -3
- package/dist/client/services/label/label.action.js +3 -3
- package/dist/client/services/label/label.interface.d.ts +11 -11
- package/dist/client/services/label/label.type.d.ts +1 -1
- package/dist/client/services/lineItem/lineItem.action.d.ts +9 -9
- package/dist/client/services/lineItem/lineItem.action.js +9 -9
- package/dist/client/services/lineItem/lineItem.type.d.ts +2 -2
- package/dist/client/services/lineItem/lineItemService.interface.d.ts +23 -23
- package/dist/client/services/lineItemCreativeAssociation/lineItemCreativeAssociation.action.d.ts +4 -4
- package/dist/client/services/lineItemCreativeAssociation/lineItemCreativeAssociation.action.js +4 -4
- package/dist/client/services/lineItemCreativeAssociation/lineItemCreativeAssociation.type.d.ts +6 -6
- package/dist/client/services/lineItemCreativeAssociation/lineItemCreativeAssociationService.interface.d.ts +18 -18
- package/dist/client/services/lineItemTemplate/lineItemTemplate.type.d.ts +1 -1
- package/dist/client/services/lineItemTemplate/lineItemTemplateService.interface.d.ts +5 -5
- package/dist/client/services/liveStreamEvent/liveStreamEvent.action.d.ts +7 -7
- package/dist/client/services/liveStreamEvent/liveStreamEvent.action.js +7 -7
- package/dist/client/services/liveStreamEvent/liveStreamEvent.enum.d.ts +2 -2
- package/dist/client/services/liveStreamEvent/liveStreamEvent.enum.js +2 -2
- package/dist/client/services/liveStreamEvent/liveStreamEvent.type.d.ts +1 -1
- package/dist/client/services/liveStreamEvent/liveStreamEventService.interface.d.ts +29 -29
- package/dist/client/services/mobileApplication/mobileApplication.action.d.ts +3 -3
- package/dist/client/services/mobileApplication/mobileApplication.action.js +3 -3
- package/dist/client/services/mobileApplication/mobileApplication.enum.d.ts +2 -2
- package/dist/client/services/mobileApplication/mobileApplication.enum.js +2 -2
- package/dist/client/services/mobileApplication/mobileApplication.type.d.ts +1 -1
- package/dist/client/services/mobileApplication/mobileApplicationService.interface.d.ts +12 -12
- package/dist/client/services/nativeStyle/nativeStyle.type.d.ts +1 -1
- package/dist/client/services/nativeStyle/nativeStyleService.interface.d.ts +9 -9
- package/dist/client/services/order/order.action.d.ts +13 -13
- package/dist/client/services/order/order.action.js +13 -13
- package/dist/client/services/order/order.enum.d.ts +5 -5
- package/dist/client/services/order/order.enum.js +5 -5
- package/dist/client/services/order/order.type.d.ts +13 -13
- package/dist/client/services/order/orderService.interface.d.ts +18 -18
- package/dist/client/services/placement/placement.action.d.ts +4 -4
- package/dist/client/services/placement/placement.action.js +4 -4
- package/dist/client/services/placement/placement.type.d.ts +1 -1
- package/dist/client/services/placement/placementService.interface.d.ts +13 -13
- package/dist/client/services/proposal/proposal.action.d.ts +15 -15
- package/dist/client/services/proposal/proposal.action.js +15 -15
- package/dist/client/services/proposal/proposal.enum.d.ts +1 -1
- package/dist/client/services/proposal/proposal.enum.js +1 -1
- package/dist/client/services/proposal/proposal.type.d.ts +3 -3
- package/dist/client/services/proposal/proposalService.interface.d.ts +26 -26
- package/dist/client/services/proposalLineItem/proposalLineItem.action.d.ts +10 -10
- package/dist/client/services/proposalLineItem/proposalLineItem.action.js +10 -10
- package/dist/client/services/proposalLineItem/proposalLineItem.type.d.ts +3 -3
- package/dist/client/services/proposalLineItem/proposalLineItemService.interface.d.ts +15 -15
- package/dist/client/services/publisherQueryLanguage/publisherQueryLanguageService.interface.d.ts +3 -3
- package/dist/client/services/report/report.type.d.ts +2 -2
- package/dist/client/services/report/reportService.interface.d.ts +16 -16
- package/dist/client/services/site/siteService.interface.d.ts +13 -13
- package/dist/client/services/suggestedAdUnit/suggestedAdUnit.action.d.ts +2 -2
- package/dist/client/services/suggestedAdUnit/suggestedAdUnit.action.js +2 -2
- package/dist/client/services/suggestedAdUnit/suggestedAdUnit.type.d.ts +2 -2
- package/dist/client/services/suggestedAdUnit/suggestedAdUnitService.interface.d.ts +9 -9
- package/dist/client/services/targetingPresent/targetingPresentService.interface.d.ts +5 -5
- package/dist/client/services/team/team.action.d.ts +3 -3
- package/dist/client/services/team/team.action.js +3 -3
- package/dist/client/services/team/team.type.d.ts +2 -2
- package/dist/client/services/team/teamService.interface.d.ts +12 -12
- package/dist/client/services/user/user.action.d.ts +3 -3
- package/dist/client/services/user/user.action.js +3 -3
- package/dist/client/services/user/user.type.d.ts +5 -5
- package/dist/client/services/user/userService.interface.d.ts +17 -17
- package/dist/client/services/userTeamAssociation/userTeamAssociation.action.d.ts +2 -2
- package/dist/client/services/userTeamAssociation/userTeamAssociation.action.js +2 -2
- package/dist/client/services/userTeamAssociation/userTeamAssociation.type.d.ts +5 -5
- package/dist/client/services/userTeamAssociation/userTeamAssociationService.interface.d.ts +10 -10
- package/dist/common/types/statement.type.d.ts +4 -4
- package/package.json +11 -11
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,22 @@
|
|
|
1
1
|
# @guardian/google-admanager-api
|
|
2
2
|
|
|
3
|
+
## 6.1.1
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 60b564f: Allow targetedMobileDevices and excludedMobileDevices to be undefined in mobile device targeting
|
|
8
|
+
- 60b564f: Update browser targeting to only allow strings & update operating system targeting to only allow numbers
|
|
9
|
+
|
|
10
|
+
## 6.1.0
|
|
11
|
+
|
|
12
|
+
### Minor Changes
|
|
13
|
+
|
|
14
|
+
- dced0cc: Add verticalTargeting and contentLabelTargeting properties
|
|
15
|
+
|
|
16
|
+
### Patch Changes
|
|
17
|
+
|
|
18
|
+
- 6db8740: Bump `soap` dependency to 1.6.4
|
|
19
|
+
|
|
3
20
|
## 6.0.3
|
|
4
21
|
|
|
5
22
|
### Patch Changes
|
|
@@ -89,7 +89,7 @@ export declare enum DeliveryForecastSource {
|
|
|
89
89
|
export declare const DeliveryForecastSourceEnum: Describe<DeliveryForecastSource>;
|
|
90
90
|
/**
|
|
91
91
|
* The delivery option for companions.
|
|
92
|
-
* Used for line items whose environmentType is {@link https://developers.google.com/ad-manager/api/reference/
|
|
92
|
+
* Used for line items whose environmentType is {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.EnvironmentType#VIDEO_PLAYER EnvironmentType.VIDEO_PLAYER}.
|
|
93
93
|
*/
|
|
94
94
|
export declare enum CompanionDeliveryOption {
|
|
95
95
|
/**
|
|
@@ -113,7 +113,7 @@ exports.DeliveryForecastSourceEnum = (0, superstruct_1.enums)([
|
|
|
113
113
|
]);
|
|
114
114
|
/**
|
|
115
115
|
* The delivery option for companions.
|
|
116
|
-
* Used for line items whose environmentType is {@link https://developers.google.com/ad-manager/api/reference/
|
|
116
|
+
* Used for line items whose environmentType is {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.EnvironmentType#VIDEO_PLAYER EnvironmentType.VIDEO_PLAYER}.
|
|
117
117
|
*/
|
|
118
118
|
var CompanionDeliveryOption;
|
|
119
119
|
(function (CompanionDeliveryOption) {
|
|
@@ -234,8 +234,8 @@ export declare enum LineItemType {
|
|
|
234
234
|
export declare const LineItemTypeEnum: Describe<LineItemType>;
|
|
235
235
|
/**
|
|
236
236
|
* The formats that a publisher allows on their programmatic
|
|
237
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
238
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
237
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemService.LineItem LineItem} or
|
|
238
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.ProposalLineItem ProposalLineItem}.
|
|
239
239
|
*/
|
|
240
240
|
export declare enum AllowedFormats {
|
|
241
241
|
/**
|
|
@@ -326,7 +326,7 @@ export declare enum ProgrammaticCreativeSource {
|
|
|
326
326
|
*/
|
|
327
327
|
export declare const ProgrammaticCreativeSourceEnum: Describe<ProgrammaticCreativeSource>;
|
|
328
328
|
/**
|
|
329
|
-
* Specifies the type of the goal for a {@link https://developers.google.com/ad-manager/api/reference/
|
|
329
|
+
* Specifies the type of the goal for a {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemService.LineItem LineItem}.
|
|
330
330
|
*/
|
|
331
331
|
export declare enum GoalType {
|
|
332
332
|
/**
|
|
@@ -373,10 +373,10 @@ export declare enum GoalType {
|
|
|
373
373
|
export declare const GoalTypeEnum: Describe<GoalType>;
|
|
374
374
|
/**
|
|
375
375
|
* Indicates the type of unit used for defining a reservation.
|
|
376
|
-
* The {@link https://developers.google.com/ad-manager/api/reference/
|
|
377
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
378
|
-
* Usually {@link https://developers.google.com/ad-manager/api/reference/
|
|
379
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
376
|
+
* The {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemService.CostType CostType} can differ from the
|
|
377
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemService.UnitType UnitType} - an ad can have an impression goal, but be billed by its click.
|
|
378
|
+
* Usually {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemService.CostType CostType} and
|
|
379
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemService.UnitType UnitType} will refer to the same unit.
|
|
380
380
|
*/
|
|
381
381
|
export declare enum UnitType {
|
|
382
382
|
/**
|
|
@@ -274,8 +274,8 @@ exports.LineItemTypeEnum = (0, superstruct_1.enums)([
|
|
|
274
274
|
]);
|
|
275
275
|
/**
|
|
276
276
|
* The formats that a publisher allows on their programmatic
|
|
277
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
278
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
277
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemService.LineItem LineItem} or
|
|
278
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.ProposalLineItem ProposalLineItem}.
|
|
279
279
|
*/
|
|
280
280
|
var AllowedFormats;
|
|
281
281
|
(function (AllowedFormats) {
|
|
@@ -388,7 +388,7 @@ exports.ProgrammaticCreativeSourceEnum = (0, superstruct_1.enums)([
|
|
|
388
388
|
"UNKNOWN",
|
|
389
389
|
]);
|
|
390
390
|
/**
|
|
391
|
-
* Specifies the type of the goal for a {@link https://developers.google.com/ad-manager/api/reference/
|
|
391
|
+
* Specifies the type of the goal for a {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemService.LineItem LineItem}.
|
|
392
392
|
*/
|
|
393
393
|
var GoalType;
|
|
394
394
|
(function (GoalType) {
|
|
@@ -441,10 +441,10 @@ exports.GoalTypeEnum = (0, superstruct_1.enums)([
|
|
|
441
441
|
]);
|
|
442
442
|
/**
|
|
443
443
|
* Indicates the type of unit used for defining a reservation.
|
|
444
|
-
* The {@link https://developers.google.com/ad-manager/api/reference/
|
|
445
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
446
|
-
* Usually {@link https://developers.google.com/ad-manager/api/reference/
|
|
447
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
444
|
+
* The {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemService.CostType CostType} can differ from the
|
|
445
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemService.UnitType UnitType} - an ad can have an impression goal, but be billed by its click.
|
|
446
|
+
* Usually {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemService.CostType CostType} and
|
|
447
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemService.UnitType UnitType} will refer to the same unit.
|
|
448
448
|
*/
|
|
449
449
|
var UnitType;
|
|
450
450
|
(function (UnitType) {
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { type Describe } from "superstruct";
|
|
2
2
|
/**
|
|
3
|
-
* The strategy to use for displaying multiple {@link https://developers.google.com/ad-manager/api/reference/
|
|
4
|
-
* objects that are associated with a {@link https://developers.google.com/ad-manager/api/reference/
|
|
3
|
+
* The strategy to use for displaying multiple {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeService.Creative Creative} \
|
|
4
|
+
* objects that are associated with a {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemService.LineItem LineItem}.
|
|
5
5
|
*/
|
|
6
6
|
export declare enum CreativeRotationType {
|
|
7
7
|
/**
|
|
@@ -47,7 +47,7 @@ export declare enum CustomPacingGoalUnit {
|
|
|
47
47
|
*/
|
|
48
48
|
export declare const CustomPacingGoalUnitEnum: Describe<CustomPacingGoalUnit>;
|
|
49
49
|
/**
|
|
50
|
-
* Describes the {@link https://developers.google.com/ad-manager/api/reference/
|
|
50
|
+
* Describes the {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemService.LineItem LineItem} actions that are billable.
|
|
51
51
|
*/
|
|
52
52
|
export declare enum CostType {
|
|
53
53
|
/**
|
|
@@ -107,7 +107,7 @@ export declare enum CostType {
|
|
|
107
107
|
*/
|
|
108
108
|
export declare const CostTypeEnum: Describe<CostType>;
|
|
109
109
|
/**
|
|
110
|
-
* Describes the possible discount types on the cost of booking a {@link https://developers.google.com/ad-manager/api/reference/
|
|
110
|
+
* Describes the possible discount types on the cost of booking a {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemService.LineItem LineItem}.
|
|
111
111
|
*/
|
|
112
112
|
export declare enum LineItemDiscountType {
|
|
113
113
|
/**
|
|
@@ -3,8 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.ChildContentEligibilityEnum = exports.ChildContentEligibility = exports.CompetitiveConstraintScopeEnum = exports.CompetitiveConstraintScope = exports.LineItemSummaryReservationStatusEnum = exports.LineItemSummaryReservationStatus = exports.LineItemDiscountTypeEnum = exports.LineItemDiscountType = exports.CostTypeEnum = exports.CostType = exports.CustomPacingGoalUnitEnum = exports.CustomPacingGoalUnit = exports.CreativeRotationTypeEnum = exports.CreativeRotationType = void 0;
|
|
4
4
|
const superstruct_1 = require("superstruct");
|
|
5
5
|
/**
|
|
6
|
-
* The strategy to use for displaying multiple {@link https://developers.google.com/ad-manager/api/reference/
|
|
7
|
-
* objects that are associated with a {@link https://developers.google.com/ad-manager/api/reference/
|
|
6
|
+
* The strategy to use for displaying multiple {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeService.Creative Creative} \
|
|
7
|
+
* objects that are associated with a {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemService.LineItem LineItem}.
|
|
8
8
|
*/
|
|
9
9
|
var CreativeRotationType;
|
|
10
10
|
(function (CreativeRotationType) {
|
|
@@ -61,7 +61,7 @@ exports.CustomPacingGoalUnitEnum = (0, superstruct_1.enums)([
|
|
|
61
61
|
"UNKNOWN",
|
|
62
62
|
]);
|
|
63
63
|
/**
|
|
64
|
-
* Describes the {@link https://developers.google.com/ad-manager/api/reference/
|
|
64
|
+
* Describes the {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemService.LineItem LineItem} actions that are billable.
|
|
65
65
|
*/
|
|
66
66
|
var CostType;
|
|
67
67
|
(function (CostType) {
|
|
@@ -130,7 +130,7 @@ exports.CostTypeEnum = (0, superstruct_1.enums)([
|
|
|
130
130
|
"UNKNOWN",
|
|
131
131
|
]);
|
|
132
132
|
/**
|
|
133
|
-
* Describes the possible discount types on the cost of booking a {@link https://developers.google.com/ad-manager/api/reference/
|
|
133
|
+
* Describes the possible discount types on the cost of booking a {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemService.LineItem LineItem}.
|
|
134
134
|
*/
|
|
135
135
|
var LineItemDiscountType;
|
|
136
136
|
(function (LineItemDiscountType) {
|
|
@@ -73,12 +73,12 @@ export type Money = {
|
|
|
73
73
|
*/
|
|
74
74
|
export declare const MoneyStruct: Describe<Money>;
|
|
75
75
|
/**
|
|
76
|
-
* Represents the dimensions of an {@link https://developers.google.com/ad-manager/api/reference/
|
|
77
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
78
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
76
|
+
* Represents the dimensions of an {@link https://developers.google.com/ad-manager/api/reference/latest/InventoryService.AdUnit AdUnit},
|
|
77
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem LineItem} or
|
|
78
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeService.Creative Creative}.
|
|
79
79
|
*
|
|
80
80
|
* For interstitial size (out-of-page), native, ignored and fluid size,
|
|
81
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
81
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/DaiEncodingProfileService.Size Size} must be 1x1.
|
|
82
82
|
*/
|
|
83
83
|
export type Size = {
|
|
84
84
|
/**
|
|
@@ -99,13 +99,13 @@ export type Size = {
|
|
|
99
99
|
*/
|
|
100
100
|
export declare const SizeStruct: Describe<Size>;
|
|
101
101
|
/**
|
|
102
|
-
* The value of a {@link https://developers.google.com/ad-manager/api/reference/
|
|
102
|
+
* The value of a {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomField CustomField} for a particular entity.
|
|
103
103
|
*/
|
|
104
104
|
export type BaseCustomFieldValue = CustomFieldValue | DropDownCustomFieldValue;
|
|
105
105
|
/**
|
|
106
|
-
* The value of a {@link https://developers.google.com/ad-manager/api/reference/
|
|
107
|
-
* that does not have a {@link https://developers.google.com/ad-manager/api/reference/
|
|
108
|
-
* of {@link https://developers.google.com/ad-manager/api/reference/
|
|
106
|
+
* The value of a {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomField CustomField}
|
|
107
|
+
* that does not have a {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomField#dataType CustomField.dataType}
|
|
108
|
+
* of {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomFieldDataType#DROP_DOWN CustomFieldDataType.DROP_DOWN}.
|
|
109
109
|
*/
|
|
110
110
|
type CustomFieldValue = {
|
|
111
111
|
/**
|
|
@@ -117,14 +117,14 @@ type CustomFieldValue = {
|
|
|
117
117
|
};
|
|
118
118
|
/**
|
|
119
119
|
* The value for this field. The appropriate type of **Value** is determined by the
|
|
120
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
120
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomField#dataType CustomField.dataType}
|
|
121
121
|
* of the **CustomField** that this conforms to.
|
|
122
122
|
*
|
|
123
|
-
* | {@link https://developers.google.com/ad-manager/api/reference/
|
|
123
|
+
* | {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomFieldDataType CustomFieldDataType} | {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.Value Value} type |
|
|
124
124
|
* | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
|
125
|
-
* | {@link https://developers.google.com/ad-manager/api/reference/
|
|
126
|
-
* | {@link https://developers.google.com/ad-manager/api/reference/
|
|
127
|
-
* | {@link https://developers.google.com/ad-manager/api/reference/
|
|
125
|
+
* | {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomFieldDataType#STRING STRING} | {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.TextValue TextValue} |
|
|
126
|
+
* | {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomFieldDataType#NUMBER NUMBER} | {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.NumberValue NumberValue} |
|
|
127
|
+
* | {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomFieldDataType#TOGGLE TOGGLE} | {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.BooleanValue BooleanValue} |
|
|
128
128
|
*
|
|
129
129
|
*/
|
|
130
130
|
value: Value;
|
|
@@ -134,10 +134,10 @@ type CustomFieldValue = {
|
|
|
134
134
|
*/
|
|
135
135
|
export declare const CustomFieldValueStruct: Describe<CustomFieldValue>;
|
|
136
136
|
/**
|
|
137
|
-
* A {@link https://developers.google.com/ad-manager/api/reference/
|
|
138
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
139
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
140
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
137
|
+
* A {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.CustomFieldValue CustomFieldValue} for a
|
|
138
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomField CustomField} that has a
|
|
139
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomField#dataType CustomField.dataType} of
|
|
140
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomFieldDataType#DROP_DOWN CustomFieldDataType.DROP_DOWN}
|
|
141
141
|
*/
|
|
142
142
|
type DropDownCustomFieldValue = {
|
|
143
143
|
/**
|
|
@@ -148,8 +148,8 @@ type DropDownCustomFieldValue = {
|
|
|
148
148
|
"xsi:type": "DropDownCustomFieldValue";
|
|
149
149
|
};
|
|
150
150
|
/**
|
|
151
|
-
* The {@link https://developers.google.com/ad-manager/api/reference/
|
|
152
|
-
* of the {@link https://developers.google.com/ad-manager/api/reference/
|
|
151
|
+
* The {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomFieldOption#id ID}
|
|
152
|
+
* of the {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomFieldOption CustomFieldOption} for this value.
|
|
153
153
|
*/
|
|
154
154
|
customFieldOptionId: number;
|
|
155
155
|
};
|
|
@@ -159,7 +159,7 @@ type DropDownCustomFieldValue = {
|
|
|
159
159
|
export declare const DropDownCustomFieldValueStruct: Describe<DropDownCustomFieldValue>;
|
|
160
160
|
/**
|
|
161
161
|
* Represents a limit on the number of times a single viewer can be exposed to the same
|
|
162
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
162
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem LineItem} in a specified time period.
|
|
163
163
|
*/
|
|
164
164
|
export type FrequencyCap = {
|
|
165
165
|
/**
|
|
@@ -180,7 +180,7 @@ export type FrequencyCap = {
|
|
|
180
180
|
*/
|
|
181
181
|
export declare const FrequencyCapStruct: Describe<FrequencyCap>;
|
|
182
182
|
/**
|
|
183
|
-
* Defines the criteria a {@link https://developers.google.com/ad-manager/api/reference/
|
|
183
|
+
* Defines the criteria a {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemService.LineItem LineItem} needs to satisfy to meet its delivery goal.
|
|
184
184
|
*/
|
|
185
185
|
export type Goal = {
|
|
186
186
|
/**
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
import { type Describe } from "superstruct";
|
|
2
2
|
/**
|
|
3
|
-
* Represents a {@link https://developers.google.com/ad-manager/api/reference/
|
|
3
|
+
* Represents a {@link https://developers.google.com/ad-manager/api/reference/latest/LabelService.Label Label} that can be applied to an entity.
|
|
4
4
|
* To negate an inherited label, create an **`AppliedLabel`** with **`labelId`** as the inherited label's ID and **`isNegated`** set to true.
|
|
5
5
|
*/
|
|
6
6
|
export type AppliedLabel = {
|
|
7
7
|
/**
|
|
8
|
-
* The ID of a created {@link https://developers.google.com/ad-manager/api/reference/
|
|
8
|
+
* The ID of a created {@link https://developers.google.com/ad-manager/api/reference/latest/LabelService.Label Label}.
|
|
9
9
|
*/
|
|
10
10
|
labelId: number;
|
|
11
11
|
/**
|
|
@@ -4,7 +4,7 @@ import { type AllowedFormats, type ChildContentEligibility, type CompanionDelive
|
|
|
4
4
|
import { type AppliedLabel, type BaseCustomFieldValue, type CreativePlaceholder, type DeliveryData, type DeliveryIndicator, type FrequencyCap, type Goal, type GrpSettings, type Money, type Stats, type ThirdPartyMeasurementSettings } from ".";
|
|
5
5
|
import { type Describe } from "superstruct";
|
|
6
6
|
/**
|
|
7
|
-
* An interval of a {@link https://developers.google.com/ad-manager/api/reference/
|
|
7
|
+
* An interval of a {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.CustomPacingCurve CustomPacingCurve}.
|
|
8
8
|
* A custom pacing goal contains a start time and an amount.
|
|
9
9
|
* The goal will apply until either the next custom pacing goal's getStartTime or the line item's end time if it is the last goal.
|
|
10
10
|
*/
|
|
@@ -24,10 +24,10 @@ export type CustomPacingGoal = {
|
|
|
24
24
|
*/
|
|
25
25
|
export declare const CustomPacingGoalsStruct: Describe<CustomPacingGoal>;
|
|
26
26
|
/**
|
|
27
|
-
* A LineItemActivityAssociation associates a {@link https://developers.google.com/ad-manager/api/reference/
|
|
28
|
-
* with an {@link https://developers.google.com/ad-manager/api/reference/
|
|
29
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
30
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
27
|
+
* A LineItemActivityAssociation associates a {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemService.LineItem LineItem}
|
|
28
|
+
* with an {@link https://developers.google.com/ad-manager/api/reference/latest/ActivityService.Activity Activity} so that the conversions of the
|
|
29
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ActivityService.Activity Activity} can be counted against the
|
|
30
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemService.LineItem LineItem}.
|
|
31
31
|
*/
|
|
32
32
|
export type LineItemActivityAssociation = {
|
|
33
33
|
/**
|
|
@@ -48,7 +48,7 @@ export type LineItemActivityAssociation = {
|
|
|
48
48
|
*/
|
|
49
49
|
export declare const LineItemActivityAssociationStruct: Describe<LineItemActivityAssociation>;
|
|
50
50
|
/**
|
|
51
|
-
* A curve consisting of {@link https://developers.google.com/ad-manager/api/reference/
|
|
51
|
+
* A curve consisting of {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.CustomPacingGoal CustomPacingGoal} objects that is used to pace line item delivery.
|
|
52
52
|
*/
|
|
53
53
|
export type CustomPacingCurve = {
|
|
54
54
|
/**
|
|
@@ -159,7 +159,7 @@ export type LineItemSummary = {
|
|
|
159
159
|
lineItemType: LineItemType;
|
|
160
160
|
/**
|
|
161
161
|
* The priority for the line item. Valid values range from 1 to 16. This field is optional and defaults to the default priority of the
|
|
162
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
162
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemService.LineItemType LineItemType}.
|
|
163
163
|
*/
|
|
164
164
|
priority: number;
|
|
165
165
|
/**
|
|
@@ -6,7 +6,7 @@ import { type CustomCriteriaSet } from "./customCriteria.type";
|
|
|
6
6
|
import { type VideoPositionTargeting } from "./videoPosition.type";
|
|
7
7
|
import { Size } from "./general.type";
|
|
8
8
|
/**
|
|
9
|
-
* A {@link https://developers.google.com/ad-manager/api/reference/
|
|
9
|
+
* A {@link https://developers.google.com/ad-manager/api/reference/latest/AdjustmentService.Location Location} represents a geographical entity that can be targeted.
|
|
10
10
|
* If a location type is not available because of the API version you are using,
|
|
11
11
|
* the location will be represented as just the base class, otherwise it will be sub-classed correctly.
|
|
12
12
|
*/
|
|
@@ -86,15 +86,15 @@ export declare const AdUnitTargetingStruct: Describe<AdUnitTargeting>;
|
|
|
86
86
|
*/
|
|
87
87
|
export type InventoryTargeting = {
|
|
88
88
|
/**
|
|
89
|
-
* A list of targeted {@link https://developers.google.com/ad-manager/api/reference/
|
|
89
|
+
* A list of targeted {@link https://developers.google.com/ad-manager/api/reference/latest/AdjustmentService.AdUnitTargeting AdUnitTargeting}.
|
|
90
90
|
*/
|
|
91
91
|
targetedAdUnits?: AdUnitTargeting[];
|
|
92
92
|
/**
|
|
93
|
-
* A list of excluded {@link https://developers.google.com/ad-manager/api/reference/
|
|
93
|
+
* A list of excluded {@link https://developers.google.com/ad-manager/api/reference/latest/AdjustmentService.AdUnitTargeting AdUnitTargeting}.
|
|
94
94
|
*/
|
|
95
95
|
excludedAdUnits?: AdUnitTargeting[];
|
|
96
96
|
/**
|
|
97
|
-
* A list of targeted {@link https://developers.google.com/ad-manager/api/reference/
|
|
97
|
+
* A list of targeted {@link https://developers.google.com/ad-manager/api/reference/latest/PlacementService.Placement Placement} ids.
|
|
98
98
|
*/
|
|
99
99
|
targetedPlacementIds?: number[];
|
|
100
100
|
};
|
|
@@ -135,9 +135,9 @@ export type DayPartTargeting = {
|
|
|
135
135
|
dayParts: DayPart[];
|
|
136
136
|
/**
|
|
137
137
|
* Specifies the time zone to be used for delivering
|
|
138
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
138
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem LineItem} objects.
|
|
139
139
|
* This attribute is optional and defaults to
|
|
140
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
140
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/AdjustmentService.DeliveryTimeZone#BROWSER DeliveryTimeZone.BROWSER}.
|
|
141
141
|
*
|
|
142
142
|
* Setting this has no effect if targeting all days and times.
|
|
143
143
|
*/
|
|
@@ -152,7 +152,7 @@ export declare const DayPartTargetingStruct: Describe<DayPartTargeting>;
|
|
|
152
152
|
*/
|
|
153
153
|
export type Technology = {
|
|
154
154
|
attributes: {
|
|
155
|
-
"xsi:type": "
|
|
155
|
+
"xsi:type": "BandwidthGroup" | "Browser" | "BrowserLanguage" | "DeviceCapability" | "DeviceCategory" | "DeviceManufacturer" | "MobileCarrier" | "MobileDevice" | "MobileDeviceSubmodel" | "OperatingSystem" | "OperatingSystemVersion";
|
|
156
156
|
};
|
|
157
157
|
/**
|
|
158
158
|
* The unique ID of the Technology. This value is required for all forms of TechnologyTargeting.
|
|
@@ -166,14 +166,18 @@ export type Technology = {
|
|
|
166
166
|
/**
|
|
167
167
|
* Represents an TechnologyAttributesValues enum in superstruct format.
|
|
168
168
|
*/
|
|
169
|
-
export declare const TechnologyAttributesValuesEnum: import("superstruct").Struct<"
|
|
170
|
-
DeviceCapability: "DeviceCapability";
|
|
169
|
+
export declare const TechnologyAttributesValuesEnum: import("superstruct").Struct<"BandwidthGroup" | "Browser" | "BrowserLanguage" | "DeviceCapability" | "DeviceCategory" | "DeviceManufacturer" | "MobileCarrier" | "MobileDevice" | "MobileDeviceSubmodel" | "OperatingSystem" | "OperatingSystemVersion", {
|
|
171
170
|
BandwidthGroup: "BandwidthGroup";
|
|
171
|
+
Browser: "Browser";
|
|
172
172
|
BrowserLanguage: "BrowserLanguage";
|
|
173
|
+
DeviceCapability: "DeviceCapability";
|
|
173
174
|
DeviceCategory: "DeviceCategory";
|
|
174
175
|
DeviceManufacturer: "DeviceManufacturer";
|
|
175
176
|
MobileCarrier: "MobileCarrier";
|
|
177
|
+
MobileDevice: "MobileDevice";
|
|
178
|
+
MobileDeviceSubmodel: "MobileDeviceSubmodel";
|
|
176
179
|
OperatingSystem: "OperatingSystem";
|
|
180
|
+
OperatingSystemVersion: "OperatingSystemVersion";
|
|
177
181
|
}>;
|
|
178
182
|
/**
|
|
179
183
|
* Represents a Technology struct.
|
|
@@ -186,7 +190,7 @@ export type BandwidthGroupTargeting = {
|
|
|
186
190
|
/**
|
|
187
191
|
* Indicates whether bandwidth groups should be targeted or excluded. This attribute is optional and defaults to true.
|
|
188
192
|
*/
|
|
189
|
-
isTargeted
|
|
193
|
+
isTargeted?: boolean;
|
|
190
194
|
/**
|
|
191
195
|
* The bandwidth groups that are being targeted or excluded by the LineItem.
|
|
192
196
|
*/
|
|
@@ -196,8 +200,6 @@ export type BandwidthGroupTargeting = {
|
|
|
196
200
|
* Represents a BandwidthGroupTargeting struct.
|
|
197
201
|
*/
|
|
198
202
|
export declare const BandwidthGroupTargetingStruct: Describe<BandwidthGroupTargeting>;
|
|
199
|
-
export type Version = string | number;
|
|
200
|
-
export declare const VersionStruct: Describe<Version>;
|
|
201
203
|
/**
|
|
202
204
|
* Represents an internet browser. The id and name are suppose to be inherited from the Technology type.
|
|
203
205
|
*/
|
|
@@ -207,8 +209,8 @@ export type Browser = {
|
|
|
207
209
|
};
|
|
208
210
|
id: number;
|
|
209
211
|
name: string;
|
|
210
|
-
majorVersion:
|
|
211
|
-
minorVersion:
|
|
212
|
+
majorVersion: string;
|
|
213
|
+
minorVersion: string;
|
|
212
214
|
};
|
|
213
215
|
/**
|
|
214
216
|
* Represents a Browser struct.
|
|
@@ -221,11 +223,11 @@ export type BrowserTargeting = {
|
|
|
221
223
|
/**
|
|
222
224
|
* Indicates whether browsers should be targeted or excluded. This attribute is optional and defaults to true.
|
|
223
225
|
*/
|
|
224
|
-
isTargeted
|
|
226
|
+
isTargeted?: boolean;
|
|
225
227
|
/**
|
|
226
228
|
* Browsers that are being targeted or excluded by the LineItem.
|
|
227
229
|
*/
|
|
228
|
-
browsers:
|
|
230
|
+
browsers: Technology[];
|
|
229
231
|
};
|
|
230
232
|
/**
|
|
231
233
|
* Represents a BrowserTargeting struct.
|
|
@@ -238,7 +240,7 @@ export type BrowserLanguageTargeting = {
|
|
|
238
240
|
/**
|
|
239
241
|
* Indicates whether browsers languages should be targeted or excluded. This attribute is optional and defaults to true.
|
|
240
242
|
*/
|
|
241
|
-
isTargeted
|
|
243
|
+
isTargeted?: boolean;
|
|
242
244
|
/**
|
|
243
245
|
* Browser languages that are being targeted or excluded by the LineItem.
|
|
244
246
|
*/
|
|
@@ -289,7 +291,7 @@ export type DeviceManufacturerTargeting = {
|
|
|
289
291
|
/**
|
|
290
292
|
* Indicates whether device manufacturers should be targeted or excluded. This attribute is optional and defaults to true.
|
|
291
293
|
*/
|
|
292
|
-
isTargeted
|
|
294
|
+
isTargeted?: boolean;
|
|
293
295
|
/**
|
|
294
296
|
* Device manufacturers that are being targeted or excluded by the LineItem.
|
|
295
297
|
*/
|
|
@@ -306,7 +308,7 @@ export type MobileCarrierTargeting = {
|
|
|
306
308
|
/**
|
|
307
309
|
* Indicates whether mobile carriers should be targeted or excluded. This attribute is optional and defaults to true.
|
|
308
310
|
*/
|
|
309
|
-
isTargeted
|
|
311
|
+
isTargeted?: boolean;
|
|
310
312
|
/**
|
|
311
313
|
* Mobile carriers that are being targeted or excluded by the LineItem.
|
|
312
314
|
*/
|
|
@@ -338,11 +340,11 @@ export type MobileDeviceTargeting = {
|
|
|
338
340
|
/**
|
|
339
341
|
* Mobile devices that are being targeted by the LineItem.
|
|
340
342
|
*/
|
|
341
|
-
targetedMobileDevices
|
|
343
|
+
targetedMobileDevices?: MobileDevice[];
|
|
342
344
|
/**
|
|
343
345
|
* Mobile devices that are being excluded by the LineItem.
|
|
344
346
|
*/
|
|
345
|
-
excludedMobileDevices
|
|
347
|
+
excludedMobileDevices?: MobileDevice[];
|
|
346
348
|
};
|
|
347
349
|
/**
|
|
348
350
|
* Represents a MobileDeviceTargeting struct.
|
|
@@ -388,7 +390,7 @@ export type OperatingSystemTargeting = {
|
|
|
388
390
|
/**
|
|
389
391
|
* Indicates whether operating systems should be targeted or excluded. This attribute is optional and defaults to true.
|
|
390
392
|
*/
|
|
391
|
-
isTargeted
|
|
393
|
+
isTargeted?: boolean;
|
|
392
394
|
/**
|
|
393
395
|
* Operating systems that are being targeted or excluded by the LineItem.
|
|
394
396
|
*/
|
|
@@ -407,9 +409,9 @@ export type OperatingSystemVersion = {
|
|
|
407
409
|
};
|
|
408
410
|
id: number;
|
|
409
411
|
name: string;
|
|
410
|
-
majorVersion:
|
|
411
|
-
minorVersion:
|
|
412
|
-
microVersion:
|
|
412
|
+
majorVersion: number;
|
|
413
|
+
minorVersion: number;
|
|
414
|
+
microVersion: number;
|
|
413
415
|
};
|
|
414
416
|
/**
|
|
415
417
|
* Represents an OperatingSystemVersion struct.
|
|
@@ -506,7 +508,7 @@ export type UserDomainTargeting = {
|
|
|
506
508
|
/**
|
|
507
509
|
* Indicates whether domains should be targeted or excluded. This attribute is optional and defaults to true.
|
|
508
510
|
*/
|
|
509
|
-
targeted
|
|
511
|
+
targeted?: boolean;
|
|
510
512
|
};
|
|
511
513
|
/**
|
|
512
514
|
* Represents a UserDomainTargeting struct.
|
|
@@ -548,7 +550,7 @@ export type MobileApplicationTargeting = {
|
|
|
548
550
|
/**
|
|
549
551
|
* Indicates whether mobile apps should be targeted or excluded. This attribute is optional and defaults to true.
|
|
550
552
|
*/
|
|
551
|
-
isTargeted
|
|
553
|
+
isTargeted?: boolean;
|
|
552
554
|
};
|
|
553
555
|
/**
|
|
554
556
|
* Represents a MobileApplicationTargeting struct.
|
|
@@ -585,25 +587,30 @@ export type InventoryUrlTargeting = {
|
|
|
585
587
|
excludedUrls: InventoryUrl[];
|
|
586
588
|
};
|
|
587
589
|
/**
|
|
588
|
-
*
|
|
590
|
+
* Represents an InventoryUrlTargeting struct.
|
|
589
591
|
*/
|
|
590
|
-
export
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
*/
|
|
598
|
-
targetedSizes: TargetedSize[];
|
|
592
|
+
export declare const InventoryUrlTargetingStruct: Describe<InventoryUrlTargeting>;
|
|
593
|
+
/**
|
|
594
|
+
* Vertical targeting information. The IDs listed here correspond to the IDs in the AD_CATEGORY table of type VERTICAL.
|
|
595
|
+
*/
|
|
596
|
+
export type VerticalTargeting = {
|
|
597
|
+
targetedVerticalIds: number[];
|
|
598
|
+
excludedVerticalIds: number[];
|
|
599
599
|
};
|
|
600
|
-
|
|
601
|
-
|
|
600
|
+
/**
|
|
601
|
+
* Represents a VerticalTargeting struct.
|
|
602
|
+
*/
|
|
603
|
+
export declare const VerticalTargetingStruct: Describe<VerticalTargeting>;
|
|
604
|
+
/**
|
|
605
|
+
* Content label targeting information.
|
|
606
|
+
*/
|
|
607
|
+
export type ContentLabelTargeting = {
|
|
608
|
+
excludedContentLabelIds: number[];
|
|
602
609
|
};
|
|
603
610
|
/**
|
|
604
|
-
* Represents
|
|
611
|
+
* Represents a ContentLabelTargeting struct.
|
|
605
612
|
*/
|
|
606
|
-
export declare const
|
|
613
|
+
export declare const ContentLabelTargetingStruct: Describe<ContentLabelTargeting>;
|
|
607
614
|
/**
|
|
608
615
|
* Provides line items the ability to target the platform that requests and renders the ad.
|
|
609
616
|
*
|
|
@@ -622,6 +629,26 @@ export type RequestPlatformTargeting = {
|
|
|
622
629
|
* Represents a RequestPlatformTargeting struct.
|
|
623
630
|
*/
|
|
624
631
|
export declare const RequestPlatformTargetingStruct: Describe<RequestPlatformTargeting>;
|
|
632
|
+
/**
|
|
633
|
+
* A collection of targeted inventory urls.
|
|
634
|
+
*/
|
|
635
|
+
export type InventorySizeTargeting = {
|
|
636
|
+
/**
|
|
637
|
+
* Whether the inventory sizes should be targeted or excluded.
|
|
638
|
+
*/
|
|
639
|
+
isTargeted: boolean;
|
|
640
|
+
/**
|
|
641
|
+
* A list of TargetedSizeDtos.
|
|
642
|
+
*/
|
|
643
|
+
targetedSizes: TargetedSize[];
|
|
644
|
+
};
|
|
645
|
+
/**
|
|
646
|
+
* Represents an InventorySizeTargeting struct.
|
|
647
|
+
*/
|
|
648
|
+
export declare const InventorySizeTargetingStruct: Describe<InventorySizeTargeting>;
|
|
649
|
+
export type TargetedSize = {
|
|
650
|
+
size: Size;
|
|
651
|
+
};
|
|
625
652
|
/**
|
|
626
653
|
* Contains targeting criteria for LineItem objects. See LineItem.targeting.
|
|
627
654
|
*/
|
|
@@ -682,9 +709,17 @@ export type Targeting = {
|
|
|
682
709
|
buyerUserListTargeting?: BuyerUserListTargeting;
|
|
683
710
|
/**
|
|
684
711
|
* Specifies the URLs that are targeted by the entity.
|
|
685
|
-
* This is currently only supported by {@link https://developers.google.com/ad-manager/api/reference/
|
|
712
|
+
* This is currently only supported by {@link https://developers.google.com/ad-manager/api/reference/latest/YieldGroupService.YieldGroup YieldGroup}.
|
|
686
713
|
*/
|
|
687
714
|
inventoryUrlTargeting?: InventoryUrlTargeting;
|
|
715
|
+
/**
|
|
716
|
+
* Specifies the verticals that are targeted by the entity. The IDs listed here correspond to the IDs in the AD_CATEGORY table of type VERTICAL.
|
|
717
|
+
*/
|
|
718
|
+
verticalTargeting?: VerticalTargeting;
|
|
719
|
+
/**
|
|
720
|
+
* Specifies the content labels that are excluded by the entity. The IDs listed here correspond to the IDs in the CONTENT_LABEL table.
|
|
721
|
+
*/
|
|
722
|
+
contentLabelTargeting?: ContentLabelTargeting;
|
|
688
723
|
/**
|
|
689
724
|
* Specifies the request platforms that are targeted by the LineItem. This attribute is required for video line items.
|
|
690
725
|
*
|