@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
|
@@ -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
|
/**
|
|
@@ -2,30 +2,30 @@ import type { Statement, UpdateResult } from "../../../common/types";
|
|
|
2
2
|
import type { ProposalAction } from "./proposal.action";
|
|
3
3
|
import type { MarketplaceCommentPage, Proposal, ProposalPage } from "./proposal.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/ProposalService.Proposal Proposal} objects.
|
|
6
6
|
*/
|
|
7
7
|
export interface ProposalServiceOperations {
|
|
8
8
|
/**
|
|
9
|
-
* Creates new {@link https://developers.google.com/ad-manager/api/reference/
|
|
9
|
+
* Creates new {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal Proposal} objects.
|
|
10
10
|
* For each proposal, the following fields are required:
|
|
11
11
|
*
|
|
12
|
-
* - {@link https://developers.google.com/ad-manager/api/reference/
|
|
12
|
+
* - {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal#name Proposal.name}
|
|
13
13
|
*
|
|
14
14
|
* @param proposals the proposals to create
|
|
15
15
|
* @returns the created proposals with their IDs filled in
|
|
16
16
|
*/
|
|
17
17
|
createProposals(proposals: Partial<Proposal>[]): Promise<Proposal[]>;
|
|
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/ProposalService.MarketplaceCommentPage MarketplaceCommentPage}
|
|
20
|
+
* of {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.MarketplaceComment MarketplaceComment} objects that satisfy the given
|
|
21
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Statement#query Statement.query}.
|
|
22
22
|
* This method only returns comments already sent to Marketplace, local draft
|
|
23
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
23
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.ProposalMarketplaceInfo#marketplaceComment ProposalMarketplaceInfo.marketplaceComment}
|
|
24
24
|
* are not included. The following fields are supported for filtering:
|
|
25
25
|
*
|
|
26
26
|
* | PQL Property | PQL Property |
|
|
27
27
|
* | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
28
|
-
* | proposalId | {@link https://developers.google.com/ad-manager/api/reference/
|
|
28
|
+
* | proposalId | {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.MarketplaceComment#proposalId MarketplaceComment.proposalId} |
|
|
29
29
|
*
|
|
30
30
|
* The query must specify a proposalId, and only supports a subset of PQL syntax:
|
|
31
31
|
*
|
|
@@ -40,35 +40,35 @@ export interface ProposalServiceOperations {
|
|
|
40
40
|
*/
|
|
41
41
|
getMarketplaceCommentsByStatement(filterStatement: Statement): Promise<MarketplaceCommentPage>;
|
|
42
42
|
/**
|
|
43
|
-
* Gets a {@link https://developers.google.com/ad-manager/api/reference/
|
|
44
|
-
* of {@link https://developers.google.com/ad-manager/api/reference/
|
|
45
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
43
|
+
* Gets a {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.ProposalPage ProposalPage}
|
|
44
|
+
* of {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal Proposal} objects that satisfy the given
|
|
45
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Statement#query Statement.query}.
|
|
46
46
|
* The following fields are supported for filtering:
|
|
47
47
|
*
|
|
48
48
|
* | PQL Property | PQL Property |
|
|
49
49
|
* | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
50
|
-
* | id | {@link https://developers.google.com/ad-manager/api/reference/
|
|
51
|
-
* | name | {@link https://developers.google.com/ad-manager/api/reference/
|
|
52
|
-
* | dfpOrderId | {@link https://developers.google.com/ad-manager/api/reference/
|
|
53
|
-
* | status | {@link https://developers.google.com/ad-manager/api/reference/
|
|
54
|
-
* | isArchived | {@link https://developers.google.com/ad-manager/api/reference/
|
|
55
|
-
* | approcvalStatus - *Only applicable for proposals using sales management* | {@link https://developers.google.com/ad-manager/api/reference/
|
|
56
|
-
* | lastModifiedDateTime | {@link https://developers.google.com/ad-manager/api/reference/
|
|
57
|
-
* | isProgrammatic | {@link https://developers.google.com/ad-manager/api/reference/
|
|
58
|
-
* | negotiationStatus - *Only applicable for programmatic proposals* | {@link https://developers.google.com/ad-manager/api/reference/
|
|
50
|
+
* | id | {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal#id Proposal.id} |
|
|
51
|
+
* | name | {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal#name Proposal.name} |
|
|
52
|
+
* | dfpOrderId | {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal#dfpOrderId Proposal.dfpOrderId} |
|
|
53
|
+
* | status | {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal#status Proposal.status} |
|
|
54
|
+
* | isArchived | {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal#isArchived Proposal.isArchived} |
|
|
55
|
+
* | approcvalStatus - *Only applicable for proposals using sales management* | {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal#approvalStatus Proposal.approvalStatus} |
|
|
56
|
+
* | lastModifiedDateTime | {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal#lastModifiedDateTime Proposal.lastModifiedDateTime} |
|
|
57
|
+
* | isProgrammatic | {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal#isProgrammatic Proposal.isProgrammatic} |
|
|
58
|
+
* | negotiationStatus - *Only applicable for programmatic proposals* | {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal#negotiationStatus Proposal.negotiationStatus} |
|
|
59
59
|
*
|
|
60
60
|
* @param filterStatement a Publisher Query Language statement used to filter a set of proposals
|
|
61
61
|
* @returns the proposals that match the given filter
|
|
62
62
|
*/
|
|
63
63
|
getProposalsByStatement(filterStatement: Statement): Promise<ProposalPage>;
|
|
64
64
|
/**
|
|
65
|
-
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/
|
|
66
|
-
* objects that match the given {@link https://developers.google.com/ad-manager/api/reference/
|
|
65
|
+
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal Proposal}
|
|
66
|
+
* objects that match the given {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Statement#query Statement.query}.
|
|
67
67
|
* The following fields are also required when submitting proposals for approval:
|
|
68
68
|
*
|
|
69
|
-
* - {@link https://developers.google.com/ad-manager/api/reference/
|
|
70
|
-
* - {@link https://developers.google.com/ad-manager/api/reference/
|
|
71
|
-
* - {@link https://developers.google.com/ad-manager/api/reference/
|
|
69
|
+
* - {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal#advertiser Proposal.advertiser}
|
|
70
|
+
* - {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal#primarySalesperson Proposal.primarySalesperson}
|
|
71
|
+
* - {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal#primaryTraffickerId Proposal.primaryTraffickerId}
|
|
72
72
|
*
|
|
73
73
|
* @param proposalAction the action to perform
|
|
74
74
|
* @param filterStatement a PQL statement used to filter proposals
|
|
@@ -76,7 +76,7 @@ export interface ProposalServiceOperations {
|
|
|
76
76
|
*/
|
|
77
77
|
performProposalAction(proposalAction: ProposalAction, filterStatement: Statement): Promise<UpdateResult>;
|
|
78
78
|
/**
|
|
79
|
-
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/
|
|
79
|
+
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal Proposal} objects.
|
|
80
80
|
*
|
|
81
81
|
* @param proposals the proposals to update
|
|
82
82
|
* @returns the updated proposals
|
|
@@ -1,40 +1,40 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Represents the actions that can be performed on
|
|
3
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
3
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.ProposalLineItem ProposalLineItem} objects.
|
|
4
4
|
*/
|
|
5
5
|
export declare abstract class ProposalLineItemAction {
|
|
6
6
|
buildAttributes(): object;
|
|
7
7
|
}
|
|
8
8
|
/**
|
|
9
|
-
* The action used for archiving {@link https://developers.google.com/ad-manager/api/reference/
|
|
9
|
+
* The action used for archiving {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.ProposalLineItem ProposalLineItem} objects.
|
|
10
10
|
*/
|
|
11
11
|
export declare class ArchiveProposalLineItems implements ProposalLineItemAction {
|
|
12
12
|
buildAttributes(): object;
|
|
13
13
|
}
|
|
14
14
|
/**
|
|
15
|
-
* The action used for pausing {@link https://developers.google.com/ad-manager/api/reference/
|
|
15
|
+
* The action used for pausing {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.ProposalLineItem ProposalLineItem} objects.
|
|
16
16
|
*/
|
|
17
17
|
export declare class PauseProposalLineItems implements ProposalLineItemAction {
|
|
18
18
|
private reasonField?;
|
|
19
19
|
/**
|
|
20
|
-
* Reason to describe why the {@link https://developers.google.com/ad-manager/api/reference/
|
|
20
|
+
* Reason to describe why the {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.ProposalLineItem ProposalLineItem} is being paused.
|
|
21
21
|
*/
|
|
22
22
|
get reason(): string | undefined;
|
|
23
23
|
/**
|
|
24
|
-
* Reason to describe why the {@link https://developers.google.com/ad-manager/api/reference/
|
|
24
|
+
* Reason to describe why the {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.ProposalLineItem ProposalLineItem} is being paused.
|
|
25
25
|
*/
|
|
26
26
|
set reason(value: string);
|
|
27
27
|
buildAttributes(): object;
|
|
28
28
|
}
|
|
29
29
|
/**
|
|
30
|
-
* The action used for releasing inventory for {@link https://developers.google.com/ad-manager/api/reference/
|
|
30
|
+
* The action used for releasing inventory for {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.ProposalLineItem ProposalLineItem} objects.
|
|
31
31
|
*/
|
|
32
32
|
export declare class ReleaseProposalLineItems implements ProposalLineItemAction {
|
|
33
33
|
buildAttributes(): object;
|
|
34
34
|
}
|
|
35
35
|
/**
|
|
36
|
-
* The action to reserve inventory for {@link https://developers.google.com/ad-manager/api/reference/
|
|
37
|
-
* It does not overbook inventory unless {@link https://developers.google.com/ad-manager/api/reference/
|
|
36
|
+
* The action to reserve inventory for {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.ProposalLineItem ProposalLineItem} objects.
|
|
37
|
+
* It does not overbook inventory unless {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.ReserveProposalLineItems#allowOverbook allowOverbook} is set to `true`. This action is only applicable for programmatic proposals not using sales management.
|
|
38
38
|
*/
|
|
39
39
|
export declare class ReserveProposalLineItems implements ProposalLineItemAction {
|
|
40
40
|
private allowOverbookField;
|
|
@@ -43,13 +43,13 @@ export declare class ReserveProposalLineItems implements ProposalLineItemAction
|
|
|
43
43
|
buildAttributes(): object;
|
|
44
44
|
}
|
|
45
45
|
/**
|
|
46
|
-
* The action used for resuming {@link https://developers.google.com/ad-manager/api/reference/
|
|
46
|
+
* The action used for resuming {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.ProposalLineItem ProposalLineItem} objects.
|
|
47
47
|
*/
|
|
48
48
|
export declare class ResumeProposalLineItems implements ProposalLineItemAction {
|
|
49
49
|
buildAttributes(): object;
|
|
50
50
|
}
|
|
51
51
|
/**
|
|
52
|
-
* The action used for unarchiving {@link https://developers.google.com/ad-manager/api/reference/
|
|
52
|
+
* The action used for unarchiving {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.ProposalLineItem ProposalLineItem} objects.
|
|
53
53
|
*/
|
|
54
54
|
export declare class UnarchiveProposalLineItems implements ProposalLineItemAction {
|
|
55
55
|
buildAttributes(): object;
|
|
@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.UnarchiveProposalLineItems = exports.ResumeProposalLineItems = exports.ReserveProposalLineItems = exports.ReleaseProposalLineItems = exports.PauseProposalLineItems = exports.ArchiveProposalLineItems = exports.ProposalLineItemAction = void 0;
|
|
4
4
|
/**
|
|
5
5
|
* Represents the actions that can be performed on
|
|
6
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
6
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.ProposalLineItem ProposalLineItem} objects.
|
|
7
7
|
*/
|
|
8
8
|
class ProposalLineItemAction {
|
|
9
9
|
buildAttributes() {
|
|
@@ -12,7 +12,7 @@ class ProposalLineItemAction {
|
|
|
12
12
|
}
|
|
13
13
|
exports.ProposalLineItemAction = ProposalLineItemAction;
|
|
14
14
|
/**
|
|
15
|
-
* The action used for archiving {@link https://developers.google.com/ad-manager/api/reference/
|
|
15
|
+
* The action used for archiving {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.ProposalLineItem ProposalLineItem} objects.
|
|
16
16
|
*/
|
|
17
17
|
class ArchiveProposalLineItems {
|
|
18
18
|
buildAttributes() {
|
|
@@ -21,17 +21,17 @@ class ArchiveProposalLineItems {
|
|
|
21
21
|
}
|
|
22
22
|
exports.ArchiveProposalLineItems = ArchiveProposalLineItems;
|
|
23
23
|
/**
|
|
24
|
-
* The action used for pausing {@link https://developers.google.com/ad-manager/api/reference/
|
|
24
|
+
* The action used for pausing {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.ProposalLineItem ProposalLineItem} objects.
|
|
25
25
|
*/
|
|
26
26
|
class PauseProposalLineItems {
|
|
27
27
|
/**
|
|
28
|
-
* Reason to describe why the {@link https://developers.google.com/ad-manager/api/reference/
|
|
28
|
+
* Reason to describe why the {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.ProposalLineItem ProposalLineItem} is being paused.
|
|
29
29
|
*/
|
|
30
30
|
get reason() {
|
|
31
31
|
return this.reasonField;
|
|
32
32
|
}
|
|
33
33
|
/**
|
|
34
|
-
* Reason to describe why the {@link https://developers.google.com/ad-manager/api/reference/
|
|
34
|
+
* Reason to describe why the {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.ProposalLineItem ProposalLineItem} is being paused.
|
|
35
35
|
*/
|
|
36
36
|
set reason(value) {
|
|
37
37
|
this.reasonField = value;
|
|
@@ -42,7 +42,7 @@ class PauseProposalLineItems {
|
|
|
42
42
|
}
|
|
43
43
|
exports.PauseProposalLineItems = PauseProposalLineItems;
|
|
44
44
|
/**
|
|
45
|
-
* The action used for releasing inventory for {@link https://developers.google.com/ad-manager/api/reference/
|
|
45
|
+
* The action used for releasing inventory for {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.ProposalLineItem ProposalLineItem} objects.
|
|
46
46
|
*/
|
|
47
47
|
class ReleaseProposalLineItems {
|
|
48
48
|
buildAttributes() {
|
|
@@ -51,8 +51,8 @@ class ReleaseProposalLineItems {
|
|
|
51
51
|
}
|
|
52
52
|
exports.ReleaseProposalLineItems = ReleaseProposalLineItems;
|
|
53
53
|
/**
|
|
54
|
-
* The action to reserve inventory for {@link https://developers.google.com/ad-manager/api/reference/
|
|
55
|
-
* It does not overbook inventory unless {@link https://developers.google.com/ad-manager/api/reference/
|
|
54
|
+
* The action to reserve inventory for {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.ProposalLineItem ProposalLineItem} objects.
|
|
55
|
+
* It does not overbook inventory unless {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.ReserveProposalLineItems#allowOverbook allowOverbook} is set to `true`. This action is only applicable for programmatic proposals not using sales management.
|
|
56
56
|
*/
|
|
57
57
|
class ReserveProposalLineItems {
|
|
58
58
|
constructor() {
|
|
@@ -70,7 +70,7 @@ class ReserveProposalLineItems {
|
|
|
70
70
|
}
|
|
71
71
|
exports.ReserveProposalLineItems = ReserveProposalLineItems;
|
|
72
72
|
/**
|
|
73
|
-
* The action used for resuming {@link https://developers.google.com/ad-manager/api/reference/
|
|
73
|
+
* The action used for resuming {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.ProposalLineItem ProposalLineItem} objects.
|
|
74
74
|
*/
|
|
75
75
|
class ResumeProposalLineItems {
|
|
76
76
|
buildAttributes() {
|
|
@@ -79,7 +79,7 @@ class ResumeProposalLineItems {
|
|
|
79
79
|
}
|
|
80
80
|
exports.ResumeProposalLineItems = ResumeProposalLineItems;
|
|
81
81
|
/**
|
|
82
|
-
* The action used for unarchiving {@link https://developers.google.com/ad-manager/api/reference/
|
|
82
|
+
* The action used for unarchiving {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.ProposalLineItem ProposalLineItem} objects.
|
|
83
83
|
*/
|
|
84
84
|
class UnarchiveProposalLineItems {
|
|
85
85
|
buildAttributes() {
|
|
@@ -21,8 +21,8 @@ export type ProposalLineItemMakegoodInfo = {
|
|
|
21
21
|
reason: string;
|
|
22
22
|
};
|
|
23
23
|
/**
|
|
24
|
-
* A ProposalLineItem is added to a programmatic {@link https://developers.google.com/ad-manager/api/reference/
|
|
25
|
-
* and is similar to a delivery {@link https://developers.google.com/ad-manager/api/reference/
|
|
24
|
+
* A ProposalLineItem is added to a programmatic {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalService.Proposal Proposal}
|
|
25
|
+
* and is similar to a delivery {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem LineItem}.
|
|
26
26
|
* It contains delivery details including information like impression goal or quantity, start and end times, and targeting.
|
|
27
27
|
*/
|
|
28
28
|
export type ProposalLineItem = {
|
|
@@ -281,7 +281,7 @@ export type ProposalLineItem = {
|
|
|
281
281
|
pauseReason: string;
|
|
282
282
|
};
|
|
283
283
|
/**
|
|
284
|
-
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/
|
|
284
|
+
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.ProposalLineItem ProposalLineItem} objects.
|
|
285
285
|
*/
|
|
286
286
|
export type ProposalLineItemPage = PageResult<ProposalLineItem>;
|
|
287
287
|
//# sourceMappingURL=proposalLineItem.type.d.ts.map
|