@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,21 +2,21 @@ import type { Statement, UpdateResult } from "../../../common/types";
|
|
|
2
2
|
import type { LiveStreamEventAction } from "./liveStreamEvent.action";
|
|
3
3
|
import type { LiveStreamEvent, LiveStreamEventPage, Slate, SlateAction, SlatePage } from "./liveStreamEvent.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/LiveStreamEventService.LiveStreamEvent LiveStreamEvent} objects.
|
|
6
6
|
*
|
|
7
7
|
* This feature is only available for Ad Manager 360 networks. Publishers will need to be activated through the Video > Live streams tab in the Ad Manager UI.
|
|
8
8
|
* For access, apply through your account manager.
|
|
9
9
|
*/
|
|
10
10
|
export interface LiveStreamEventServiceOperations {
|
|
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/LiveStreamEventService.LiveStreamEvent LiveStreamEvent} objects.
|
|
13
13
|
* The following fields are required:
|
|
14
14
|
*
|
|
15
|
-
* - {@link https://developers.google.com/ad-manager/api/reference/
|
|
16
|
-
* - {@link https://developers.google.com/ad-manager/api/reference/
|
|
17
|
-
* - {@link https://developers.google.com/ad-manager/api/reference/
|
|
18
|
-
* - {@link https://developers.google.com/ad-manager/api/reference/
|
|
19
|
-
* - {@link https://developers.google.com/ad-manager/api/reference/
|
|
15
|
+
* - {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent#name LiveStreamEvent.name }
|
|
16
|
+
* - {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent#startDateTime LiveStreamEvent.startDateTime }
|
|
17
|
+
* - {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent#endDateTime LiveStreamEvent.endDateTime }
|
|
18
|
+
* - {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent#contentUrls LiveStreamEvent.contentUrls }
|
|
19
|
+
* - {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent#adTags LiveStreamEvent.adTags }
|
|
20
20
|
*
|
|
21
21
|
* @param liveStreamEvents the live stream events to create
|
|
22
22
|
* @returns the created live stream events with their IDs filled in
|
|
@@ -31,46 +31,46 @@ export interface LiveStreamEventServiceOperations {
|
|
|
31
31
|
*/
|
|
32
32
|
createSlates(slates: Partial<Slate>[]): Promise<Slate[]>;
|
|
33
33
|
/**
|
|
34
|
-
* Gets a {@link https://developers.google.com/ad-manager/api/reference/
|
|
35
|
-
* of {@link https://developers.google.com/ad-manager/api/reference/
|
|
36
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
34
|
+
* Gets a {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEventPage LiveStreamEventPage}
|
|
35
|
+
* of {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent LiveStreamEvent} objects that satisfy the given
|
|
36
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.Statement#query Statement.query}.
|
|
37
37
|
* The following fields are supported for filtering:
|
|
38
38
|
*
|
|
39
39
|
* | PQL Property | PQL Property
|
|
40
40
|
* | ----------------------------------- | -----------------------------------------------------------------------------------------------------------------------------------------------
|
|
41
|
-
* | id | {@link https://developers.google.com/ad-manager/api/reference/
|
|
42
|
-
* | slateCreativeId | {@link https://developers.google.com/ad-manager/api/reference/
|
|
43
|
-
* | assetKey | {@link https://developers.google.com/ad-manager/api/reference/
|
|
44
|
-
* | streamCreateDaiAuthenticationKeyIds | {@link https://developers.google.com/ad-manager/api/reference/
|
|
45
|
-
* | dynamicAdInsertionType | {@link https://developers.google.com/ad-manager/api/reference/
|
|
46
|
-
* | streamingFormat | {@link https://developers.google.com/ad-manager/api/reference/
|
|
47
|
-
* | customAssetKey | {@link https://developers.google.com/ad-manager/api/reference/
|
|
48
|
-
* | daiEncodingProfileIds | {@link https://developers.google.com/ad-manager/api/reference/
|
|
49
|
-
* | segmentUrlAuthenticationKeyIds | {@link https://developers.google.com/ad-manager/api/reference/
|
|
41
|
+
* | id | {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent#id LiveStreamEvent.id}
|
|
42
|
+
* | slateCreativeId | {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent#slateCreativeId LiveStreamEvent.slateCreativeId}
|
|
43
|
+
* | assetKey | {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent#assetKey LiveStreamEvent.assetKey}
|
|
44
|
+
* | streamCreateDaiAuthenticationKeyIds | {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent#streamCreateDaiAuthenticationKeyIds LiveStreamEvent.streamCreateDaiAuthenticationKeyIds}
|
|
45
|
+
* | dynamicAdInsertionType | {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent#dynamicAdInsertionType LiveStreamEvent.dynamicAdInsertionType}
|
|
46
|
+
* | streamingFormat | {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent#streamingFormat LiveStreamEvent.streamingFormat}
|
|
47
|
+
* | customAssetKey | {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent#customAssetKey LiveStreamEvent.customAssetKey}
|
|
48
|
+
* | daiEncodingProfileIds | {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent#daiEncodingProfileIds LiveStreamEvent.daiEncodingProfileIds}
|
|
49
|
+
* | segmentUrlAuthenticationKeyIds | {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent#segmentUrlAuthenticationKeyIds LiveStreamEvent.segmentUrlAuthenticationKeyIds}
|
|
50
50
|
*
|
|
51
51
|
* @param filterStatement a Publisher Query Language statement to filter a list of live stream events
|
|
52
52
|
* @returns the live stream events that match the filter
|
|
53
53
|
*/
|
|
54
54
|
getLiveStreamEventsByStatement(filterStatement: Statement): Promise<LiveStreamEventPage>;
|
|
55
55
|
/**
|
|
56
|
-
* Gets a {@link https://developers.google.com/ad-manager/api/reference/
|
|
57
|
-
* of {@link https://developers.google.com/ad-manager/api/reference/
|
|
58
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
56
|
+
* Gets a {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.SlatePage SlatePage}
|
|
57
|
+
* of {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.Slate Slate} objects that satisfy the given
|
|
58
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.Statement#query Statement.query}.
|
|
59
59
|
* The following fields are supported for filtering:
|
|
60
60
|
*
|
|
61
61
|
* | PQL Property | PQL Property
|
|
62
62
|
* | -------------------- | -----------------------------------------------------------------------------------------------------------------------------------------------
|
|
63
|
-
* | id | {@link https://developers.google.com/ad-manager/api/reference/
|
|
64
|
-
* | name | {@link https://developers.google.com/ad-manager/api/reference/
|
|
65
|
-
* | lastModifiedDateTime | {@link https://developers.google.com/ad-manager/api/reference/
|
|
63
|
+
* | id | {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.Slate#id LiveStreamEvent.id}
|
|
64
|
+
* | name | {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.Slate#name LiveStreamEvent.name}
|
|
65
|
+
* | lastModifiedDateTime | {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.Slate#lastModifiedDateTime LiveStreamEvent.lastModifiedDateTime}
|
|
66
66
|
*
|
|
67
67
|
* @param statement a Publisher Query Language statement used to filter slates
|
|
68
68
|
* @returns the slates that match the given filter
|
|
69
69
|
*/
|
|
70
70
|
getSlatesByStatement(statement: Statement): Promise<SlatePage>;
|
|
71
71
|
/**
|
|
72
|
-
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/
|
|
73
|
-
* objects that match the given {@link https://developers.google.com/ad-manager/api/reference/
|
|
72
|
+
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent LiveStreamEvent}
|
|
73
|
+
* objects that match the given {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.Statement#query Statement.query}.
|
|
74
74
|
*
|
|
75
75
|
* @param liveStreamEventAction the action to perform
|
|
76
76
|
* @param filterStatement a Publisher Query Language statement used to filter a set of live stream events
|
|
@@ -78,7 +78,7 @@ export interface LiveStreamEventServiceOperations {
|
|
|
78
78
|
*/
|
|
79
79
|
performLiveStreamEventAction(liveStreamEventAction: LiveStreamEventAction, filterStatement: Statement): Promise<UpdateResult>;
|
|
80
80
|
/**
|
|
81
|
-
* Performs actions on slates that match the given {@link https://developers.google.com/ad-manager/api/reference/
|
|
81
|
+
* Performs actions on slates that match the given {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.Statement Statement}.
|
|
82
82
|
*
|
|
83
83
|
* @param slateAction the action to perform
|
|
84
84
|
* @param filterStatement a Publisher Query Language statement used to filter a set of slates
|
|
@@ -86,7 +86,7 @@ export interface LiveStreamEventServiceOperations {
|
|
|
86
86
|
*/
|
|
87
87
|
performSlateAction(slateAction: SlateAction, filterStatement: Statement): Promise<UpdateResult>;
|
|
88
88
|
/**
|
|
89
|
-
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/
|
|
89
|
+
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent LiveStreamEvent} objects.
|
|
90
90
|
*
|
|
91
91
|
* @param liveStreamEvents the live stream events to update
|
|
92
92
|
* @returns the updated live stream events
|
|
@@ -1,15 +1,15 @@
|
|
|
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/MobileApplicationService.MobileApplication mobile applications}.
|
|
3
3
|
*/
|
|
4
4
|
export declare abstract class MobileApplicationAction {
|
|
5
5
|
}
|
|
6
6
|
/**
|
|
7
|
-
* The action used to deactivate {@link https://developers.google.com/ad-manager/api/reference/
|
|
7
|
+
* The action used to deactivate {@link https://developers.google.com/ad-manager/api/reference/latest/MobileApplicationService.MobileApplication MobileApplication} objects.
|
|
8
8
|
*/
|
|
9
9
|
export declare class ArchiveMobileApplications implements MobileApplicationAction {
|
|
10
10
|
}
|
|
11
11
|
/**
|
|
12
|
-
* The action used to activate {@link https://developers.google.com/ad-manager/api/reference/
|
|
12
|
+
* The action used to activate {@link https://developers.google.com/ad-manager/api/reference/latest/MobileApplicationService.MobileApplication MobileApplication} objects.
|
|
13
13
|
*/
|
|
14
14
|
export declare class UnarchiveMobileApplications implements MobileApplicationAction {
|
|
15
15
|
}
|
|
@@ -2,19 +2,19 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.UnarchiveMobileApplications = exports.ArchiveMobileApplications = exports.MobileApplicationAction = 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/MobileApplicationService.MobileApplication mobile applications}.
|
|
6
6
|
*/
|
|
7
7
|
class MobileApplicationAction {
|
|
8
8
|
}
|
|
9
9
|
exports.MobileApplicationAction = MobileApplicationAction;
|
|
10
10
|
/**
|
|
11
|
-
* The action used to deactivate {@link https://developers.google.com/ad-manager/api/reference/
|
|
11
|
+
* The action used to deactivate {@link https://developers.google.com/ad-manager/api/reference/latest/MobileApplicationService.MobileApplication MobileApplication} objects.
|
|
12
12
|
*/
|
|
13
13
|
class ArchiveMobileApplications {
|
|
14
14
|
}
|
|
15
15
|
exports.ArchiveMobileApplications = ArchiveMobileApplications;
|
|
16
16
|
/**
|
|
17
|
-
* The action used to activate {@link https://developers.google.com/ad-manager/api/reference/
|
|
17
|
+
* The action used to activate {@link https://developers.google.com/ad-manager/api/reference/latest/MobileApplicationService.MobileApplication MobileApplication} objects.
|
|
18
18
|
*/
|
|
19
19
|
class UnarchiveMobileApplications {
|
|
20
20
|
}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* A store a {@link https://developers.google.com/ad-manager/api/reference/
|
|
2
|
+
* A store a {@link https://developers.google.com/ad-manager/api/reference/latest/MobileApplicationService.MobileApplication MobileApplication} is available on.
|
|
3
3
|
*/
|
|
4
4
|
export declare enum MobileApplicationStore {
|
|
5
5
|
/**
|
|
@@ -20,7 +20,7 @@ export declare enum MobileApplicationStore {
|
|
|
20
20
|
XIAOMI_APP_STORE = "XIAOMI_APP_STORE"
|
|
21
21
|
}
|
|
22
22
|
/**
|
|
23
|
-
* A platform a {@link https://developers.google.com/ad-manager/api/reference/
|
|
23
|
+
* A platform a {@link https://developers.google.com/ad-manager/api/reference/latest/MobileApplicationService.MobileApplication MobileApplication} can run on.
|
|
24
24
|
*/
|
|
25
25
|
export declare enum MobileApplicationPlatform {
|
|
26
26
|
/**
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.MobileApplicationPlatform = exports.MobileApplicationStore = void 0;
|
|
4
4
|
/**
|
|
5
|
-
* A store a {@link https://developers.google.com/ad-manager/api/reference/
|
|
5
|
+
* A store a {@link https://developers.google.com/ad-manager/api/reference/latest/MobileApplicationService.MobileApplication MobileApplication} is available on.
|
|
6
6
|
*/
|
|
7
7
|
var MobileApplicationStore;
|
|
8
8
|
(function (MobileApplicationStore) {
|
|
@@ -24,7 +24,7 @@ var MobileApplicationStore;
|
|
|
24
24
|
MobileApplicationStore["XIAOMI_APP_STORE"] = "XIAOMI_APP_STORE";
|
|
25
25
|
})(MobileApplicationStore || (exports.MobileApplicationStore = MobileApplicationStore = {}));
|
|
26
26
|
/**
|
|
27
|
-
* A platform a {@link https://developers.google.com/ad-manager/api/reference/
|
|
27
|
+
* A platform a {@link https://developers.google.com/ad-manager/api/reference/latest/MobileApplicationService.MobileApplication MobileApplication} can run on.
|
|
28
28
|
*/
|
|
29
29
|
var MobileApplicationPlatform;
|
|
30
30
|
(function (MobileApplicationPlatform) {
|
|
@@ -56,7 +56,7 @@ export type MobileApplication = {
|
|
|
56
56
|
downloadUrl: string;
|
|
57
57
|
};
|
|
58
58
|
/**
|
|
59
|
-
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/
|
|
59
|
+
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/latest/MobileApplicationService.MobileApplication mobile applications}.
|
|
60
60
|
*/
|
|
61
61
|
export type MobileApplicationPage = PageResult<MobileApplication>;
|
|
62
62
|
//# sourceMappingURL=mobileApplication.type.d.ts.map
|
|
@@ -2,36 +2,36 @@ import type { Statement, UpdateResult } from "../../../common/types";
|
|
|
2
2
|
import type { MobileApplicationAction } from "./mobileApplication.action";
|
|
3
3
|
import type { MobileApplication, MobileApplicationPage } from "./mobileApplication.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/MobileApplicationService.MobileApplication MobileApplication} objects.
|
|
6
6
|
*/
|
|
7
7
|
export interface MobileApplicationServiceOperations {
|
|
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/MobileApplicationService.MobileApplication mobile applications} objects.
|
|
10
10
|
*
|
|
11
11
|
* @param mobileApplications the mobile applications to create
|
|
12
12
|
* @returns the created mobile applications with their IDs filled in
|
|
13
13
|
*/
|
|
14
14
|
createMobileApplications(mobileApplications: Partial<MobileApplication>[]): Promise<MobileApplication[]>;
|
|
15
15
|
/**
|
|
16
|
-
* Gets a {@link https://developers.google.com/ad-manager/api/reference/
|
|
17
|
-
* of {@link https://developers.google.com/ad-manager/api/reference/
|
|
18
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
16
|
+
* Gets a {@link https://developers.google.com/ad-manager/api/reference/latest/MobileApplicationService.MobileApplicationPage MobileApplicationPage}
|
|
17
|
+
* of {@link https://developers.google.com/ad-manager/api/reference/latest/MobileApplicationService.MobileApplication MobileApplication} objects that satisfy the given
|
|
18
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/MobileApplicationService.Statement#query Statement.query}.
|
|
19
19
|
* The following fields are supported for filtering:
|
|
20
20
|
*
|
|
21
21
|
* | PQL Property | PQL Property |
|
|
22
22
|
* | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
23
|
-
* | id | {@link https://developers.google.com/ad-manager/api/reference/
|
|
24
|
-
* | displayName | {@link https://developers.google.com/ad-manager/api/reference/
|
|
25
|
-
* | appStore | {@link https://developers.google.com/ad-manager/api/reference/
|
|
26
|
-
* | appStoreId | {@link https://developers.google.com/ad-manager/api/reference/
|
|
27
|
-
* | isArchived | {@link https://developers.google.com/ad-manager/api/reference/
|
|
23
|
+
* | id | {@link https://developers.google.com/ad-manager/api/reference/latest/MobileApplicationService.MobileApplication#id MobileApplication.id} |
|
|
24
|
+
* | displayName | {@link https://developers.google.com/ad-manager/api/reference/latest/MobileApplicationService.MobileApplication#displayName MobileApplication.displayName} |
|
|
25
|
+
* | appStore | {@link https://developers.google.com/ad-manager/api/reference/latest/MobileApplicationService.MobileApplication#appStore MobileApplication.appStore} |
|
|
26
|
+
* | appStoreId | {@link https://developers.google.com/ad-manager/api/reference/latest/MobileApplicationService.MobileApplication#appStoreId MobileApplication.appStoreId} |
|
|
27
|
+
* | isArchived | {@link https://developers.google.com/ad-manager/api/reference/latest/MobileApplicationService.MobileApplication#isArchived MobileApplication.isArchived} |
|
|
28
28
|
*
|
|
29
29
|
* @param filterStatement a Publisher Query Language statement used to filter a set of mobile applications.
|
|
30
30
|
* @returns the mobile applications that match the given filter
|
|
31
31
|
*/
|
|
32
32
|
getMobileApplicationsByStatement(filterStatement: Statement): Promise<MobileApplicationPage>;
|
|
33
33
|
/**
|
|
34
|
-
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/
|
|
34
|
+
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/latest/MobileApplicationService.MobileApplication MobileApplication}.
|
|
35
35
|
*
|
|
36
36
|
* @param mobileApplicationAction the action to perform
|
|
37
37
|
* @param filterStatement a PQL statement used to filter mobile applications
|
|
@@ -39,7 +39,7 @@ export interface MobileApplicationServiceOperations {
|
|
|
39
39
|
*/
|
|
40
40
|
performMobileApplicationAction(mobileApplicationAction: MobileApplicationAction, filterStatement: Statement): Promise<UpdateResult>;
|
|
41
41
|
/**
|
|
42
|
-
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/
|
|
42
|
+
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/latest/MobileApplicationService.MobileApplication MobileApplication} objects.
|
|
43
43
|
*
|
|
44
44
|
* @param mobileApplications the mobile applications to update
|
|
45
45
|
* @returns the updated mobile applications
|
|
@@ -43,7 +43,7 @@ export type NativeStyle = {
|
|
|
43
43
|
size: Size;
|
|
44
44
|
};
|
|
45
45
|
/**
|
|
46
|
-
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/
|
|
46
|
+
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/latest/NativeStyleService.NativeStyle NativeStyle} objects.
|
|
47
47
|
*/
|
|
48
48
|
export type NativeStylePage = PageResult<NativeStyle>;
|
|
49
49
|
//# sourceMappingURL=nativeStyle.type.d.ts.map
|
|
@@ -2,33 +2,33 @@ import type { Statement, UpdateResult } from "../../../common/types";
|
|
|
2
2
|
import type { NativeStyleAction } from "./nativeStyle.action";
|
|
3
3
|
import type { NativeStyle, NativeStylePage } from "./nativeStyle.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/NativeStyleService.NativeStyle NativeStyle} objects.
|
|
6
6
|
*/
|
|
7
7
|
export interface NativeStyleServiceOperations {
|
|
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/NativeStyleService.NativeStyle NativeStyle} objects.
|
|
10
10
|
*
|
|
11
11
|
* @param nativeStyles the native styles to create
|
|
12
12
|
* @returns the created native styles with their IDs filled in
|
|
13
13
|
*/
|
|
14
14
|
createNativeStyles(nativeStyles: Partial<NativeStyle>[]): Promise<NativeStyle[]>;
|
|
15
15
|
/**
|
|
16
|
-
* Gets a {@link https://developers.google.com/ad-manager/api/reference/
|
|
17
|
-
* of {@link https://developers.google.com/ad-manager/api/reference/
|
|
18
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
16
|
+
* Gets a {@link https://developers.google.com/ad-manager/api/reference/latest/NativeStyleService.NativeStylePage NativeStylePage}
|
|
17
|
+
* of {@link https://developers.google.com/ad-manager/api/reference/latest/NativeStyleService.NativeStyle NativeStyle} objects that satisfy the given
|
|
18
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/NativeStyleService.Statement#query Statement.query}.
|
|
19
19
|
* The following fields are supported for filtering:
|
|
20
20
|
*
|
|
21
21
|
* | PQL Property | PQL Property |
|
|
22
22
|
* | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
23
|
-
* | id | {@link https://developers.google.com/ad-manager/api/reference/
|
|
24
|
-
* | name | {@link https://developers.google.com/ad-manager/api/reference/
|
|
23
|
+
* | id | {@link https://developers.google.com/ad-manager/api/reference/latest/NativeStyleService.NativeStyle#id NativeStyle.id} |
|
|
24
|
+
* | name | {@link https://developers.google.com/ad-manager/api/reference/latest/NativeStyleService.NativeStyle#name NativeStyle.name} |
|
|
25
25
|
*
|
|
26
26
|
* @param filterStatement a Publisher Query Language statement used to filter a set of native styles
|
|
27
27
|
* @returns the native styles that match the given filter
|
|
28
28
|
*/
|
|
29
29
|
getNativeStylesByStatement(filterStatement: Statement): Promise<NativeStylePage>;
|
|
30
30
|
/**
|
|
31
|
-
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/
|
|
31
|
+
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/latest/NativeStyleService.NativeStyle native styles} objects that match the given Statement.
|
|
32
32
|
*
|
|
33
33
|
* @param nativeStyleAction the action to perform
|
|
34
34
|
* @param filterStatement a PQL statement used to filter native styles
|
|
@@ -36,7 +36,7 @@ export interface NativeStyleServiceOperations {
|
|
|
36
36
|
*/
|
|
37
37
|
performNativeStyleAction(nativeStyleAction: NativeStyleAction, filterStatement: Statement): Promise<UpdateResult>;
|
|
38
38
|
/**
|
|
39
|
-
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/
|
|
39
|
+
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/latest/NativeStyleService.NativeStyle NativeStyle} objects.
|
|
40
40
|
*
|
|
41
41
|
* @param nativeStyles the native styles to update
|
|
42
42
|
* @returns the updated native styles
|
|
@@ -1,14 +1,14 @@
|
|
|
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/OrderService.Order Order} objects.
|
|
4
4
|
*/
|
|
5
5
|
export declare abstract class OrderAction {
|
|
6
6
|
buildAttributes(): object;
|
|
7
7
|
}
|
|
8
8
|
/**
|
|
9
9
|
* The action used for approving
|
|
10
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
11
|
-
* All {@link https://developers.google.com/ad-manager/api/reference/
|
|
10
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.Order Order} objects.
|
|
11
|
+
* All {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem LineItem}
|
|
12
12
|
* objects within the order will be approved as well.
|
|
13
13
|
* For more information on what happens to an order and its line items when it is approved,
|
|
14
14
|
* see the {@link https://support.google.com/dfp_premium/answer/177334 Ad Manager Help Center}.
|
|
@@ -21,11 +21,11 @@ export declare class ApproveOrders implements OrderAction {
|
|
|
21
21
|
}
|
|
22
22
|
/**
|
|
23
23
|
* The action used for approving
|
|
24
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
25
|
-
* All {@link https://developers.google.com/ad-manager/api/reference/
|
|
24
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.Order Order} objects.
|
|
25
|
+
* All {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem LineItem}
|
|
26
26
|
* objects within the order will be approved as well.
|
|
27
27
|
* This action does not make any changes to the
|
|
28
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
28
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem#reservationStatus LineItem.reservationStatus}
|
|
29
29
|
* of the line items within the order.
|
|
30
30
|
* If there are reservable line items that have not been reserved the operation will not succeed.
|
|
31
31
|
*/
|
|
@@ -49,30 +49,30 @@ export declare class DeleteOrders implements OrderAction {
|
|
|
49
49
|
}
|
|
50
50
|
/**
|
|
51
51
|
* The action used for disapproving Order objects.
|
|
52
|
-
* All {@link https://developers.google.com/ad-manager/api/reference/
|
|
52
|
+
* All {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem LineItem} objects within the order will be disapproved as well.
|
|
53
53
|
*/
|
|
54
54
|
export declare class DisapproveOrders implements OrderAction {
|
|
55
55
|
buildAttributes(): object;
|
|
56
56
|
}
|
|
57
57
|
/**
|
|
58
58
|
* The action used for disapproving Order objects.
|
|
59
|
-
* All {@link https://developers.google.com/ad-manager/api/reference/
|
|
59
|
+
* All {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem LineItem} objects within the order will be disapproved as well.
|
|
60
60
|
* This action does not make any changes to the
|
|
61
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
61
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem#reservationStatus LineItem.reservationStatus}
|
|
62
62
|
* of the line items within the order.
|
|
63
63
|
*/
|
|
64
64
|
export declare class DisapproveOrdersWithoutReservationChanges implements OrderAction {
|
|
65
65
|
buildAttributes(): object;
|
|
66
66
|
}
|
|
67
67
|
/**
|
|
68
|
-
* The action used for pausing all {@link https://developers.google.com/ad-manager/api/reference/
|
|
68
|
+
* The action used for pausing all {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem LineItem} objects within an order.
|
|
69
69
|
*/
|
|
70
70
|
export declare class PauseOrders implements OrderAction {
|
|
71
71
|
buildAttributes(): object;
|
|
72
72
|
}
|
|
73
73
|
/**
|
|
74
74
|
* The action used for resuming Order objects.
|
|
75
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
75
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem LineItem} objects within the order that are legible to resume will resume as well.
|
|
76
76
|
*/
|
|
77
77
|
export declare class ResumeOrders implements OrderAction {
|
|
78
78
|
buildAttributes(): object;
|
|
@@ -86,7 +86,7 @@ export declare class RetractOrders implements OrderAction {
|
|
|
86
86
|
/**
|
|
87
87
|
* The action used for retracting Order objects.
|
|
88
88
|
* This action does not make any changes to the
|
|
89
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
89
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem#reservationStatus LineItem.reservationStatus} of the line items within the order.
|
|
90
90
|
*/
|
|
91
91
|
export declare class RetractOrdersWithoutReservationChanges implements OrderAction {
|
|
92
92
|
buildAttributes(): object;
|
|
@@ -99,7 +99,7 @@ export declare class SubmitOrdersForApproval implements OrderAction {
|
|
|
99
99
|
}
|
|
100
100
|
/**
|
|
101
101
|
* The action used for submitting Order objects for approval.
|
|
102
|
-
* This action does not make any changes to the {@link https://developers.google.com/ad-manager/api/reference/
|
|
102
|
+
* This action does not make any changes to the {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem#reservationStatus LineItem.reservationStatus}
|
|
103
103
|
* of the line items within the order.
|
|
104
104
|
*/
|
|
105
105
|
export declare class SubmitOrdersForApprovalWithoutReservationChanges implements OrderAction {
|
|
@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.UnarchiveOrders = exports.SubmitOrdersForApprovalWithoutReservationChanges = exports.SubmitOrdersForApproval = exports.RetractOrdersWithoutReservationChanges = exports.RetractOrders = exports.ResumeOrders = exports.PauseOrders = exports.DisapproveOrdersWithoutReservationChanges = exports.DisapproveOrders = exports.DeleteOrders = exports.ArchiveOrders = exports.ApproveOrdersWithoutReservationChanges = exports.ApproveOrders = exports.OrderAction = 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/OrderService.Order Order} objects.
|
|
7
7
|
*/
|
|
8
8
|
class OrderAction {
|
|
9
9
|
buildAttributes() {
|
|
@@ -13,8 +13,8 @@ class OrderAction {
|
|
|
13
13
|
exports.OrderAction = OrderAction;
|
|
14
14
|
/**
|
|
15
15
|
* The action used for approving
|
|
16
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
17
|
-
* All {@link https://developers.google.com/ad-manager/api/reference/
|
|
16
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.Order Order} objects.
|
|
17
|
+
* All {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem LineItem}
|
|
18
18
|
* objects within the order will be approved as well.
|
|
19
19
|
* For more information on what happens to an order and its line items when it is approved,
|
|
20
20
|
* see the {@link https://support.google.com/dfp_premium/answer/177334 Ad Manager Help Center}.
|
|
@@ -36,11 +36,11 @@ class ApproveOrders {
|
|
|
36
36
|
exports.ApproveOrders = ApproveOrders;
|
|
37
37
|
/**
|
|
38
38
|
* The action used for approving
|
|
39
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
40
|
-
* All {@link https://developers.google.com/ad-manager/api/reference/
|
|
39
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.Order Order} objects.
|
|
40
|
+
* All {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem LineItem}
|
|
41
41
|
* objects within the order will be approved as well.
|
|
42
42
|
* This action does not make any changes to the
|
|
43
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
43
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem#reservationStatus LineItem.reservationStatus}
|
|
44
44
|
* of the line items within the order.
|
|
45
45
|
* If there are reservable line items that have not been reserved the operation will not succeed.
|
|
46
46
|
*/
|
|
@@ -73,7 +73,7 @@ class DeleteOrders {
|
|
|
73
73
|
exports.DeleteOrders = DeleteOrders;
|
|
74
74
|
/**
|
|
75
75
|
* The action used for disapproving Order objects.
|
|
76
|
-
* All {@link https://developers.google.com/ad-manager/api/reference/
|
|
76
|
+
* All {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem LineItem} objects within the order will be disapproved as well.
|
|
77
77
|
*/
|
|
78
78
|
class DisapproveOrders {
|
|
79
79
|
buildAttributes() {
|
|
@@ -83,9 +83,9 @@ class DisapproveOrders {
|
|
|
83
83
|
exports.DisapproveOrders = DisapproveOrders;
|
|
84
84
|
/**
|
|
85
85
|
* The action used for disapproving Order objects.
|
|
86
|
-
* All {@link https://developers.google.com/ad-manager/api/reference/
|
|
86
|
+
* All {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem LineItem} objects within the order will be disapproved as well.
|
|
87
87
|
* This action does not make any changes to the
|
|
88
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
88
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem#reservationStatus LineItem.reservationStatus}
|
|
89
89
|
* of the line items within the order.
|
|
90
90
|
*/
|
|
91
91
|
class DisapproveOrdersWithoutReservationChanges {
|
|
@@ -95,7 +95,7 @@ class DisapproveOrdersWithoutReservationChanges {
|
|
|
95
95
|
}
|
|
96
96
|
exports.DisapproveOrdersWithoutReservationChanges = DisapproveOrdersWithoutReservationChanges;
|
|
97
97
|
/**
|
|
98
|
-
* The action used for pausing all {@link https://developers.google.com/ad-manager/api/reference/
|
|
98
|
+
* The action used for pausing all {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem LineItem} objects within an order.
|
|
99
99
|
*/
|
|
100
100
|
class PauseOrders {
|
|
101
101
|
buildAttributes() {
|
|
@@ -105,7 +105,7 @@ class PauseOrders {
|
|
|
105
105
|
exports.PauseOrders = PauseOrders;
|
|
106
106
|
/**
|
|
107
107
|
* The action used for resuming Order objects.
|
|
108
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
108
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem LineItem} objects within the order that are legible to resume will resume as well.
|
|
109
109
|
*/
|
|
110
110
|
class ResumeOrders {
|
|
111
111
|
buildAttributes() {
|
|
@@ -125,7 +125,7 @@ exports.RetractOrders = RetractOrders;
|
|
|
125
125
|
/**
|
|
126
126
|
* The action used for retracting Order objects.
|
|
127
127
|
* This action does not make any changes to the
|
|
128
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
128
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem#reservationStatus LineItem.reservationStatus} of the line items within the order.
|
|
129
129
|
*/
|
|
130
130
|
class RetractOrdersWithoutReservationChanges {
|
|
131
131
|
buildAttributes() {
|
|
@@ -144,7 +144,7 @@ class SubmitOrdersForApproval {
|
|
|
144
144
|
exports.SubmitOrdersForApproval = SubmitOrdersForApproval;
|
|
145
145
|
/**
|
|
146
146
|
* The action used for submitting Order objects for approval.
|
|
147
|
-
* This action does not make any changes to the {@link https://developers.google.com/ad-manager/api/reference/
|
|
147
|
+
* This action does not make any changes to the {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem#reservationStatus LineItem.reservationStatus}
|
|
148
148
|
* of the line items within the order.
|
|
149
149
|
*/
|
|
150
150
|
class SubmitOrdersForApprovalWithoutReservationChanges {
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*/
|
|
4
4
|
export declare enum OrderStatus {
|
|
5
5
|
/**
|
|
6
|
-
* Indicates that the {@link https://developers.google.com/ad-manager/api/reference/
|
|
6
|
+
* Indicates that the {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.Order Order}
|
|
7
7
|
* has just been created but no approval has been requested yet.
|
|
8
8
|
*/
|
|
9
9
|
DRAFT = "DRAFT",
|
|
@@ -12,12 +12,12 @@ export declare enum OrderStatus {
|
|
|
12
12
|
*/
|
|
13
13
|
PENDING_APPROVAL = "PENDING_APPROVAL",
|
|
14
14
|
/**
|
|
15
|
-
* Indicates that the {@link https://developers.google.com/ad-manager/api/reference/
|
|
15
|
+
* Indicates that the {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.Order Order}
|
|
16
16
|
* has been approved and is ready to serve.
|
|
17
17
|
*/
|
|
18
18
|
APPROVED = "APPROVED",
|
|
19
19
|
/**
|
|
20
|
-
* Indicates that the {@link https://developers.google.com/ad-manager/api/reference/
|
|
20
|
+
* Indicates that the {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.Order Order}
|
|
21
21
|
* has been disapproved and is not eligible to serve.
|
|
22
22
|
*/
|
|
23
23
|
DISAPPROVED = "DISAPPROVED",
|
|
@@ -26,12 +26,12 @@ export declare enum OrderStatus {
|
|
|
26
26
|
*/
|
|
27
27
|
PAUSED = "PAUSED",
|
|
28
28
|
/**
|
|
29
|
-
* Indicates that the {@link https://developers.google.com/ad-manager/api/reference/
|
|
29
|
+
* Indicates that the {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.Order Order}
|
|
30
30
|
* has been canceled and cannot serve.
|
|
31
31
|
*/
|
|
32
32
|
CANCELED = "CANCELED",
|
|
33
33
|
/**
|
|
34
|
-
* Indicates that the {@link https://developers.google.com/ad-manager/api/reference/
|
|
34
|
+
* Indicates that the {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.Order Order}
|
|
35
35
|
* has been deleted by DSM.
|
|
36
36
|
*/
|
|
37
37
|
DELETED = "DELETED",
|
|
@@ -7,7 +7,7 @@ exports.OrderStatus = void 0;
|
|
|
7
7
|
var OrderStatus;
|
|
8
8
|
(function (OrderStatus) {
|
|
9
9
|
/**
|
|
10
|
-
* Indicates that the {@link https://developers.google.com/ad-manager/api/reference/
|
|
10
|
+
* Indicates that the {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.Order Order}
|
|
11
11
|
* has just been created but no approval has been requested yet.
|
|
12
12
|
*/
|
|
13
13
|
OrderStatus["DRAFT"] = "DRAFT";
|
|
@@ -16,12 +16,12 @@ var OrderStatus;
|
|
|
16
16
|
*/
|
|
17
17
|
OrderStatus["PENDING_APPROVAL"] = "PENDING_APPROVAL";
|
|
18
18
|
/**
|
|
19
|
-
* Indicates that the {@link https://developers.google.com/ad-manager/api/reference/
|
|
19
|
+
* Indicates that the {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.Order Order}
|
|
20
20
|
* has been approved and is ready to serve.
|
|
21
21
|
*/
|
|
22
22
|
OrderStatus["APPROVED"] = "APPROVED";
|
|
23
23
|
/**
|
|
24
|
-
* Indicates that the {@link https://developers.google.com/ad-manager/api/reference/
|
|
24
|
+
* Indicates that the {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.Order Order}
|
|
25
25
|
* has been disapproved and is not eligible to serve.
|
|
26
26
|
*/
|
|
27
27
|
OrderStatus["DISAPPROVED"] = "DISAPPROVED";
|
|
@@ -30,12 +30,12 @@ var OrderStatus;
|
|
|
30
30
|
*/
|
|
31
31
|
OrderStatus["PAUSED"] = "PAUSED";
|
|
32
32
|
/**
|
|
33
|
-
* Indicates that the {@link https://developers.google.com/ad-manager/api/reference/
|
|
33
|
+
* Indicates that the {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.Order Order}
|
|
34
34
|
* has been canceled and cannot serve.
|
|
35
35
|
*/
|
|
36
36
|
OrderStatus["CANCELED"] = "CANCELED";
|
|
37
37
|
/**
|
|
38
|
-
* Indicates that the {@link https://developers.google.com/ad-manager/api/reference/
|
|
38
|
+
* Indicates that the {@link https://developers.google.com/ad-manager/api/reference/latest/OrderService.Order Order}
|
|
39
39
|
* has been deleted by DSM.
|
|
40
40
|
*/
|
|
41
41
|
OrderStatus["DELETED"] = "DELETED";
|