@guardian/google-admanager-api 6.1.0 → 6.1.2
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 +13 -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 +16 -18
- package/dist/client/common/types/targeting.type.d.ts.map +1 -1
- package/dist/client/common/types/targeting.type.js +10 -11
- 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 +1 -1
|
@@ -2,7 +2,7 @@ import type { DateTime, PageResult } from "../../../common/types";
|
|
|
2
2
|
import type { AppliedLabel, BaseCustomFieldValue, Money } from "../../common/types";
|
|
3
3
|
import type { OrderStatus } from "./order.enum";
|
|
4
4
|
/**
|
|
5
|
-
* An **`Order`** represents a grouping of individual {@link https://developers.google.com/ad-manager/api/reference/
|
|
5
|
+
* An **`Order`** represents a grouping of individual {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem LineItem}
|
|
6
6
|
* objects, each of which fulfill an ad request from a particular advertiser.
|
|
7
7
|
*/
|
|
8
8
|
export type Order = {
|
|
@@ -17,19 +17,19 @@ export type Order = {
|
|
|
17
17
|
/**
|
|
18
18
|
* The date and time at which the **Order** and its associated line items are eligible to begin serving.
|
|
19
19
|
* This attribute is readonly and is derived from the line item of the order which has the earliest
|
|
20
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
20
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem#startDateTime LineItem.startDateTime}.
|
|
21
21
|
*/
|
|
22
22
|
startDateTime: DateTime;
|
|
23
23
|
/**
|
|
24
24
|
* The date and time at which the **Order** and its associated line items stop being served.
|
|
25
25
|
* This attribute is readonly and is derived from the line item of the order which has the latest
|
|
26
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
26
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem#endDateTime LineItem.endDateTime}.
|
|
27
27
|
*/
|
|
28
28
|
endDateTime: DateTime;
|
|
29
29
|
/**
|
|
30
30
|
* Specifies whether or not the **Order** has an unlimited end date.
|
|
31
31
|
* This attribute is readonly and is true if any of the order's line items has
|
|
32
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
32
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem#unlimitedEndDateTime LineItem.unlimitedEndDateTime} set to true.
|
|
33
33
|
*/
|
|
34
34
|
unlimitedEndDateTime: boolean;
|
|
35
35
|
/**
|
|
@@ -57,8 +57,8 @@ export type Order = {
|
|
|
57
57
|
*/
|
|
58
58
|
currencyCode: string;
|
|
59
59
|
/**
|
|
60
|
-
* The unique ID of the {@link https://developers.google.com/ad-manager/api/reference/
|
|
61
|
-
* which is of type {@link https://developers.google.com/ad-manager/api/reference/
|
|
60
|
+
* The unique ID of the {@link https://developers.google.com/ad-manager/api/reference/latest/CompanyService.Company Company},
|
|
61
|
+
* which is of type {@link https://developers.google.com/ad-manager/api/reference/latest/CompanyService.Company.Type#ADVERTISER Company.Type.ADVERTISER},
|
|
62
62
|
* to which this order belongs. This attribute is required.
|
|
63
63
|
*/
|
|
64
64
|
advertiserId: number;
|
|
@@ -67,8 +67,8 @@ export type Order = {
|
|
|
67
67
|
*/
|
|
68
68
|
advertiserContactIds: number[];
|
|
69
69
|
/**
|
|
70
|
-
* The unique ID of the {@link https://developers.google.com/ad-manager/api/reference/
|
|
71
|
-
* which is of type {@link https://developers.google.com/ad-manager/api/reference/
|
|
70
|
+
* The unique ID of the {@link https://developers.google.com/ad-manager/api/reference/latest/CompanyService.Company Company},
|
|
71
|
+
* which is of type {@link https://developers.google.com/ad-manager/api/reference/latest/CompanyService.Company.Type#AGENCY Company.Type.AGENCY},
|
|
72
72
|
* with which this order is associated. This attribute is optional.
|
|
73
73
|
*/
|
|
74
74
|
agencyId: number;
|
|
@@ -77,11 +77,11 @@ export type Order = {
|
|
|
77
77
|
*/
|
|
78
78
|
agencyContactIds: number[];
|
|
79
79
|
/**
|
|
80
|
-
* The unique ID of the {@link https://developers.google.com/ad-manager/api/reference/
|
|
80
|
+
* The unique ID of the {@link https://developers.google.com/ad-manager/api/reference/latest/UserService.User User} who created the **Order** on behalf of the advertiser. This value is readonly and is assigned by Google.
|
|
81
81
|
*/
|
|
82
82
|
creatorId: number;
|
|
83
83
|
/**
|
|
84
|
-
* The unique ID of the {@link https://developers.google.com/ad-manager/api/reference/
|
|
84
|
+
* The unique ID of the {@link https://developers.google.com/ad-manager/api/reference/latest/UserService.User User} responsible for trafficking the **Order**. This value is required for creating an order.
|
|
85
85
|
*/
|
|
86
86
|
traffickerId: number;
|
|
87
87
|
/**
|
|
@@ -89,7 +89,7 @@ export type Order = {
|
|
|
89
89
|
*/
|
|
90
90
|
secondaryTraffickerIds: number[];
|
|
91
91
|
/**
|
|
92
|
-
* The unique ID of the {@link https://developers.google.com/ad-manager/api/reference/
|
|
92
|
+
* The unique ID of the {@link https://developers.google.com/ad-manager/api/reference/latest/UserService.User User} responsible for the sales of the **Order**. This value is optional.
|
|
93
93
|
*/
|
|
94
94
|
salespersonId: number;
|
|
95
95
|
/**
|
|
@@ -113,7 +113,7 @@ export type Order = {
|
|
|
113
113
|
/**
|
|
114
114
|
* Total budget for all line items of this **Order**.
|
|
115
115
|
* This value is a readonly field assigned by Google and is calculated from the associated
|
|
116
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
116
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem#costPerUnit LineItem.costPerUnit} values.
|
|
117
117
|
*/
|
|
118
118
|
totalBudget: Money;
|
|
119
119
|
/**
|
|
@@ -147,7 +147,7 @@ export type Order = {
|
|
|
147
147
|
customFieldValues: BaseCustomFieldValue[];
|
|
148
148
|
};
|
|
149
149
|
/**
|
|
150
|
-
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/
|
|
150
|
+
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.Order Order} objects.
|
|
151
151
|
*/
|
|
152
152
|
export type OrderPage = PageResult<Order>;
|
|
153
153
|
//# sourceMappingURL=order.type.d.ts.map
|
|
@@ -2,45 +2,45 @@ import type { Statement, UpdateResult } from "../../../common/types";
|
|
|
2
2
|
import type { OrderAction } from "./order.action";
|
|
3
3
|
import type { Order, OrderPage } from "./order.type";
|
|
4
4
|
/**
|
|
5
|
-
* Provides methods for creating, updating and retrieving {@link https://developers.google.com/ad-manager/api/reference/
|
|
5
|
+
* Provides methods for creating, updating and retrieving {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.Order Order} objects.
|
|
6
6
|
*
|
|
7
|
-
* An order is a grouping of {@link https://developers.google.com/ad-manager/api/reference/
|
|
7
|
+
* An order is a grouping of {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem LineItem} objects.
|
|
8
8
|
* Line items have a many-to-one relationship with orders, meaning each line item can belong to only one order, but orders can have multiple line items.
|
|
9
9
|
* An order can be used to manage the line items it contains.
|
|
10
10
|
*/
|
|
11
11
|
export interface OrderServiceOperations {
|
|
12
12
|
/**
|
|
13
|
-
* Creates new {@link https://developers.google.com/ad-manager/api/reference/
|
|
13
|
+
* Creates new {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.Order Order} objects.
|
|
14
14
|
*
|
|
15
15
|
* @param orders the orders to create
|
|
16
16
|
* @returns the created orders with their IDs filled in
|
|
17
17
|
*/
|
|
18
18
|
createOrders(orders: Partial<Order>[]): Promise<Order[]>;
|
|
19
19
|
/**
|
|
20
|
-
* Gets an {@link https://developers.google.com/ad-manager/api/reference/
|
|
21
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
22
|
-
* objects that satisfy the given {@link https://developers.google.com/ad-manager/api/reference/
|
|
20
|
+
* Gets an {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.OrderPage OrderPage} of
|
|
21
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.Order Order}
|
|
22
|
+
* objects that satisfy the given {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.Statement#queryStatement.query}.
|
|
23
23
|
* The following fields are supported for filtering:
|
|
24
24
|
*
|
|
25
25
|
* | PQL Property | PQL Property |
|
|
26
26
|
* | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------- |
|
|
27
|
-
* | advertiserId | {@link https://developers.google.com/ad-manager/api/reference/
|
|
28
|
-
* | endDateTime | {@link https://developers.google.com/ad-manager/api/reference/
|
|
29
|
-
* | id | {@link https://developers.google.com/ad-manager/api/reference/
|
|
30
|
-
* | name | {@link https://developers.google.com/ad-manager/api/reference/
|
|
31
|
-
* | salespersonId | {@link https://developers.google.com/ad-manager/api/reference/
|
|
32
|
-
* | startDateTime | {@link https://developers.google.com/ad-manager/api/reference/
|
|
33
|
-
* | status | {@link https://developers.google.com/ad-manager/api/reference/
|
|
34
|
-
* | traffickerId | {@link https://developers.google.com/ad-manager/api/reference/
|
|
35
|
-
* | lastModifiedDateTime | {@link https://developers.google.com/ad-manager/api/reference/
|
|
27
|
+
* | advertiserId | {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.Order#advertiserId Order.advertiserId} |
|
|
28
|
+
* | endDateTime | {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.Order#endDateTime Order.endDateTime} |
|
|
29
|
+
* | id | {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.Order#id Order.id} |
|
|
30
|
+
* | name | {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.Order#name Order.name} |
|
|
31
|
+
* | salespersonId | {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.Order#salespersonId Order.salespersonId} |
|
|
32
|
+
* | startDateTime | {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.Order#startDateTime Order.startDateTime} |
|
|
33
|
+
* | status | {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.Order#status Order.status} |
|
|
34
|
+
* | traffickerId | {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.Order#traffickerId Order.traffickerId} |
|
|
35
|
+
* | lastModifiedDateTime | {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.Order#lastModifiedDateTime Order.lastModifiedDateTime} |
|
|
36
36
|
*
|
|
37
37
|
* @param filterStatement a Publisher Query Language statement used to filter a set of orders
|
|
38
38
|
* @returns the orders that match the given filter
|
|
39
39
|
*/
|
|
40
40
|
getOrdersByStatement(filterStatement: Statement): Promise<OrderPage>;
|
|
41
41
|
/**
|
|
42
|
-
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/
|
|
43
|
-
* objects that match the given {@link https://developers.google.com/ad-manager/api/reference/
|
|
42
|
+
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.Order Order}
|
|
43
|
+
* objects that match the given {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.Statement#query Statement.query}.
|
|
44
44
|
*
|
|
45
45
|
* @param orderAction the action to perform
|
|
46
46
|
* @param filterStatement a Publisher Query Language statement used to filter a set of orders
|
|
@@ -48,7 +48,7 @@ export interface OrderServiceOperations {
|
|
|
48
48
|
*/
|
|
49
49
|
performOrderAction(orderAction: OrderAction, filterStatement: Statement): Promise<UpdateResult>;
|
|
50
50
|
/**
|
|
51
|
-
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/
|
|
51
|
+
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.Order Order} objects.
|
|
52
52
|
* @param orders the orders to update
|
|
53
53
|
* @returns the updated orders
|
|
54
54
|
*/
|
|
@@ -1,20 +1,20 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Represents the actions that can be performed on {@link https://developers.google.com/ad-manager/api/reference/
|
|
2
|
+
* Represents the actions that can be performed on {@link https://developers.google.com/ad-manager/api/reference/latest/PlacementService.Placement Placement} objects.
|
|
3
3
|
*/
|
|
4
4
|
export declare abstract class PlacementAction {
|
|
5
5
|
}
|
|
6
6
|
/**
|
|
7
|
-
* The action used for activating {@link https://developers.google.com/ad-manager/api/reference/
|
|
7
|
+
* The action used for activating {@link https://developers.google.com/ad-manager/api/reference/latest/PlacementService.Placement Placement} objects.
|
|
8
8
|
*/
|
|
9
9
|
export declare class ActivatePlacements implements PlacementAction {
|
|
10
10
|
}
|
|
11
11
|
/**
|
|
12
|
-
* The action used for archiving {@link https://developers.google.com/ad-manager/api/reference/
|
|
12
|
+
* The action used for archiving {@link https://developers.google.com/ad-manager/api/reference/latest/PlacementService.Placement Placement} objects.
|
|
13
13
|
*/
|
|
14
14
|
export declare class ArchivePlacements implements PlacementAction {
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
|
-
* The action used for deactivating {@link https://developers.google.com/ad-manager/api/reference/
|
|
17
|
+
* The action used for deactivating {@link https://developers.google.com/ad-manager/api/reference/latest/PlacementService.Placement Placement} objects.
|
|
18
18
|
*/
|
|
19
19
|
export declare class DeactivatePlacements implements PlacementAction {
|
|
20
20
|
}
|
|
@@ -2,25 +2,25 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.DeactivatePlacements = exports.ArchivePlacements = exports.ActivatePlacements = exports.PlacementAction = void 0;
|
|
4
4
|
/**
|
|
5
|
-
* Represents the actions that can be performed on {@link https://developers.google.com/ad-manager/api/reference/
|
|
5
|
+
* Represents the actions that can be performed on {@link https://developers.google.com/ad-manager/api/reference/latest/PlacementService.Placement Placement} objects.
|
|
6
6
|
*/
|
|
7
7
|
class PlacementAction {
|
|
8
8
|
}
|
|
9
9
|
exports.PlacementAction = PlacementAction;
|
|
10
10
|
/**
|
|
11
|
-
* The action used for activating {@link https://developers.google.com/ad-manager/api/reference/
|
|
11
|
+
* The action used for activating {@link https://developers.google.com/ad-manager/api/reference/latest/PlacementService.Placement Placement} objects.
|
|
12
12
|
*/
|
|
13
13
|
class ActivatePlacements {
|
|
14
14
|
}
|
|
15
15
|
exports.ActivatePlacements = ActivatePlacements;
|
|
16
16
|
/**
|
|
17
|
-
* The action used for archiving {@link https://developers.google.com/ad-manager/api/reference/
|
|
17
|
+
* The action used for archiving {@link https://developers.google.com/ad-manager/api/reference/latest/PlacementService.Placement Placement} objects.
|
|
18
18
|
*/
|
|
19
19
|
class ArchivePlacements {
|
|
20
20
|
}
|
|
21
21
|
exports.ArchivePlacements = ArchivePlacements;
|
|
22
22
|
/**
|
|
23
|
-
* The action used for deactivating {@link https://developers.google.com/ad-manager/api/reference/
|
|
23
|
+
* The action used for deactivating {@link https://developers.google.com/ad-manager/api/reference/latest/PlacementService.Placement Placement} objects.
|
|
24
24
|
*/
|
|
25
25
|
class DeactivatePlacements {
|
|
26
26
|
}
|
|
@@ -38,7 +38,7 @@ export type Placement = SiteTargetingInfo & {
|
|
|
38
38
|
lastModifiedDateTime: DateTime;
|
|
39
39
|
};
|
|
40
40
|
/**
|
|
41
|
-
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/
|
|
41
|
+
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/latest/PlacementService.Placement Placement} objects.
|
|
42
42
|
*/
|
|
43
43
|
export type PlacementPage = PageResult<Placement>;
|
|
44
44
|
export {};
|
|
@@ -2,40 +2,40 @@ import type { Statement, UpdateResult } from "../../../common/types";
|
|
|
2
2
|
import type { PlacementAction } from "./placement.action";
|
|
3
3
|
import type { Placement, PlacementPage } from "./placement.type";
|
|
4
4
|
/**
|
|
5
|
-
* Provides operations for creating, updating and retrieving {@link https://developers.google.com/ad-manager/api/reference/
|
|
5
|
+
* Provides operations for creating, updating and retrieving {@link https://developers.google.com/ad-manager/api/reference/latest/PlacementService.Placement Placement} objects.
|
|
6
6
|
*
|
|
7
7
|
* You can use a placement to group ad units. For example, you might have a placement that focuses on sports sites, which may be spread across different branches of your inventory.
|
|
8
8
|
* You might also have a "fire sale" placement that includes ad units that have not been selling and are consequently priced very attractively.
|
|
9
9
|
*/
|
|
10
10
|
export interface PlacementServiceOperations {
|
|
11
11
|
/**
|
|
12
|
-
* Creates new {@link https://developers.google.com/ad-manager/api/reference/
|
|
12
|
+
* Creates new {@link https://developers.google.com/ad-manager/api/reference/latest/PlacementService.Placement Placement} objects.
|
|
13
13
|
*
|
|
14
14
|
* @param placements the placements to create
|
|
15
15
|
* @returns the created placements with their IDs filled in
|
|
16
16
|
*/
|
|
17
17
|
createPlacements(placements: Partial<Placement>[]): Promise<Placement[]>;
|
|
18
18
|
/**
|
|
19
|
-
* Gets a {@link https://developers.google.com/ad-manager/api/reference/
|
|
20
|
-
* of {@link https://developers.google.com/ad-manager/api/reference/
|
|
21
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
19
|
+
* Gets a {@link https://developers.google.com/ad-manager/api/reference/latest/PlacementService.PlacementPage PlacementPage}
|
|
20
|
+
* of {@link https://developers.google.com/ad-manager/api/reference/latest/PlacementService.Placement Placement} objects that satisfy the given
|
|
21
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/PlacementService.Statement#query Statement.query}.
|
|
22
22
|
* The following fields are supported for filtering:
|
|
23
23
|
*
|
|
24
24
|
* | PQL Property | PQL Property |
|
|
25
25
|
* | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
26
|
-
* | description | {@link https://developers.google.com/ad-manager/api/reference/
|
|
27
|
-
* | id | {@link https://developers.google.com/ad-manager/api/reference/
|
|
28
|
-
* | name | {@link https://developers.google.com/ad-manager/api/reference/
|
|
29
|
-
* | placementCode | {@link https://developers.google.com/ad-manager/api/reference/
|
|
30
|
-
* | status | {@link https://developers.google.com/ad-manager/api/reference/
|
|
31
|
-
* | lastModifiedDateTime | {@link https://developers.google.com/ad-manager/api/reference/
|
|
26
|
+
* | description | {@link https://developers.google.com/ad-manager/api/reference/latest/PlacementService.Placement#description Placement.description} |
|
|
27
|
+
* | id | {@link https://developers.google.com/ad-manager/api/reference/latest/PlacementService.Placement#id Placement.id} |
|
|
28
|
+
* | name | {@link https://developers.google.com/ad-manager/api/reference/latest/PlacementService.Placement#name Placement.name} |
|
|
29
|
+
* | placementCode | {@link https://developers.google.com/ad-manager/api/reference/latest/PlacementService.Placement#placementCode Placement.placementCode} |
|
|
30
|
+
* | status | {@link https://developers.google.com/ad-manager/api/reference/latest/PlacementService.Placement#status Placement.status} |
|
|
31
|
+
* | lastModifiedDateTime | {@link https://developers.google.com/ad-manager/api/reference/latest/PlacementService.Placement#lastModifiedDateTime Placement.lastModifiedDateTime} |
|
|
32
32
|
*
|
|
33
33
|
* @param filterStatement a Publisher Query Language statement used to filter a set of placements
|
|
34
34
|
* @returns the placements that match the given filter
|
|
35
35
|
*/
|
|
36
36
|
getPlacementsByStatement(filterStatement: Statement): Promise<PlacementPage>;
|
|
37
37
|
/**
|
|
38
|
-
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/
|
|
38
|
+
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/latest/PlacementService.Placement Placement} objects that match the given Statement.
|
|
39
39
|
*
|
|
40
40
|
* @param PlacementAction the action to perform
|
|
41
41
|
* @param filterStatement a PQL statement used to filter placements
|
|
@@ -43,7 +43,7 @@ export interface PlacementServiceOperations {
|
|
|
43
43
|
*/
|
|
44
44
|
performPlacementAction(placementAction: PlacementAction, filterStatement: Statement): Promise<UpdateResult>;
|
|
45
45
|
/**
|
|
46
|
-
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/
|
|
46
|
+
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/latest/PlacementService.Placement Placement} objects.
|
|
47
47
|
*
|
|
48
48
|
* @param placements the placements to update
|
|
49
49
|
* @returns the updated placements
|
|
@@ -1,26 +1,26 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Represents the actions that can be performed on {@link https://developers.google.com/ad-manager/api/reference/
|
|
2
|
+
* Represents the actions that can be performed on {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal Proposal} objects.
|
|
3
3
|
*/
|
|
4
4
|
export declare abstract class ProposalAction {
|
|
5
5
|
buildAttributes(): object;
|
|
6
6
|
}
|
|
7
7
|
/**
|
|
8
|
-
* The action used for archiving {@link https://developers.google.com/ad-manager/api/reference/
|
|
8
|
+
* The action used for archiving {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal Proposal} objects.
|
|
9
9
|
*/
|
|
10
10
|
export declare class ArchiveProposals implements ProposalAction {
|
|
11
11
|
buildAttributes(): object;
|
|
12
12
|
}
|
|
13
13
|
/**
|
|
14
|
-
* The action reverting the local {@link https://developers.google.com/ad-manager/api/reference/
|
|
14
|
+
* The action reverting the local {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal Proposal} modifications to reflect the latest terms and private data in Marketplace.
|
|
15
15
|
*/
|
|
16
16
|
export declare class DiscardLocalVersionEdits implements ProposalAction {
|
|
17
17
|
buildAttributes(): object;
|
|
18
18
|
}
|
|
19
19
|
/**
|
|
20
|
-
* Opens the fields of a {@link https://developers.google.com/ad-manager/api/reference/
|
|
20
|
+
* Opens the fields of a {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal Proposal} for edit.
|
|
21
21
|
* This proposal will not receive updates from Marketplace while it's open for edit.
|
|
22
22
|
* If the buyer updates the proposal while it is open for local editing,
|
|
23
|
-
* Google will set {@link https://developers.google.com/ad-manager/api/reference/
|
|
23
|
+
* Google will set {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.ProposalMarketplaceInfo#isNewVersionFromBuyer ProposalMarketplaceInfo.isNewVersionFromBuyer} to true.
|
|
24
24
|
* You will then need to call DiscardProposalDrafts to revert your edits to get the buyer's latest changes,
|
|
25
25
|
* and then perform this action to start making your edits again.
|
|
26
26
|
*/
|
|
@@ -28,7 +28,7 @@ export declare class EditProposalsForNegotiation implements ProposalAction {
|
|
|
28
28
|
buildAttributes(): object;
|
|
29
29
|
}
|
|
30
30
|
/**
|
|
31
|
-
* The action used for pausing programmatic {@link https://developers.google.com/ad-manager/api/reference/
|
|
31
|
+
* The action used for pausing programmatic {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal Proposal} objects.
|
|
32
32
|
*/
|
|
33
33
|
export declare class PauseProposals implements ProposalAction {
|
|
34
34
|
private reasonField?;
|
|
@@ -38,9 +38,9 @@ export declare class PauseProposals implements ProposalAction {
|
|
|
38
38
|
}
|
|
39
39
|
/**
|
|
40
40
|
* The action used to request acceptance from the buyer for the
|
|
41
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
41
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal Proposal} through Marketplace.
|
|
42
42
|
* This action does check forecasting unless
|
|
43
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
43
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.RequestBuyerAcceptance#allowOverbook allowOverbook} is set to true.
|
|
44
44
|
*/
|
|
45
45
|
export declare class RequestBuyerAcceptance implements ProposalAction {
|
|
46
46
|
private allowOverbookField;
|
|
@@ -49,14 +49,14 @@ export declare class RequestBuyerAcceptance implements ProposalAction {
|
|
|
49
49
|
buildAttributes(): object;
|
|
50
50
|
}
|
|
51
51
|
/**
|
|
52
|
-
* The action used to request buyer review for the {@link https://developers.google.com/ad-manager/api/reference/
|
|
52
|
+
* The action used to request buyer review for the {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal Proposal}.
|
|
53
53
|
*/
|
|
54
54
|
export declare class RequestBuyerReview implements ProposalAction {
|
|
55
55
|
buildAttributes(): object;
|
|
56
56
|
}
|
|
57
57
|
/**
|
|
58
|
-
* The action to reserve inventory for {@link https://developers.google.com/ad-manager/api/reference/
|
|
59
|
-
* It does not allow overbooking unless {@link https://developers.google.com/ad-manager/api/reference/
|
|
58
|
+
* The action to reserve inventory for {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal Proposal} objects.
|
|
59
|
+
* It does not allow overbooking unless {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.ReserveProposals#allowOverbook allowOverbook} is set to true.
|
|
60
60
|
*/
|
|
61
61
|
export declare class ReserveProposals implements ProposalAction {
|
|
62
62
|
private allowOverbookField;
|
|
@@ -65,25 +65,25 @@ export declare class ReserveProposals implements ProposalAction {
|
|
|
65
65
|
buildAttributes(): object;
|
|
66
66
|
}
|
|
67
67
|
/**
|
|
68
|
-
* The action used for resuming programmatic {@link https://developers.google.com/ad-manager/api/reference/
|
|
68
|
+
* The action used for resuming programmatic {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal Proposal} objects.
|
|
69
69
|
*/
|
|
70
70
|
export declare class ResumeProposals implements ProposalAction {
|
|
71
71
|
buildAttributes(): object;
|
|
72
72
|
}
|
|
73
73
|
/**
|
|
74
|
-
* The action for marking all negotiations on the {@link https://developers.google.com/ad-manager/api/reference/
|
|
74
|
+
* The action for marking all negotiations on the {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal Proposal} as terminated in Marketplace.
|
|
75
75
|
*/
|
|
76
76
|
export declare class TerminateNegotiations implements ProposalAction {
|
|
77
77
|
buildAttributes(): object;
|
|
78
78
|
}
|
|
79
79
|
/**
|
|
80
|
-
* The action used for unarchiving {@link https://developers.google.com/ad-manager/api/reference/
|
|
80
|
+
* The action used for unarchiving {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal Proposal} objects.
|
|
81
81
|
*/
|
|
82
82
|
export declare class UnarchiveProposals implements ProposalAction {
|
|
83
83
|
buildAttributes(): object;
|
|
84
84
|
}
|
|
85
85
|
/**
|
|
86
|
-
* The action to update a finalized Marketplace {@link https://developers.google.com/ad-manager/api/reference/
|
|
86
|
+
* The action to update a finalized Marketplace {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.Order Order} with the seller's data.
|
|
87
87
|
*/
|
|
88
88
|
export declare class UpdateOrderWithSellerData implements ProposalAction {
|
|
89
89
|
buildAttributes(): object;
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.UpdateOrderWithSellerData = exports.UnarchiveProposals = exports.TerminateNegotiations = exports.ResumeProposals = exports.ReserveProposals = exports.RequestBuyerReview = exports.RequestBuyerAcceptance = exports.PauseProposals = exports.EditProposalsForNegotiation = exports.DiscardLocalVersionEdits = exports.ArchiveProposals = exports.ProposalAction = void 0;
|
|
4
4
|
/**
|
|
5
|
-
* Represents the actions that can be performed on {@link https://developers.google.com/ad-manager/api/reference/
|
|
5
|
+
* Represents the actions that can be performed on {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal Proposal} objects.
|
|
6
6
|
*/
|
|
7
7
|
class ProposalAction {
|
|
8
8
|
buildAttributes() {
|
|
@@ -11,7 +11,7 @@ class ProposalAction {
|
|
|
11
11
|
}
|
|
12
12
|
exports.ProposalAction = ProposalAction;
|
|
13
13
|
/**
|
|
14
|
-
* The action used for archiving {@link https://developers.google.com/ad-manager/api/reference/
|
|
14
|
+
* The action used for archiving {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal Proposal} objects.
|
|
15
15
|
*/
|
|
16
16
|
class ArchiveProposals {
|
|
17
17
|
buildAttributes() {
|
|
@@ -20,7 +20,7 @@ class ArchiveProposals {
|
|
|
20
20
|
}
|
|
21
21
|
exports.ArchiveProposals = ArchiveProposals;
|
|
22
22
|
/**
|
|
23
|
-
* The action reverting the local {@link https://developers.google.com/ad-manager/api/reference/
|
|
23
|
+
* The action reverting the local {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal Proposal} modifications to reflect the latest terms and private data in Marketplace.
|
|
24
24
|
*/
|
|
25
25
|
class DiscardLocalVersionEdits {
|
|
26
26
|
buildAttributes() {
|
|
@@ -29,10 +29,10 @@ class DiscardLocalVersionEdits {
|
|
|
29
29
|
}
|
|
30
30
|
exports.DiscardLocalVersionEdits = DiscardLocalVersionEdits;
|
|
31
31
|
/**
|
|
32
|
-
* Opens the fields of a {@link https://developers.google.com/ad-manager/api/reference/
|
|
32
|
+
* Opens the fields of a {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal Proposal} for edit.
|
|
33
33
|
* This proposal will not receive updates from Marketplace while it's open for edit.
|
|
34
34
|
* If the buyer updates the proposal while it is open for local editing,
|
|
35
|
-
* Google will set {@link https://developers.google.com/ad-manager/api/reference/
|
|
35
|
+
* Google will set {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.ProposalMarketplaceInfo#isNewVersionFromBuyer ProposalMarketplaceInfo.isNewVersionFromBuyer} to true.
|
|
36
36
|
* You will then need to call DiscardProposalDrafts to revert your edits to get the buyer's latest changes,
|
|
37
37
|
* and then perform this action to start making your edits again.
|
|
38
38
|
*/
|
|
@@ -43,7 +43,7 @@ class EditProposalsForNegotiation {
|
|
|
43
43
|
}
|
|
44
44
|
exports.EditProposalsForNegotiation = EditProposalsForNegotiation;
|
|
45
45
|
/**
|
|
46
|
-
* The action used for pausing programmatic {@link https://developers.google.com/ad-manager/api/reference/
|
|
46
|
+
* The action used for pausing programmatic {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal Proposal} objects.
|
|
47
47
|
*/
|
|
48
48
|
class PauseProposals {
|
|
49
49
|
get reason() {
|
|
@@ -59,9 +59,9 @@ class PauseProposals {
|
|
|
59
59
|
exports.PauseProposals = PauseProposals;
|
|
60
60
|
/**
|
|
61
61
|
* The action used to request acceptance from the buyer for the
|
|
62
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
62
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal Proposal} through Marketplace.
|
|
63
63
|
* This action does check forecasting unless
|
|
64
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
64
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.RequestBuyerAcceptance#allowOverbook allowOverbook} is set to true.
|
|
65
65
|
*/
|
|
66
66
|
class RequestBuyerAcceptance {
|
|
67
67
|
constructor() {
|
|
@@ -79,7 +79,7 @@ class RequestBuyerAcceptance {
|
|
|
79
79
|
}
|
|
80
80
|
exports.RequestBuyerAcceptance = RequestBuyerAcceptance;
|
|
81
81
|
/**
|
|
82
|
-
* The action used to request buyer review for the {@link https://developers.google.com/ad-manager/api/reference/
|
|
82
|
+
* The action used to request buyer review for the {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal Proposal}.
|
|
83
83
|
*/
|
|
84
84
|
class RequestBuyerReview {
|
|
85
85
|
buildAttributes() {
|
|
@@ -88,8 +88,8 @@ class RequestBuyerReview {
|
|
|
88
88
|
}
|
|
89
89
|
exports.RequestBuyerReview = RequestBuyerReview;
|
|
90
90
|
/**
|
|
91
|
-
* The action to reserve inventory for {@link https://developers.google.com/ad-manager/api/reference/
|
|
92
|
-
* It does not allow overbooking unless {@link https://developers.google.com/ad-manager/api/reference/
|
|
91
|
+
* The action to reserve inventory for {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal Proposal} objects.
|
|
92
|
+
* It does not allow overbooking unless {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.ReserveProposals#allowOverbook allowOverbook} is set to true.
|
|
93
93
|
*/
|
|
94
94
|
class ReserveProposals {
|
|
95
95
|
constructor() {
|
|
@@ -107,7 +107,7 @@ class ReserveProposals {
|
|
|
107
107
|
}
|
|
108
108
|
exports.ReserveProposals = ReserveProposals;
|
|
109
109
|
/**
|
|
110
|
-
* The action used for resuming programmatic {@link https://developers.google.com/ad-manager/api/reference/
|
|
110
|
+
* The action used for resuming programmatic {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal Proposal} objects.
|
|
111
111
|
*/
|
|
112
112
|
class ResumeProposals {
|
|
113
113
|
buildAttributes() {
|
|
@@ -116,7 +116,7 @@ class ResumeProposals {
|
|
|
116
116
|
}
|
|
117
117
|
exports.ResumeProposals = ResumeProposals;
|
|
118
118
|
/**
|
|
119
|
-
* The action for marking all negotiations on the {@link https://developers.google.com/ad-manager/api/reference/
|
|
119
|
+
* The action for marking all negotiations on the {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal Proposal} as terminated in Marketplace.
|
|
120
120
|
*/
|
|
121
121
|
class TerminateNegotiations {
|
|
122
122
|
buildAttributes() {
|
|
@@ -125,7 +125,7 @@ class TerminateNegotiations {
|
|
|
125
125
|
}
|
|
126
126
|
exports.TerminateNegotiations = TerminateNegotiations;
|
|
127
127
|
/**
|
|
128
|
-
* The action used for unarchiving {@link https://developers.google.com/ad-manager/api/reference/
|
|
128
|
+
* The action used for unarchiving {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal Proposal} objects.
|
|
129
129
|
*/
|
|
130
130
|
class UnarchiveProposals {
|
|
131
131
|
buildAttributes() {
|
|
@@ -134,7 +134,7 @@ class UnarchiveProposals {
|
|
|
134
134
|
}
|
|
135
135
|
exports.UnarchiveProposals = UnarchiveProposals;
|
|
136
136
|
/**
|
|
137
|
-
* The action to update a finalized Marketplace {@link https://developers.google.com/ad-manager/api/reference/
|
|
137
|
+
* The action to update a finalized Marketplace {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.Order Order} with the seller's data.
|
|
138
138
|
*/
|
|
139
139
|
class UpdateOrderWithSellerData {
|
|
140
140
|
buildAttributes() {
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Describes the {@link https://developers.google.com/ad-manager/api/reference/
|
|
2
|
+
* Describes the {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal Proposal} status.
|
|
3
3
|
*/
|
|
4
4
|
export declare enum ProposalStatus {
|
|
5
5
|
/**
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.RfpType = exports.AdExchangeEnvironment = exports.NegotiationStatus = exports.ProposalCompanyAssociationType = exports.ProposalStatus = void 0;
|
|
4
4
|
/**
|
|
5
|
-
* Describes the {@link https://developers.google.com/ad-manager/api/reference/
|
|
5
|
+
* Describes the {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal Proposal} status.
|
|
6
6
|
*/
|
|
7
7
|
var ProposalStatus;
|
|
8
8
|
(function (ProposalStatus) {
|
|
@@ -258,11 +258,11 @@ export type Proposal = {
|
|
|
258
258
|
deliveryPausingEnabled: boolean;
|
|
259
259
|
};
|
|
260
260
|
/**
|
|
261
|
-
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/
|
|
261
|
+
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal Proposal} objects.
|
|
262
262
|
*/
|
|
263
263
|
export type ProposalPage = PageResult<Proposal>;
|
|
264
264
|
/**
|
|
265
|
-
* A comment associated with a programmatic {@link https://developers.google.com/ad-manager/api/reference/
|
|
265
|
+
* A comment associated with a programmatic {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal Proposal}
|
|
266
266
|
* that has been sent to Marketplace.
|
|
267
267
|
*/
|
|
268
268
|
export type MarketplaceComment = {
|
|
@@ -284,7 +284,7 @@ export type MarketplaceComment = {
|
|
|
284
284
|
createdBySeller: boolean;
|
|
285
285
|
};
|
|
286
286
|
/**
|
|
287
|
-
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/
|
|
287
|
+
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.MarketplaceComment MarketplaceComment} objects.
|
|
288
288
|
*/
|
|
289
289
|
export type MarketplaceCommentPage = {
|
|
290
290
|
/**
|