@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,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
|
|
@@ -2,7 +2,7 @@ import type { Statement, UpdateResult } from "../../../common/types";
|
|
|
2
2
|
import type { ProposalLineItemAction } from "./proposalLineItem.action";
|
|
3
3
|
import type { ProposalLineItem, ProposalLineItemMakegoodInfo, ProposalLineItemPage } from "./proposalLineItem.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/ProposalLineItemService.ProposalLineItem ProposalLineItem} objects.
|
|
6
6
|
*/
|
|
7
7
|
export interface ProposalLineItemServiceOperations {
|
|
8
8
|
/**
|
|
@@ -12,35 +12,35 @@ export interface ProposalLineItemServiceOperations {
|
|
|
12
12
|
*/
|
|
13
13
|
createMakegoods(makegoodInfos: Partial<ProposalLineItemMakegoodInfo>[]): Promise<ProposalLineItem[]>;
|
|
14
14
|
/**
|
|
15
|
-
* Creates new {@link https://developers.google.com/ad-manager/api/reference/
|
|
15
|
+
* Creates new {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.ProposalLineItem ProposalLineItem} objects.
|
|
16
16
|
*
|
|
17
17
|
* @param proposalLineItems the proposal line items to create
|
|
18
18
|
* @returns the created proposal line items with their IDs filled in
|
|
19
19
|
*/
|
|
20
20
|
createProposalLineItems(proposalLineItems: Partial<ProposalLineItem>[]): Promise<ProposalLineItem[]>;
|
|
21
21
|
/**
|
|
22
|
-
* Gets a {@link https://developers.google.com/ad-manager/api/reference/
|
|
23
|
-
* of {@link https://developers.google.com/ad-manager/api/reference/
|
|
24
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
22
|
+
* Gets a {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.ProposalLineItemPage ProposalLineItemPage}
|
|
23
|
+
* of {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.ProposalLineItem ProposalLineItem} objects that satisfy the given
|
|
24
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.Statement#query Statement.query}.
|
|
25
25
|
* The following fields are supported for filtering:
|
|
26
26
|
*
|
|
27
27
|
* | PQL Property | PQL Property |
|
|
28
28
|
* | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
29
|
-
* | id | {@link https://developers.google.com/ad-manager/api/reference/
|
|
30
|
-
* | name | {@link https://developers.google.com/ad-manager/api/reference/
|
|
31
|
-
* | proposalId | {@link https://developers.google.com/ad-manager/api/reference/
|
|
32
|
-
* | startDateTime | {@link https://developers.google.com/ad-manager/api/reference/
|
|
33
|
-
* | endDateTime | {@link https://developers.google.com/ad-manager/api/reference/
|
|
34
|
-
* | isArchived | {@link https://developers.google.com/ad-manager/api/reference/
|
|
35
|
-
* | lastModifiedDateTime | {@link https://developers.google.com/ad-manager/api/reference/
|
|
36
|
-
* | isProgrammatic | {@link https://developers.google.com/ad-manager/api/reference/
|
|
29
|
+
* | id | {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.ProposalLineItem#id ProposalLineItem.id} |
|
|
30
|
+
* | name | {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.ProposalLineItem#name ProposalLineItem.name} |
|
|
31
|
+
* | proposalId | {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.ProposalLineItem#proposalId ProposalLineItem.proposalId} |
|
|
32
|
+
* | startDateTime | {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.ProposalLineItem#startDateTime ProposalLineItem.startDateTime} |
|
|
33
|
+
* | endDateTime | {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.ProposalLineItem#endDateTime ProposalLineItem.endDateTime} |
|
|
34
|
+
* | isArchived | {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.ProposalLineItem#isArchived ProposalLineItem.isArchived} |
|
|
35
|
+
* | lastModifiedDateTime | {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.ProposalLineItem#lastModifiedDateTime ProposalLineItem.lastModifiedDateTime} |
|
|
36
|
+
* | isProgrammatic | {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.ProposalLineItem#isProgrammatic ProposalLineItem.isProgrammatic} |
|
|
37
37
|
*
|
|
38
38
|
* @param filterStatement a Publisher Query Language statement used to filter a set of proposal line items
|
|
39
39
|
* @returns the proposal line items that match the given filter
|
|
40
40
|
*/
|
|
41
41
|
getProposalLineItemsByStatement(filterStatement: Statement): Promise<ProposalLineItemPage>;
|
|
42
42
|
/**
|
|
43
|
-
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/
|
|
43
|
+
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.ProposalLineItem ProposalLineItem} objects that match the given Statement.
|
|
44
44
|
*
|
|
45
45
|
* @param ProposalLineItemAction the action to perform
|
|
46
46
|
* @param filterStatement a PQL statement used to filter proposal line items
|
|
@@ -48,7 +48,7 @@ export interface ProposalLineItemServiceOperations {
|
|
|
48
48
|
*/
|
|
49
49
|
performProposalLineItemAction(proposalLineItemAction: ProposalLineItemAction, filterStatement: Statement): Promise<UpdateResult>;
|
|
50
50
|
/**
|
|
51
|
-
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/
|
|
51
|
+
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/latest/ProposalLineItemService.ProposalLineItem ProposalLineItem} objects.
|
|
52
52
|
*
|
|
53
53
|
* @param proposalLineItems the proposal line items to update
|
|
54
54
|
* @returns the updated proposal line items
|
package/dist/client/services/publisherQueryLanguage/publisherQueryLanguageService.interface.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import type { Statement } from "../../../common/types";
|
|
2
2
|
import type { ResultSet } from "./publisherQueryLanguage.type";
|
|
3
3
|
/**
|
|
4
|
-
* Provides methods for executing a PQL {@link https://developers.google.com/ad-manager/api/reference/
|
|
4
|
+
* Provides methods for executing a PQL {@link https://developers.google.com/ad-manager/api/reference/latest/PublisherQueryLanguageService.Statement Statement}
|
|
5
5
|
* to retrieve information from the system. In order to support the selection of columns of interest from various tables,
|
|
6
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
6
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/PublisherQueryLanguageService.Statement Statement} objects support a "select" clause.
|
|
7
7
|
*
|
|
8
8
|
* An example query text might be **`"select CountryCode, Name from Geo_Target"`**, where **`CountryCode`** and **`Name`** are columns of interest and **`Geo_Target`** is the table.
|
|
9
9
|
*
|
|
@@ -12,7 +12,7 @@ import type { ResultSet } from "./publisherQueryLanguage.type";
|
|
|
12
12
|
export interface PublisherQueryLanguageServiceOperations {
|
|
13
13
|
/**
|
|
14
14
|
* Retrieves rows of data that satisfy the given
|
|
15
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
15
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/PublisherQueryLanguageService.Statement#query Statement.query} from the system.
|
|
16
16
|
*
|
|
17
17
|
* @param selectStatement a Publisher Query Language statement used to specify what data needs to returned
|
|
18
18
|
* @returns a result set of data that matches the given filter
|
|
@@ -2,7 +2,7 @@ import type { Date, PageResult, Statement } from "../../../common/types";
|
|
|
2
2
|
import type { Column, DateRangeType, Dimension, DimensionAttribute, ExportFormat, ReportQueryAdUnitView, TimeZoneType } from "./report.enum";
|
|
3
3
|
/**
|
|
4
4
|
* Represents the options for an API report download request.
|
|
5
|
-
* See {@link https://developers.google.com/ad-manager/api/reference/
|
|
5
|
+
* See {@link https://developers.google.com/ad-manager/api/reference/latest/ReportService#getReportDownloadUrlWithOptions ReportService.getReportDownloadUrlWithOptions}.
|
|
6
6
|
*/
|
|
7
7
|
export type ReportDownloadOptions = {
|
|
8
8
|
/**
|
|
@@ -129,7 +129,7 @@ export type SavedQuery = {
|
|
|
129
129
|
reportQuery: ReportQuery;
|
|
130
130
|
};
|
|
131
131
|
/**
|
|
132
|
-
* A page of {@link https://developers.google.com/ad-manager/api/reference/
|
|
132
|
+
* A page of {@link https://developers.google.com/ad-manager/api/reference/latest/ReportService.SavedQuery SavedQuery} objects.
|
|
133
133
|
*/
|
|
134
134
|
export type SavedQueryPage = PageResult<SavedQuery>;
|
|
135
135
|
//# sourceMappingURL=report.type.d.ts.map
|
|
@@ -2,21 +2,21 @@ import type { Statement } from "../../../common/types";
|
|
|
2
2
|
import type { ExportFormat, ReportJobStatus } from "./report.enum";
|
|
3
3
|
import type { ReportDownloadOptions, ReportJob, SavedQueryPage } from "./report.type";
|
|
4
4
|
/**
|
|
5
|
-
* Provides methods for executing a {@link https://developers.google.com/ad-manager/api/reference/
|
|
5
|
+
* Provides methods for executing a {@link https://developers.google.com/ad-manager/api/reference/latest/ReportService.ReportJob ReportJob}
|
|
6
6
|
* and retrieving performance and statistics about ad campaigns, networks, inventory and sales.
|
|
7
7
|
*
|
|
8
8
|
* Follow the steps outlined below:
|
|
9
9
|
*
|
|
10
|
-
* - Create the ReportJob object by invoking {@link https://developers.google.com/ad-manager/api/reference/
|
|
11
|
-
* - Poll the report job status using {@link https://developers.google.com/ad-manager/api/reference/
|
|
10
|
+
* - Create the ReportJob object by invoking {@link https://developers.google.com/ad-manager/api/reference/latest/ReportService#runReportJob ReportService.runReportJob}.
|
|
11
|
+
* - Poll the report job status using {@link https://developers.google.com/ad-manager/api/reference/latest/ReportService#getReportJobStatus ReportService.getReportJobStatus}.
|
|
12
12
|
* - Continue to poll until the status is equal to
|
|
13
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
14
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
15
|
-
* - If successful, fetch the URL for downloading the report by invoking {@link https://developers.google.com/ad-manager/api/reference/
|
|
13
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ReportService.ReportJobStatus#COMPLETED ReportJobStatus.COMPLETED} or
|
|
14
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ReportService.ReportJobStatus#FAILED ReportJobStatus.FAILED}.
|
|
15
|
+
* - If successful, fetch the URL for downloading the report by invoking {@link https://developers.google.com/ad-manager/api/reference/latest/ReportService#getReportDownloadURL ReportService.getReportDownloadURL}.
|
|
16
16
|
*
|
|
17
17
|
* **Test network behavior**
|
|
18
18
|
*
|
|
19
|
-
* The networks created using {@link https://developers.google.com/ad-manager/api/reference/
|
|
19
|
+
* The networks created using {@link https://developers.google.com/ad-manager/api/reference/latest/NetworkService#makeTestNetwork NetworkService.makeTestNetwork}
|
|
20
20
|
* are unable to provide reports that would be comparable to the production environment because reports require traffic history.
|
|
21
21
|
* In the test networks, reports will consistently return no data for all reports.
|
|
22
22
|
*/
|
|
@@ -34,7 +34,7 @@ export interface ReportServiceOperations {
|
|
|
34
34
|
/**
|
|
35
35
|
* Returns the URL at which the report file can be downloaded, and allows for customization of the downloaded report.
|
|
36
36
|
* By default, the report will be generated as a gzip archive, containing the report file itself. This can be changed by setting
|
|
37
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
37
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ReportService.ReportDownloadOptions#useGzipCompression ReportDownloadOptions.useGzipCompression} to false.
|
|
38
38
|
*
|
|
39
39
|
* @param reportJobId the ID of the ReportJob
|
|
40
40
|
* @param reportDownloadOptions the ReportDownloadOptions for the request
|
|
@@ -50,28 +50,28 @@ export interface ReportServiceOperations {
|
|
|
50
50
|
getReportJobStatus(reportJobId: number): Promise<ReportJobStatus>;
|
|
51
51
|
/**
|
|
52
52
|
* Retrieves a page of the saved queries either created by or shared with the current user.
|
|
53
|
-
* Each {@link https://developers.google.com/ad-manager/api/reference/
|
|
53
|
+
* Each {@link https://developers.google.com/ad-manager/api/reference/latest/ReportService.SavedQuery SavedQuery} in the page,
|
|
54
54
|
* if it is compatible with the current API version,
|
|
55
|
-
* will contain a {@link https://developers.google.com/ad-manager/api/reference/
|
|
56
|
-
* object which can be optionally modified and used to create a {@link https://developers.google.com/ad-manager/api/reference/
|
|
57
|
-
* This can then be passed to {@link https://developers.google.com/ad-manager/api/reference/
|
|
55
|
+
* will contain a {@link https://developers.google.com/ad-manager/api/reference/latest/ReportService.ReportQuery ReportQuery}
|
|
56
|
+
* object which can be optionally modified and used to create a {@link https://developers.google.com/ad-manager/api/reference/latest/ReportService.ReportJob ReportJob}.
|
|
57
|
+
* This can then be passed to {@link https://developers.google.com/ad-manager/api/reference/latest/ReportService#runReportJob ReportService.runReportJob}.
|
|
58
58
|
* The following fields are supported for filtering:
|
|
59
59
|
*
|
|
60
60
|
* | PQL Property | Object Property
|
|
61
61
|
* | ------------ | --------------------------------------------------
|
|
62
|
-
* | id | {@link https://developers.google.com/ad-manager/api/reference/
|
|
63
|
-
* | name | {@link https://developers.google.com/ad-manager/api/reference/
|
|
62
|
+
* | id | {@link https://developers.google.com/ad-manager/api/reference/latest/ReportService.SavedQuery#id SavedQuery.id}
|
|
63
|
+
* | name | {@link https://developers.google.com/ad-manager/api/reference/latest/ReportService.SavedQuery#name SavedQuery.name}
|
|
64
64
|
*
|
|
65
65
|
* @param filterStatement a Publisher Query Language statement used to filter which saved queries should be returned.
|
|
66
66
|
* @returns a SavedQueryPage that contains all SavedQuery instances which satisfy the given statement.
|
|
67
67
|
*/
|
|
68
68
|
getSavedQueriesByStatement(filterStatement: Statement): Promise<SavedQueryPage>;
|
|
69
69
|
/**
|
|
70
|
-
* Initiates the execution of a {@link https://developers.google.com/ad-manager/api/reference/
|
|
70
|
+
* Initiates the execution of a {@link https://developers.google.com/ad-manager/api/reference/latest/ReportService.ReportQuery ReportQuery} on the server.
|
|
71
71
|
*
|
|
72
72
|
* The following fields are required:
|
|
73
73
|
*
|
|
74
|
-
* - {@link https://developers.google.com/ad-manager/api/reference/
|
|
74
|
+
* - {@link https://developers.google.com/ad-manager/api/reference/latest/ReportService.ReportJob#reportQuery ReportJob.reportQuery }
|
|
75
75
|
*
|
|
76
76
|
* @param reportJob the report job to run
|
|
77
77
|
* @returns the report job with its ID filled in
|
|
@@ -3,33 +3,33 @@ import type { SiteAction } from "./site.action";
|
|
|
3
3
|
import type { Site, SitePage } from "./site.type";
|
|
4
4
|
export interface SiteServiceOperations {
|
|
5
5
|
/**
|
|
6
|
-
* Creates new {@link https://developers.google.com/ad-manager/api/reference/
|
|
6
|
+
* Creates new {@link https://developers.google.com/ad-manager/api/reference/latest/SiteService.Site Site} objects.
|
|
7
7
|
*
|
|
8
8
|
* @param sites the sites to create
|
|
9
9
|
* @returns the created sites with their IDs filled in
|
|
10
10
|
*/
|
|
11
11
|
createSites(sites: Partial<Site>[]): Promise<Site[]>;
|
|
12
12
|
/**
|
|
13
|
-
* Gets a {@link https://developers.google.com/ad-manager/api/reference/
|
|
14
|
-
* of {@link https://developers.google.com/ad-manager/api/reference/
|
|
15
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
13
|
+
* Gets a {@link https://developers.google.com/ad-manager/api/reference/latest/SiteService.SitePage SitePage}
|
|
14
|
+
* of {@link https://developers.google.com/ad-manager/api/reference/latest/SiteService.Site Site} objects that satisfy the given
|
|
15
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/SiteService.Statement#query Statement.query}.
|
|
16
16
|
* The following fields are supported for filtering:
|
|
17
17
|
*
|
|
18
18
|
* | PQL Property | PQL Property |
|
|
19
19
|
* | ---------------- | ------------------------------------------------------------------------------------------------------------------------------ |
|
|
20
|
-
* | id | {@link https://developers.google.com/ad-manager/api/reference/
|
|
21
|
-
* | url | {@link https://developers.google.com/ad-manager/api/reference/
|
|
22
|
-
* | childNetworkCode | {@link https://developers.google.com/ad-manager/api/reference/
|
|
23
|
-
* | approvalStatus | {@link https://developers.google.com/ad-manager/api/reference/
|
|
24
|
-
* | active | {@link https://developers.google.com/ad-manager/api/reference/
|
|
20
|
+
* | id | {@link https://developers.google.com/ad-manager/api/reference/latest/SiteService.Site#id Site.id} |
|
|
21
|
+
* | url | {@link https://developers.google.com/ad-manager/api/reference/latest/SiteService.Site#url Site.url} |
|
|
22
|
+
* | childNetworkCode | {@link https://developers.google.com/ad-manager/api/reference/latest/SiteService.Site#childNetworkCode Site.childNetworkCode} |
|
|
23
|
+
* | approvalStatus | {@link https://developers.google.com/ad-manager/api/reference/latest/SiteService.Site#approvalStatus Site.approvalStatus} |
|
|
24
|
+
* | active | {@link https://developers.google.com/ad-manager/api/reference/latest/SiteService.Site#active Site.active} |
|
|
25
25
|
*
|
|
26
26
|
* @param filterStatement a Publisher Query Language statement used to filter a set of sites
|
|
27
27
|
* @returns the sites that match the given filter
|
|
28
28
|
*/
|
|
29
29
|
getSitesByStatement(filterStatement: Statement): Promise<SitePage>;
|
|
30
30
|
/**
|
|
31
|
-
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/
|
|
32
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
31
|
+
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/latest/SiteService.Site Site} objects that match the given
|
|
32
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/SiteService.Statement#query Statement.query}.
|
|
33
33
|
*
|
|
34
34
|
* @param siteAction the action to perform
|
|
35
35
|
* @param filterStatement a PQL statement used to filter sites
|
|
@@ -37,9 +37,9 @@ export interface SiteServiceOperations {
|
|
|
37
37
|
*/
|
|
38
38
|
performSiteAction(siteAction: SiteAction, filterStatement: Statement): Promise<UpdateResult>;
|
|
39
39
|
/**
|
|
40
|
-
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/
|
|
40
|
+
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/latest/SiteService.Site Site} objects.
|
|
41
41
|
*
|
|
42
|
-
* The {@link https://developers.google.com/ad-manager/api/reference/
|
|
42
|
+
* The {@link https://developers.google.com/ad-manager/api/reference/latest/SiteService.Site#childNetworkCode Site.childNetworkCode} can be updated in order to 1) change the child network, 2) move a site from O&O to represented, or 3) move a site from represented to O&O.
|
|
43
43
|
*
|
|
44
44
|
* @param sites the sites to update
|
|
45
45
|
* @returns the updated sites
|
|
@@ -1,10 +1,10 @@
|
|
|
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/SuggestedAdUnitService.SuggestedAdUnit SuggestedAdUnit} objects.
|
|
3
3
|
*/
|
|
4
4
|
export declare abstract class SuggestedAdUnitAction {
|
|
5
5
|
}
|
|
6
6
|
/**
|
|
7
|
-
* Action to approve {@link https://developers.google.com/ad-manager/api/reference/
|
|
7
|
+
* Action to approve {@link https://developers.google.com/ad-manager/api/reference/latest/SuggestedAdUnitService.SuggestedAdUnit SuggestedAdUnit} objects.
|
|
8
8
|
*/
|
|
9
9
|
export declare class ApproveSuggestedAdUnits implements SuggestedAdUnitAction {
|
|
10
10
|
}
|
|
@@ -2,13 +2,13 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.ApproveSuggestedAdUnits = exports.SuggestedAdUnitAction = 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/SuggestedAdUnitService.SuggestedAdUnit SuggestedAdUnit} objects.
|
|
6
6
|
*/
|
|
7
7
|
class SuggestedAdUnitAction {
|
|
8
8
|
}
|
|
9
9
|
exports.SuggestedAdUnitAction = SuggestedAdUnitAction;
|
|
10
10
|
/**
|
|
11
|
-
* Action to approve {@link https://developers.google.com/ad-manager/api/reference/
|
|
11
|
+
* Action to approve {@link https://developers.google.com/ad-manager/api/reference/latest/SuggestedAdUnitService.SuggestedAdUnit SuggestedAdUnit} objects.
|
|
12
12
|
*/
|
|
13
13
|
class ApproveSuggestedAdUnits {
|
|
14
14
|
}
|
|
@@ -39,12 +39,12 @@ export type SuggestedAdUnit = {
|
|
|
39
39
|
suggestedAdUnitSizes: AdUnitSize[];
|
|
40
40
|
};
|
|
41
41
|
/**
|
|
42
|
-
* Contains a page of {@link https://developers.google.com/ad-manager/api/reference/
|
|
42
|
+
* Contains a page of {@link https://developers.google.com/ad-manager/api/reference/latest/SuggestedAdUnitService.SuggestedAdUnit SuggestedAdUnit} objects.
|
|
43
43
|
*/
|
|
44
44
|
export type SuggestedAdUnitPage = PageResult<SuggestedAdUnit>;
|
|
45
45
|
/**
|
|
46
46
|
* Represents the result of performing an action on
|
|
47
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
47
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/SuggestedAdUnitService.SuggestedAdUnit SuggestedAdUnit} objects.
|
|
48
48
|
*/
|
|
49
49
|
export type SuggestedAdUnitUpdateResult = {
|
|
50
50
|
/**
|