@guardian/google-admanager-api 6.0.3 → 6.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +17 -0
- package/dist/client/common/enums/delivery.enum.d.ts +1 -1
- package/dist/client/common/enums/delivery.enum.js +1 -1
- package/dist/client/common/enums/general.enum.d.ts +7 -7
- package/dist/client/common/enums/general.enum.js +7 -7
- package/dist/client/common/enums/lineItemSummary.enum.d.ts +4 -4
- package/dist/client/common/enums/lineItemSummary.enum.js +4 -4
- package/dist/client/common/types/general.type.d.ts +21 -21
- package/dist/client/common/types/label.type.d.ts +2 -2
- package/dist/client/common/types/lineItemSummary.type.d.ts +7 -7
- package/dist/client/common/types/targeting.type.d.ts +77 -42
- package/dist/client/common/types/targeting.type.d.ts.map +1 -1
- package/dist/client/common/types/targeting.type.js +48 -19
- package/dist/client/common/types/targeting.type.js.map +1 -1
- package/dist/client/services/activity/activity.type.d.ts +4 -4
- package/dist/client/services/activity/activityService.interface.d.ts +12 -12
- package/dist/client/services/activityGroup/activityGroup.type.d.ts +4 -4
- package/dist/client/services/activityGroup/activityGroupService.interface.d.ts +11 -11
- package/dist/client/services/adRule/adRule.type.d.ts +2 -2
- package/dist/client/services/adRule/adSpot.type.d.ts +1 -1
- package/dist/client/services/adjustment/adjustment.enum.d.ts +1 -1
- package/dist/client/services/adjustment/adjustment.enum.js +1 -1
- package/dist/client/services/adjustment/adjustment.type.d.ts +1 -1
- package/dist/client/services/adjustment/adjustmentService.interface.d.ts +23 -23
- package/dist/client/services/audienceSegment/audienceSegment.action.d.ts +6 -6
- package/dist/client/services/audienceSegment/audienceSegment.action.js +6 -6
- package/dist/client/services/audienceSegment/audienceSegment.enum.d.ts +4 -4
- package/dist/client/services/audienceSegment/audienceSegment.enum.js +4 -4
- package/dist/client/services/audienceSegment/audienceSegment.type.d.ts +14 -14
- package/dist/client/services/audienceSegment/audienceSegmentService.interface.d.ts +17 -17
- package/dist/client/services/cdnConfiguration/cdnConfiguration.action.d.ts +3 -3
- package/dist/client/services/cdnConfiguration/cdnConfiguration.action.js +3 -3
- package/dist/client/services/cdnConfiguration/cdnConfiguration.enum.d.ts +3 -3
- package/dist/client/services/cdnConfiguration/cdnConfiguration.enum.js +3 -3
- package/dist/client/services/cdnConfiguration/cdnConfiguration.interface.d.ts +11 -11
- package/dist/client/services/cdnConfiguration/cdnConfiguration.type.d.ts +1 -1
- package/dist/client/services/cmsMetadata/cmsMetadata.action.d.ts +6 -6
- package/dist/client/services/cmsMetadata/cmsMetadata.action.js +6 -6
- package/dist/client/services/cmsMetadata/cmsMetadataService.interface.d.ts +16 -16
- package/dist/client/services/company/company.type.d.ts +3 -3
- package/dist/client/services/company/companyService.interface.d.ts +11 -11
- package/dist/client/services/contact/contact.type.d.ts +2 -2
- package/dist/client/services/contact/contactService.interface.d.ts +15 -15
- package/dist/client/services/content/content.enum.d.ts +2 -2
- package/dist/client/services/content/content.enum.js +2 -2
- package/dist/client/services/content/content.type.d.ts +1 -1
- package/dist/client/services/content/contentService.interface.d.ts +15 -15
- package/dist/client/services/contentBundle/contentBundle.action.d.ts +3 -3
- package/dist/client/services/contentBundle/contentBundle.action.js +3 -3
- package/dist/client/services/contentBundle/contentBundle.type.d.ts +2 -2
- package/dist/client/services/contentBundle/contentBundleService.interface.d.ts +10 -10
- package/dist/client/services/creative/creative.action.d.ts +3 -3
- package/dist/client/services/creative/creative.action.js +3 -3
- package/dist/client/services/creative/creative.type.d.ts +1 -1
- package/dist/client/services/creative/creativeService.interface.d.ts +15 -15
- package/dist/client/services/creativeReview/creativeReviewService.interface.d.ts +4 -4
- package/dist/client/services/creativeSet/creativeSet.type.d.ts +1 -1
- package/dist/client/services/creativeSet/creativeSetService.interface.d.ts +10 -10
- package/dist/client/services/creativeTemplate/creativeTemplate.type.d.ts +1 -1
- package/dist/client/services/creativeTemplate/creativeTemplateService.interface.d.ts +8 -8
- package/dist/client/services/creativeWrapper/creativeWrapper.action.d.ts +3 -3
- package/dist/client/services/creativeWrapper/creativeWrapper.action.js +3 -3
- package/dist/client/services/creativeWrapper/creativeWrapper.type.d.ts +1 -1
- package/dist/client/services/creativeWrapper/creativeWrapperService.interface.d.ts +15 -15
- package/dist/client/services/customField/customField.action.d.ts +3 -3
- package/dist/client/services/customField/customField.action.js +3 -3
- package/dist/client/services/customField/customField.enum.d.ts +1 -1
- package/dist/client/services/customField/customField.enum.js +1 -1
- package/dist/client/services/customField/customField.type.d.ts +3 -3
- package/dist/client/services/customField/customFieldService.interface.d.ts +22 -22
- package/dist/client/services/customTargeting/customTargeting.action.d.ts +6 -6
- package/dist/client/services/customTargeting/customTargeting.action.js +6 -6
- package/dist/client/services/customTargeting/customTargeting.enum.d.ts +1 -1
- package/dist/client/services/customTargeting/customTargeting.enum.js +1 -1
- package/dist/client/services/customTargeting/customTargeting.interface.d.ts +29 -29
- package/dist/client/services/customTargeting/customTargeting.type.d.ts +2 -2
- package/dist/client/services/daiAuthenticationKey/daiAuthenticationKey.action.d.ts +3 -3
- package/dist/client/services/daiAuthenticationKey/daiAuthenticationKey.action.js +3 -3
- package/dist/client/services/daiAuthenticationKey/daiAuthenticationKey.type.d.ts +1 -1
- package/dist/client/services/daiAuthenticationKey/daiAuthenticationKeyService.interface.d.ts +13 -13
- package/dist/client/services/daiEncodingProfile/daiEncodingProfile.action.d.ts +3 -3
- package/dist/client/services/daiEncodingProfile/daiEncodingProfile.action.js +3 -3
- package/dist/client/services/daiEncodingProfile/daiEncodingProfile.enum.d.ts +1 -1
- package/dist/client/services/daiEncodingProfile/daiEncodingProfile.enum.js +1 -1
- package/dist/client/services/daiEncodingProfile/daiEncodingProfile.type.d.ts +2 -2
- package/dist/client/services/daiEncodingProfile/daiEncodingProfileService.interface.d.ts +11 -11
- package/dist/client/services/forecast/forecast.type.d.ts +1 -1
- package/dist/client/services/forecast/forecastService.interface.d.ts +9 -9
- package/dist/client/services/inventory/adUnit.action.d.ts +4 -4
- package/dist/client/services/inventory/adUnit.action.js +4 -4
- package/dist/client/services/inventory/adUnit.enum.d.ts +2 -2
- package/dist/client/services/inventory/adUnit.enum.js +2 -2
- package/dist/client/services/inventory/adUnit.type.d.ts +2 -2
- package/dist/client/services/inventory/inventoryService.interface.d.ts +16 -16
- package/dist/client/services/label/label.action.d.ts +3 -3
- package/dist/client/services/label/label.action.js +3 -3
- package/dist/client/services/label/label.interface.d.ts +11 -11
- package/dist/client/services/label/label.type.d.ts +1 -1
- package/dist/client/services/lineItem/lineItem.action.d.ts +9 -9
- package/dist/client/services/lineItem/lineItem.action.js +9 -9
- package/dist/client/services/lineItem/lineItem.type.d.ts +2 -2
- package/dist/client/services/lineItem/lineItemService.interface.d.ts +23 -23
- package/dist/client/services/lineItemCreativeAssociation/lineItemCreativeAssociation.action.d.ts +4 -4
- package/dist/client/services/lineItemCreativeAssociation/lineItemCreativeAssociation.action.js +4 -4
- package/dist/client/services/lineItemCreativeAssociation/lineItemCreativeAssociation.type.d.ts +6 -6
- package/dist/client/services/lineItemCreativeAssociation/lineItemCreativeAssociationService.interface.d.ts +18 -18
- package/dist/client/services/lineItemTemplate/lineItemTemplate.type.d.ts +1 -1
- package/dist/client/services/lineItemTemplate/lineItemTemplateService.interface.d.ts +5 -5
- package/dist/client/services/liveStreamEvent/liveStreamEvent.action.d.ts +7 -7
- package/dist/client/services/liveStreamEvent/liveStreamEvent.action.js +7 -7
- package/dist/client/services/liveStreamEvent/liveStreamEvent.enum.d.ts +2 -2
- package/dist/client/services/liveStreamEvent/liveStreamEvent.enum.js +2 -2
- package/dist/client/services/liveStreamEvent/liveStreamEvent.type.d.ts +1 -1
- package/dist/client/services/liveStreamEvent/liveStreamEventService.interface.d.ts +29 -29
- package/dist/client/services/mobileApplication/mobileApplication.action.d.ts +3 -3
- package/dist/client/services/mobileApplication/mobileApplication.action.js +3 -3
- package/dist/client/services/mobileApplication/mobileApplication.enum.d.ts +2 -2
- package/dist/client/services/mobileApplication/mobileApplication.enum.js +2 -2
- package/dist/client/services/mobileApplication/mobileApplication.type.d.ts +1 -1
- package/dist/client/services/mobileApplication/mobileApplicationService.interface.d.ts +12 -12
- package/dist/client/services/nativeStyle/nativeStyle.type.d.ts +1 -1
- package/dist/client/services/nativeStyle/nativeStyleService.interface.d.ts +9 -9
- package/dist/client/services/order/order.action.d.ts +13 -13
- package/dist/client/services/order/order.action.js +13 -13
- package/dist/client/services/order/order.enum.d.ts +5 -5
- package/dist/client/services/order/order.enum.js +5 -5
- package/dist/client/services/order/order.type.d.ts +13 -13
- package/dist/client/services/order/orderService.interface.d.ts +18 -18
- package/dist/client/services/placement/placement.action.d.ts +4 -4
- package/dist/client/services/placement/placement.action.js +4 -4
- package/dist/client/services/placement/placement.type.d.ts +1 -1
- package/dist/client/services/placement/placementService.interface.d.ts +13 -13
- package/dist/client/services/proposal/proposal.action.d.ts +15 -15
- package/dist/client/services/proposal/proposal.action.js +15 -15
- package/dist/client/services/proposal/proposal.enum.d.ts +1 -1
- package/dist/client/services/proposal/proposal.enum.js +1 -1
- package/dist/client/services/proposal/proposal.type.d.ts +3 -3
- package/dist/client/services/proposal/proposalService.interface.d.ts +26 -26
- package/dist/client/services/proposalLineItem/proposalLineItem.action.d.ts +10 -10
- package/dist/client/services/proposalLineItem/proposalLineItem.action.js +10 -10
- package/dist/client/services/proposalLineItem/proposalLineItem.type.d.ts +3 -3
- package/dist/client/services/proposalLineItem/proposalLineItemService.interface.d.ts +15 -15
- package/dist/client/services/publisherQueryLanguage/publisherQueryLanguageService.interface.d.ts +3 -3
- package/dist/client/services/report/report.type.d.ts +2 -2
- package/dist/client/services/report/reportService.interface.d.ts +16 -16
- package/dist/client/services/site/siteService.interface.d.ts +13 -13
- package/dist/client/services/suggestedAdUnit/suggestedAdUnit.action.d.ts +2 -2
- package/dist/client/services/suggestedAdUnit/suggestedAdUnit.action.js +2 -2
- package/dist/client/services/suggestedAdUnit/suggestedAdUnit.type.d.ts +2 -2
- package/dist/client/services/suggestedAdUnit/suggestedAdUnitService.interface.d.ts +9 -9
- package/dist/client/services/targetingPresent/targetingPresentService.interface.d.ts +5 -5
- package/dist/client/services/team/team.action.d.ts +3 -3
- package/dist/client/services/team/team.action.js +3 -3
- package/dist/client/services/team/team.type.d.ts +2 -2
- package/dist/client/services/team/teamService.interface.d.ts +12 -12
- package/dist/client/services/user/user.action.d.ts +3 -3
- package/dist/client/services/user/user.action.js +3 -3
- package/dist/client/services/user/user.type.d.ts +5 -5
- package/dist/client/services/user/userService.interface.d.ts +17 -17
- package/dist/client/services/userTeamAssociation/userTeamAssociation.action.d.ts +2 -2
- package/dist/client/services/userTeamAssociation/userTeamAssociation.action.js +2 -2
- package/dist/client/services/userTeamAssociation/userTeamAssociation.type.d.ts +5 -5
- package/dist/client/services/userTeamAssociation/userTeamAssociationService.interface.d.ts +10 -10
- package/dist/common/types/statement.type.d.ts +4 -4
- package/package.json +11 -11
|
@@ -2,13 +2,13 @@ import type { Statement, UpdateResult } from "../../../common/types";
|
|
|
2
2
|
import type { LineItemCreativeAssociationAction } from "./lineItemCreativeAssociation.action";
|
|
3
3
|
import type { CreativeNativeStylePreview, CreativePushOptions, LineItemCreativeAssociation, LineItemCreativeAssociationPage } from "./lineItemCreativeAssociation.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/LineItemCreativeAssociationService.LineItemCreativeAssociation LineItemCreativeAssociation} objects.
|
|
6
6
|
*
|
|
7
|
-
* A line item creative association (LICA) associates a {@link https://developers.google.com/ad-manager/api/reference/
|
|
8
|
-
* with a {@link https://developers.google.com/ad-manager/api/reference/
|
|
7
|
+
* A line item creative association (LICA) associates a {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeService.Creative Creative}
|
|
8
|
+
* with a {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem LineItem}.
|
|
9
9
|
* When a line item is selected to serve, the LICAs specify which creatives can appear for the ad units that are targeted by the line item.
|
|
10
10
|
* In order to be associated with a line item, the creative must have a size that exists within the attribute
|
|
11
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
11
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem#creativePlaceholders LineItem.creativePlaceholders}.
|
|
12
12
|
*
|
|
13
13
|
* Each LICA has a start and end date and time that defines when the creative should be displayed.
|
|
14
14
|
*
|
|
@@ -16,26 +16,26 @@ import type { CreativeNativeStylePreview, CreativePushOptions, LineItemCreativeA
|
|
|
16
16
|
*/
|
|
17
17
|
export interface LineItemCreativeAssociationServiceOperations {
|
|
18
18
|
/**
|
|
19
|
-
* Creates new {@link https://developers.google.com/ad-manager/api/reference/
|
|
19
|
+
* Creates new {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemCreativeAssociationService.LineItemCreativeAssociation LineItemCreativeAssociation} objects.
|
|
20
20
|
*
|
|
21
21
|
* @param lineItemCreativeAssociations the line item creative associations to create
|
|
22
22
|
* @returns the created line item creative associations with their IDs filled in
|
|
23
23
|
*/
|
|
24
24
|
createLineItemCreativeAssociations(lineItemCreativeAssociations: Partial<LineItemCreativeAssociation>[]): Promise<LineItemCreativeAssociation[]>;
|
|
25
25
|
/**
|
|
26
|
-
* Gets a {@link https://developers.google.com/ad-manager/api/reference/
|
|
27
|
-
* of {@link https://developers.google.com/ad-manager/api/reference/
|
|
28
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
26
|
+
* Gets a {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemCreativeAssociationService.LineItemCreativeAssociationPage LineItemCreativeAssociationPage}
|
|
27
|
+
* of {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemCreativeAssociationService.LineItemCreativeAssociation LineItemCreativeAssociation} objects that satisfy the given
|
|
28
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemCreativeAssociationService.Statement#query Statement.query}.
|
|
29
29
|
* The following fields are supported for filtering:
|
|
30
30
|
*
|
|
31
31
|
* | PQL Property | PQL Property |
|
|
32
32
|
* | ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
33
|
-
* | creativeId | {@link https://developers.google.com/ad-manager/api/reference/
|
|
34
|
-
* | manualCreativeRotationWeight | {@link https://developers.google.com/ad-manager/api/reference/
|
|
35
|
-
* | destinationUrl | {@link https://developers.google.com/ad-manager/api/reference/
|
|
36
|
-
* | lineItemId | {@link https://developers.google.com/ad-manager/api/reference/
|
|
37
|
-
* | status | {@link https://developers.google.com/ad-manager/api/reference/
|
|
38
|
-
* | lastModifiedDateTime | {@link https://developers.google.com/ad-manager/api/reference/
|
|
33
|
+
* | creativeId | {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemCreativeAssociationService.LineItemCreativeAssociation#creativeId LineItemCreativeAssociation.creativeId} |
|
|
34
|
+
* | manualCreativeRotationWeight | {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemCreativeAssociationService.LineItemCreativeAssociation#manualCreativeRotationWeight LineItemCreativeAssociation.manualCreativeRotationWeight} |
|
|
35
|
+
* | destinationUrl | {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemCreativeAssociationService.LineItemCreativeAssociation#destinationUrl LineItemCreativeAssociation.destinationUrl} |
|
|
36
|
+
* | lineItemId | {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemCreativeAssociationService.LineItemCreativeAssociation#lineItemId LineItemCreativeAssociation.lineItemId} |
|
|
37
|
+
* | status | {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemCreativeAssociationService.LineItemCreativeAssociation#status LineItemCreativeAssociation.status} |
|
|
38
|
+
* | lastModifiedDateTime | {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemCreativeAssociationService.LineItemCreativeAssociation#lastModifiedDateTime LineItemCreativeAssociation.lastModifiedDateTime} |
|
|
39
39
|
*
|
|
40
40
|
* @param filterStatement a Publisher Query Language statement used to filter a set of line item creative associations
|
|
41
41
|
* @returns the line item creative associations that match the given filter
|
|
@@ -65,8 +65,8 @@ export interface LineItemCreativeAssociationServiceOperations {
|
|
|
65
65
|
*/
|
|
66
66
|
getPreviewUrlsForNativeStyles(lineItemId: number, creativeId: number, siteUrl: string): Promise<CreativeNativeStylePreview[]>;
|
|
67
67
|
/**
|
|
68
|
-
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/
|
|
69
|
-
* objects that match the given {@link https://developers.google.com/ad-manager/api/reference/
|
|
68
|
+
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemCreativeAssociationService.LineItemCreativeAssociation LineItemCreativeAssociation}
|
|
69
|
+
* objects that match the given {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemCreativeAssociationService.Statement#query Statement.query}.
|
|
70
70
|
*
|
|
71
71
|
* @param LineItemCreativeAssociationAction the action to perform
|
|
72
72
|
* @param filterStatement a Publisher Query Language statement used to filter a set of line item creative associations
|
|
@@ -75,14 +75,14 @@ export interface LineItemCreativeAssociationServiceOperations {
|
|
|
75
75
|
performLineItemCreativeAssociationAction(lineItemCreativeAssociationAction: LineItemCreativeAssociationAction, filterStatement: Statement): Promise<UpdateResult>;
|
|
76
76
|
/**
|
|
77
77
|
* Pushes a creative to devices that that satisfy the given
|
|
78
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
78
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemCreativeAssociationService.Statement#query Statement.query}. *
|
|
79
79
|
*
|
|
80
80
|
* @param filterStatement a Publisher Query Language statement on the ID, Name, UserId and LinkedDeviceVisibility fields of the LinkedDevice table.
|
|
81
81
|
* @param options criteria to use to push a given creative.
|
|
82
82
|
*/
|
|
83
83
|
pushCreativeToDevices(filterStatement: Statement, options: CreativePushOptions): Promise<UpdateResult>;
|
|
84
84
|
/**
|
|
85
|
-
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/
|
|
85
|
+
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemCreativeAssociationService.LineItemCreativeAssociation LineItemCreativeAssociation} objects.
|
|
86
86
|
*
|
|
87
87
|
* @param lineItemCreativeAssociations the line item creative associations to update
|
|
88
88
|
* @returns the updated line item creative associations
|
|
@@ -46,7 +46,7 @@ export type LineItemTemplate = {
|
|
|
46
46
|
reativeRotationType: CreativeRotationType;
|
|
47
47
|
};
|
|
48
48
|
/**
|
|
49
|
-
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/
|
|
49
|
+
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemTemplateService.LineItemTemplate LineItemTemplate} objects.
|
|
50
50
|
*/
|
|
51
51
|
export type LineItemTemplatePage = PageResult<LineItemTemplate>;
|
|
52
52
|
//# sourceMappingURL=lineItemTemplate.type.d.ts.map
|
|
@@ -1,18 +1,18 @@
|
|
|
1
1
|
import type { Statement } from "../../../common/types";
|
|
2
2
|
import type { LineItemTemplatePage } from "./lineItemTemplate.type";
|
|
3
3
|
/**
|
|
4
|
-
* Provides operations for creating, updating and retrieving {@link https://developers.google.com/ad-manager/api/reference/
|
|
4
|
+
* Provides operations for creating, updating and retrieving {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemTemplateService.LineItemTemplate LineItemTemplate} objects.
|
|
5
5
|
*/
|
|
6
6
|
export interface LineItemTemplateServiceOperations {
|
|
7
7
|
/**
|
|
8
|
-
* Gets a {@link https://developers.google.com/ad-manager/api/reference/
|
|
9
|
-
* of {@link https://developers.google.com/ad-manager/api/reference/
|
|
10
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
8
|
+
* Gets a {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemTemplateService.LineItemTemplatePage LineItemTemplatePage}
|
|
9
|
+
* of {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemTemplateService.LineItemTemplate LineItemTemplate} objects that satisfy the given
|
|
10
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemTemplateService.Statement#query Statement.query}.
|
|
11
11
|
* The following fields are supported for filtering:
|
|
12
12
|
*
|
|
13
13
|
* | PQL Property | PQL Property |
|
|
14
14
|
* | ------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
|
15
|
-
* | id | {@link https://developers.google.com/ad-manager/api/reference/
|
|
15
|
+
* | id | {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemTemplateService.LineItemTemplate#id LineItemTemplate.id} |
|
|
16
16
|
*
|
|
17
17
|
* @param filterStatement a Publisher Query Language statement used to filter a set of line item templates
|
|
18
18
|
* @returns the line item templates that match the given filter
|
|
@@ -1,33 +1,33 @@
|
|
|
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/LiveStreamEventService.LiveStreamEvent LiveStreamEvent} objects.
|
|
3
3
|
*/
|
|
4
4
|
export declare abstract class LiveStreamEventAction {
|
|
5
5
|
}
|
|
6
6
|
/**
|
|
7
|
-
* The action used for activating {@link https://developers.google.com/ad-manager/api/reference/
|
|
7
|
+
* The action used for activating {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent LiveStreamEvent} objects.
|
|
8
8
|
*/
|
|
9
9
|
export declare class ActivateLiveStreamEvents implements LiveStreamEventAction {
|
|
10
10
|
}
|
|
11
11
|
/**
|
|
12
|
-
* The action used for archiving {@link https://developers.google.com/ad-manager/api/reference/
|
|
12
|
+
* The action used for archiving {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent LiveStreamEvent} objects.
|
|
13
13
|
*/
|
|
14
14
|
export declare class ArchiveLiveStreamEvents implements LiveStreamEventAction {
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
|
-
* The action used for pausing ads {@link https://developers.google.com/ad-manager/api/reference/
|
|
17
|
+
* The action used for pausing ads {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent LiveStreamEvent} objects.
|
|
18
18
|
*/
|
|
19
19
|
export declare class PauseLiveStreamEventAds implements LiveStreamEventAction {
|
|
20
20
|
}
|
|
21
21
|
/**
|
|
22
|
-
* The action used for pausing {@link https://developers.google.com/ad-manager/api/reference/
|
|
22
|
+
* The action used for pausing {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent LiveStreamEvent} objects.
|
|
23
23
|
*/
|
|
24
24
|
export declare class PauseLiveStreamEvents implements LiveStreamEventAction {
|
|
25
25
|
}
|
|
26
26
|
/**
|
|
27
27
|
* The action used for refreshing the master playlists of
|
|
28
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
28
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent LiveStreamEvent} objects.
|
|
29
29
|
* This action will only get applied to live streams with a refresh type of
|
|
30
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
30
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.RefreshType#MANUAL RefreshType.MANUAL}.
|
|
31
31
|
*/
|
|
32
32
|
export declare class RefreshLiveStreamEventMasterPlaylists implements LiveStreamEventAction {
|
|
33
33
|
}
|
|
@@ -2,40 +2,40 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.RefreshLiveStreamEventMasterPlaylists = exports.PauseLiveStreamEvents = exports.PauseLiveStreamEventAds = exports.ArchiveLiveStreamEvents = exports.ActivateLiveStreamEvents = exports.LiveStreamEventAction = 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/LiveStreamEventService.LiveStreamEvent LiveStreamEvent} objects.
|
|
6
6
|
*/
|
|
7
7
|
class LiveStreamEventAction {
|
|
8
8
|
}
|
|
9
9
|
exports.LiveStreamEventAction = LiveStreamEventAction;
|
|
10
10
|
/**
|
|
11
|
-
* The action used for activating {@link https://developers.google.com/ad-manager/api/reference/
|
|
11
|
+
* The action used for activating {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent LiveStreamEvent} objects.
|
|
12
12
|
*/
|
|
13
13
|
class ActivateLiveStreamEvents {
|
|
14
14
|
}
|
|
15
15
|
exports.ActivateLiveStreamEvents = ActivateLiveStreamEvents;
|
|
16
16
|
/**
|
|
17
|
-
* The action used for archiving {@link https://developers.google.com/ad-manager/api/reference/
|
|
17
|
+
* The action used for archiving {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent LiveStreamEvent} objects.
|
|
18
18
|
*/
|
|
19
19
|
class ArchiveLiveStreamEvents {
|
|
20
20
|
}
|
|
21
21
|
exports.ArchiveLiveStreamEvents = ArchiveLiveStreamEvents;
|
|
22
22
|
/**
|
|
23
|
-
* The action used for pausing ads {@link https://developers.google.com/ad-manager/api/reference/
|
|
23
|
+
* The action used for pausing ads {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent LiveStreamEvent} objects.
|
|
24
24
|
*/
|
|
25
25
|
class PauseLiveStreamEventAds {
|
|
26
26
|
}
|
|
27
27
|
exports.PauseLiveStreamEventAds = PauseLiveStreamEventAds;
|
|
28
28
|
/**
|
|
29
|
-
* The action used for pausing {@link https://developers.google.com/ad-manager/api/reference/
|
|
29
|
+
* The action used for pausing {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent LiveStreamEvent} objects.
|
|
30
30
|
*/
|
|
31
31
|
class PauseLiveStreamEvents {
|
|
32
32
|
}
|
|
33
33
|
exports.PauseLiveStreamEvents = PauseLiveStreamEvents;
|
|
34
34
|
/**
|
|
35
35
|
* The action used for refreshing the master playlists of
|
|
36
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
36
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent LiveStreamEvent} objects.
|
|
37
37
|
* This action will only get applied to live streams with a refresh type of
|
|
38
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
38
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.RefreshType#MANUAL RefreshType.MANUAL}.
|
|
39
39
|
*/
|
|
40
40
|
class RefreshLiveStreamEventMasterPlaylists {
|
|
41
41
|
}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Describes the status of a {@link https://developers.google.com/ad-manager/api/reference/
|
|
2
|
+
* Describes the status of a {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent LiveStreamEvent} object.
|
|
3
3
|
*/
|
|
4
4
|
export declare enum LiveStreamEventStatus {
|
|
5
5
|
/**
|
|
@@ -97,7 +97,7 @@ export declare enum DynamicAdInsertionType {
|
|
|
97
97
|
UNKNOWN = "UNKNOWN"
|
|
98
98
|
}
|
|
99
99
|
/**
|
|
100
|
-
* The {@link https://developers.google.com/ad-manager/api/reference/
|
|
100
|
+
* The {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent LiveStreamEvent} streaming format.
|
|
101
101
|
*/
|
|
102
102
|
export declare enum StreamingFormat {
|
|
103
103
|
/**
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.TranscodeStatus = exports.SlateStatus = exports.AdServingFormat = exports.AdBreakMarkupType = exports.StreamingFormat = exports.DynamicAdInsertionType = exports.RefreshType = exports.PlaylistType = exports.AdBreakFillType = exports.LiveStreamEventStatus = void 0;
|
|
4
4
|
/**
|
|
5
|
-
* Describes the status of a {@link https://developers.google.com/ad-manager/api/reference/
|
|
5
|
+
* Describes the status of a {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent LiveStreamEvent} object.
|
|
6
6
|
*/
|
|
7
7
|
var LiveStreamEventStatus;
|
|
8
8
|
(function (LiveStreamEventStatus) {
|
|
@@ -105,7 +105,7 @@ var DynamicAdInsertionType;
|
|
|
105
105
|
DynamicAdInsertionType["UNKNOWN"] = "UNKNOWN";
|
|
106
106
|
})(DynamicAdInsertionType || (exports.DynamicAdInsertionType = DynamicAdInsertionType = {}));
|
|
107
107
|
/**
|
|
108
|
-
* The {@link https://developers.google.com/ad-manager/api/reference/
|
|
108
|
+
* The {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent LiveStreamEvent} streaming format.
|
|
109
109
|
*/
|
|
110
110
|
var StreamingFormat;
|
|
111
111
|
(function (StreamingFormat) {
|
|
@@ -206,7 +206,7 @@ export type LiveStreamEvent = {
|
|
|
206
206
|
adServingFormat: AdServingFormat;
|
|
207
207
|
};
|
|
208
208
|
/**
|
|
209
|
-
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/
|
|
209
|
+
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent LiveStreamEvent} objects.
|
|
210
210
|
*/
|
|
211
211
|
export type LiveStreamEventPage = PageResult<LiveStreamEvent>;
|
|
212
212
|
/**
|
|
@@ -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
|