@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
|
@@ -3,54 +3,54 @@ import type { CustomTargetingKeyAction, CustomTargetingValueAction } from "./cus
|
|
|
3
3
|
import type { CustomTargetingKey, CustomTargetingKeyPage, CustomTargetingValue, CustomTargetingValuePage } from "./customTargeting.type";
|
|
4
4
|
/**
|
|
5
5
|
* Provides operations for creating, updating and retrieving
|
|
6
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
7
|
-
* and {@link https://developers.google.com/ad-manager/api/reference/
|
|
6
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingKey CustomTargetingKey}
|
|
7
|
+
* and {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingValue CustomTargetingValue} objects.
|
|
8
8
|
*
|
|
9
9
|
*/
|
|
10
10
|
export interface CustomTargetingServiceOperations {
|
|
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/CustomTargetingService.CustomTargetingKey CustomTargetingKey} 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/
|
|
15
|
+
* - {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingKey#name CustomTargetingKey.name }
|
|
16
|
+
* - {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingKey#type CustomTargetingKey.type }
|
|
17
17
|
*
|
|
18
18
|
* @param keys the custom targeting keys to update
|
|
19
19
|
* @returns the updated custom targeting keys
|
|
20
20
|
*/
|
|
21
21
|
createCustomTargetingKeys(keys: Partial<CustomTargetingKey>[]): Promise<CustomTargetingKey[]>;
|
|
22
22
|
/**
|
|
23
|
-
* Creates new {@link https://developers.google.com/ad-manager/api/reference/
|
|
23
|
+
* Creates new {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingValue CustomTargetingValue} objects.
|
|
24
24
|
* The following fields are required:
|
|
25
25
|
*
|
|
26
|
-
* - {@link https://developers.google.com/ad-manager/api/reference/
|
|
27
|
-
* - {@link https://developers.google.com/ad-manager/api/reference/
|
|
26
|
+
* - {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingValue#customTargetingKeyId CustomTargetingValue.customTargetingKeyId }
|
|
27
|
+
* - {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingKey#name CustomTargetingValue.name }
|
|
28
28
|
*
|
|
29
29
|
* @param values the custom targeting values to update
|
|
30
30
|
* @returns the updated custom targeting values
|
|
31
31
|
*/
|
|
32
32
|
createCustomTargetingValues(values: Partial<CustomTargetingValue>[]): Promise<CustomTargetingValue[]>;
|
|
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
|
-
* the given {@link https://developers.google.com/ad-manager/api/reference/
|
|
34
|
+
* Gets a {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingKeyPage CustomTargetingKeyPage}
|
|
35
|
+
* of {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingKey CustomTargetingKey} objects that satisfy
|
|
36
|
+
* the given {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.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
|
-
* | name | {@link https://developers.google.com/ad-manager/api/reference/
|
|
43
|
-
* | displayName | {@link https://developers.google.com/ad-manager/api/reference/
|
|
44
|
-
* | type | {@link https://developers.google.com/ad-manager/api/reference/
|
|
41
|
+
* | id | {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingKey#id CustomTargetingKey.id} |
|
|
42
|
+
* | name | {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingKey#name CustomTargetingKey.name} |
|
|
43
|
+
* | displayName | {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingKey#displayName CustomTargetingKey.displayName} |
|
|
44
|
+
* | type | {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingKey#type CustomTargetingKey.type} |
|
|
45
45
|
*
|
|
46
46
|
* @param filterStatement a Publisher Query Language statement used to filter a set of custom targeting keys
|
|
47
47
|
* @returns the custom targeting keys that match the given filter
|
|
48
48
|
*/
|
|
49
49
|
getCustomTargetingKeysByStatement(filterStatement: Statement): Promise<CustomTargetingKeyPage>;
|
|
50
50
|
/**
|
|
51
|
-
* Gets a {@link https://developers.google.com/ad-manager/api/reference/
|
|
52
|
-
* of {@link https://developers.google.com/ad-manager/api/reference/
|
|
53
|
-
* the given {@link https://developers.google.com/ad-manager/api/reference/
|
|
51
|
+
* Gets a {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingValuePage CustomTargetingValuePage}
|
|
52
|
+
* of {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingValue CustomTargetingValue} objects that satisfy
|
|
53
|
+
* the given {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.Statement#query Statement.query}.
|
|
54
54
|
*
|
|
55
55
|
* The WHERE clause in the Statement.query must always contain CustomTargetingValue.customTargetingKeyId as one of its columns in a way that it is
|
|
56
56
|
* AND'ed with the rest of the query. So, if you want to retrieve values for a known set of key ids, valid Statement.query would look like:
|
|
@@ -62,19 +62,19 @@ export interface CustomTargetingServiceOperations {
|
|
|
62
62
|
*
|
|
63
63
|
* | PQL Property | PQL Property |
|
|
64
64
|
* | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
65
|
-
* | id | {@link https://developers.google.com/ad-manager/api/reference/
|
|
66
|
-
* | customTargetingKeyId | {@link https://developers.google.com/ad-manager/api/reference/
|
|
67
|
-
* | name | {@link https://developers.google.com/ad-manager/api/reference/
|
|
68
|
-
* | displayName | {@link https://developers.google.com/ad-manager/api/reference/
|
|
69
|
-
* | matchType | {@link https://developers.google.com/ad-manager/api/reference/
|
|
65
|
+
* | id | {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingValue#id CustomTargetingValue.id} |
|
|
66
|
+
* | customTargetingKeyId | {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingValue#customTargetingKeyId CustomTargetingValue.customTargetingKeyId} |
|
|
67
|
+
* | name | {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingValue#name CustomTargetingValue.name} |
|
|
68
|
+
* | displayName | {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingValue#displayName CustomTargetingValue.displayName} |
|
|
69
|
+
* | matchType | {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingValue#matchType CustomTargetingValue.matchType} |
|
|
70
70
|
*
|
|
71
71
|
* @param filterStatement a Publisher Query Language statement used to filter a set of custom targeting values
|
|
72
72
|
* @returns the custom targeting values that match the given filter
|
|
73
73
|
*/
|
|
74
74
|
getCustomTargetingValuesByStatement(filterStatement: Statement): Promise<CustomTargetingValuePage>;
|
|
75
75
|
/**
|
|
76
|
-
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/
|
|
77
|
-
* objects that match the given {@link https://developers.google.com/ad-manager/api/reference/
|
|
76
|
+
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingKey CustomTargetingKey}
|
|
77
|
+
* objects that match the given {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.Statement#query Statement.query}.
|
|
78
78
|
*
|
|
79
79
|
* @param customTargetingKeyAction the action to perform
|
|
80
80
|
* @param filterStatement a Publisher Query Language statement used to filter a set of custom targeting keys
|
|
@@ -82,8 +82,8 @@ export interface CustomTargetingServiceOperations {
|
|
|
82
82
|
*/
|
|
83
83
|
performCustomTargetingKeyAction(customTargetingKeyAction: CustomTargetingKeyAction, filterStatement: Statement): Promise<UpdateResult>;
|
|
84
84
|
/**
|
|
85
|
-
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/
|
|
86
|
-
* objects that match the given {@link https://developers.google.com/ad-manager/api/reference/
|
|
85
|
+
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingValue CustomTargetingValue}
|
|
86
|
+
* objects that match the given {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.Statement#query Statement.query}.
|
|
87
87
|
*
|
|
88
88
|
* @param customTargetingKeyAction the action to perform
|
|
89
89
|
* @param filterStatement a Publisher Query Language statement used to filter a set of ad units
|
|
@@ -91,14 +91,14 @@ export interface CustomTargetingServiceOperations {
|
|
|
91
91
|
*/
|
|
92
92
|
performCustomTargetingValueAction(customTargetingValueAction: CustomTargetingValueAction, filterStatement: Statement): Promise<UpdateResult>;
|
|
93
93
|
/**
|
|
94
|
-
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/
|
|
94
|
+
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingKey CustomTargetingKey} objects.
|
|
95
95
|
*
|
|
96
96
|
* @param keys the custom targeting keys to update
|
|
97
97
|
* @returns the updated custom targeting keys
|
|
98
98
|
*/
|
|
99
99
|
updateCustomTargetingKeys(keys: CustomTargetingKey[]): Promise<CustomTargetingKey[]>;
|
|
100
100
|
/**
|
|
101
|
-
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/
|
|
101
|
+
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingValue CustomTargetingValue} objects.
|
|
102
102
|
*
|
|
103
103
|
* @param values the custom targeting values to update
|
|
104
104
|
* @returns the updated custom targeting values
|
|
@@ -39,7 +39,7 @@ export type CustomTargetingKey = {
|
|
|
39
39
|
reportableType: ReportableType;
|
|
40
40
|
};
|
|
41
41
|
/**
|
|
42
|
-
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/
|
|
42
|
+
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingKey CustomTargetingKey} objects.
|
|
43
43
|
*/
|
|
44
44
|
export type CustomTargetingKeyPage = PageResult<CustomTargetingKey>;
|
|
45
45
|
/**
|
|
@@ -81,7 +81,7 @@ export type CustomTargetingValue = {
|
|
|
81
81
|
*/
|
|
82
82
|
export declare const CustomTargetingValueStruct: Describe<CustomTargetingValue>;
|
|
83
83
|
/**
|
|
84
|
-
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/
|
|
84
|
+
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService.CustomTargetingValue CustomTargetingValue} objects.
|
|
85
85
|
*/
|
|
86
86
|
export type CustomTargetingValuePage = PageResult<CustomTargetingValue>;
|
|
87
87
|
//# sourceMappingURL=customTargeting.type.d.ts.map
|
|
@@ -1,16 +1,16 @@
|
|
|
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/DaiAuthenticationKeyService.DaiAuthenticationKey DaiAuthenticationKey} objects.
|
|
4
4
|
*/
|
|
5
5
|
export declare abstract class DaiAuthenticationKeyAction {
|
|
6
6
|
}
|
|
7
7
|
/**
|
|
8
|
-
* The action used for activating {@link https://developers.google.com/ad-manager/api/reference/
|
|
8
|
+
* The action used for activating {@link https://developers.google.com/ad-manager/api/reference/latest/DaiAuthenticationKeyService.DaiAuthenticationKey DaiAuthenticationKey} objects.
|
|
9
9
|
*/
|
|
10
10
|
export declare class ActivateDaiAuthenticationKeys implements DaiAuthenticationKeyAction {
|
|
11
11
|
}
|
|
12
12
|
/**
|
|
13
|
-
* The action used for deactivating {@link https://developers.google.com/ad-manager/api/reference/
|
|
13
|
+
* The action used for deactivating {@link https://developers.google.com/ad-manager/api/reference/latest/DaiAuthenticationKeyService.DaiAuthenticationKey DaiAuthenticationKey} objects.
|
|
14
14
|
*/
|
|
15
15
|
export declare class DeactivateDaiAuthenticationKeys implements DaiAuthenticationKeyAction {
|
|
16
16
|
}
|
|
@@ -3,19 +3,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.DeactivateDaiAuthenticationKeys = exports.ActivateDaiAuthenticationKeys = exports.DaiAuthenticationKeyAction = 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/DaiAuthenticationKeyService.DaiAuthenticationKey DaiAuthenticationKey} objects.
|
|
7
7
|
*/
|
|
8
8
|
class DaiAuthenticationKeyAction {
|
|
9
9
|
}
|
|
10
10
|
exports.DaiAuthenticationKeyAction = DaiAuthenticationKeyAction;
|
|
11
11
|
/**
|
|
12
|
-
* The action used for activating {@link https://developers.google.com/ad-manager/api/reference/
|
|
12
|
+
* The action used for activating {@link https://developers.google.com/ad-manager/api/reference/latest/DaiAuthenticationKeyService.DaiAuthenticationKey DaiAuthenticationKey} objects.
|
|
13
13
|
*/
|
|
14
14
|
class ActivateDaiAuthenticationKeys {
|
|
15
15
|
}
|
|
16
16
|
exports.ActivateDaiAuthenticationKeys = ActivateDaiAuthenticationKeys;
|
|
17
17
|
/**
|
|
18
|
-
* The action used for deactivating {@link https://developers.google.com/ad-manager/api/reference/
|
|
18
|
+
* The action used for deactivating {@link https://developers.google.com/ad-manager/api/reference/latest/DaiAuthenticationKeyService.DaiAuthenticationKey DaiAuthenticationKey} objects.
|
|
19
19
|
*/
|
|
20
20
|
class DeactivateDaiAuthenticationKeys {
|
|
21
21
|
}
|
|
@@ -34,7 +34,7 @@ export type DaiAuthenticationKey = {
|
|
|
34
34
|
keyType: DaiAuthenticationKeyType;
|
|
35
35
|
};
|
|
36
36
|
/**
|
|
37
|
-
* Captures a page of https://developers.google.com/ad-manager/api/reference/
|
|
37
|
+
* Captures a page of https://developers.google.com/ad-manager/api/reference/latest/DaiAuthenticationKeyService.DaiAuthenticationKey DaiAuthenticationKey} objects.
|
|
38
38
|
*/
|
|
39
39
|
export type DaiAuthenticationKeyPage = PageResult<DaiAuthenticationKey>;
|
|
40
40
|
//# sourceMappingURL=daiAuthenticationKey.type.d.ts.map
|
package/dist/client/services/daiAuthenticationKey/daiAuthenticationKeyService.interface.d.ts
CHANGED
|
@@ -3,42 +3,42 @@ import type { DaiAuthenticationKeyAction } from "./daiAuthenticationKey.action";
|
|
|
3
3
|
import type { DaiAuthenticationKey, DaiAuthenticationKeyPage } from "./daiAuthenticationKey.type";
|
|
4
4
|
/**
|
|
5
5
|
* Provides methods for creating, updating and retrieving
|
|
6
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
6
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/DaiAuthenticationKeyService.DaiAuthenticationKey DaiAuthenticationKey} objects.
|
|
7
7
|
*/
|
|
8
8
|
export interface DaiAuthenticationKeyServiceOperations {
|
|
9
9
|
/**
|
|
10
|
-
* Creates new {@link https://developers.google.com/ad-manager/api/reference/
|
|
10
|
+
* Creates new {@link https://developers.google.com/ad-manager/api/reference/latest/DaiAuthenticationKeyService.DaiAuthenticationKey DaiAuthenticationKey} objects.
|
|
11
11
|
*
|
|
12
12
|
* The following fields are required:
|
|
13
13
|
*
|
|
14
|
-
* - {@link https://developers.google.com/ad-manager/api/reference/
|
|
14
|
+
* - {@link https://developers.google.com/ad-manager/api/reference/latest/DaiAuthenticationKeyService.DaiAuthenticationKey#name DaiAuthenticationKey.name }
|
|
15
15
|
*
|
|
16
16
|
* @param daiAuthenticationKeys the DAI authentication keys to create
|
|
17
17
|
* @returns the created DAI authentication keys with their IDs filled in
|
|
18
18
|
*/
|
|
19
19
|
createDaiAuthenticationKeys(daiAuthenticationKeys: Partial<DaiAuthenticationKey>[]): Promise<DaiAuthenticationKey[]>;
|
|
20
20
|
/**
|
|
21
|
-
* Gets a {@link https://developers.google.com/ad-manager/api/reference/
|
|
22
|
-
* of {@link https://developers.google.com/ad-manager/api/reference/
|
|
23
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
21
|
+
* Gets a {@link https://developers.google.com/ad-manager/api/reference/latest/DaiAuthenticationKeyService.DaiAuthenticationKeyPage DaiAuthenticationKeyPage}
|
|
22
|
+
* of {@link https://developers.google.com/ad-manager/api/reference/latest/DaiAuthenticationKeyService.DaiAuthenticationKey DaiAuthenticationKey} objects that satisfy the given
|
|
23
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/DaiAuthenticationKeyService.Statement#query Statement.query}.
|
|
24
24
|
* The following fields are supported for filtering:
|
|
25
25
|
*
|
|
26
26
|
* | PQL Property | PQL Property |
|
|
27
27
|
* | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
28
|
-
* | id | {@link https://developers.google.com/ad-manager/api/reference/
|
|
29
|
-
* | status | {@link https://developers.google.com/ad-manager/api/reference/
|
|
30
|
-
* | name | {@link https://developers.google.com/ad-manager/api/reference/
|
|
28
|
+
* | id | {@link https://developers.google.com/ad-manager/api/reference/latest/DaiAuthenticationKeyService.DaiAuthenticationKey#id DaiAuthenticationKey.id} |
|
|
29
|
+
* | status | {@link https://developers.google.com/ad-manager/api/reference/latest/DaiAuthenticationKeyService.DaiAuthenticationKey#status DaiAuthenticationKey.status} |
|
|
30
|
+
* | name | {@link https://developers.google.com/ad-manager/api/reference/latest/DaiAuthenticationKeyService.DaiAuthenticationKey#name DaiAuthenticationKey.name} |
|
|
31
31
|
*
|
|
32
32
|
* @param filterStatement a Publisher Query Language statement to filter a list of DAI authentication keys
|
|
33
33
|
* @returns the DAI authentication keys that match the filter
|
|
34
34
|
*/
|
|
35
35
|
getDaiAuthenticationKeysByStatement(filterStatement: Statement): Promise<DaiAuthenticationKeyPage>;
|
|
36
36
|
/**
|
|
37
|
-
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/
|
|
38
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
37
|
+
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/latest/DaiAuthenticationKeyService.DaiAuthenticationKey DaiAuthenticationKey} objects that match the given
|
|
38
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/DaiAuthenticationKeyService.Statement#query Statement.query}.
|
|
39
39
|
*
|
|
40
40
|
* DAI authentication keys cannot be deactivated if there are active
|
|
41
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
41
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent LiveStreamEvent}s or Content Sources that are using them.
|
|
42
42
|
*
|
|
43
43
|
* @param daiAuthenticationKeyAction the action to perform
|
|
44
44
|
* @param filterStatement a Publisher Query Language statement used to filter a set of live stream events
|
|
@@ -46,7 +46,7 @@ export interface DaiAuthenticationKeyServiceOperations {
|
|
|
46
46
|
*/
|
|
47
47
|
performDaiAuthenticationKeyAction(daiAuthenticationKeyAction: DaiAuthenticationKeyAction, filterStatement: Statement): Promise<UpdateResult>;
|
|
48
48
|
/**
|
|
49
|
-
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/
|
|
49
|
+
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/latest/DaiAuthenticationKeyService.DaiAuthenticationKey DaiAuthenticationKey} objects.
|
|
50
50
|
*
|
|
51
51
|
* @param daiAuthenticationKeys the video DAI authentication keys to update
|
|
52
52
|
* @returns the updated DAI authentication keys
|
|
@@ -1,16 +1,16 @@
|
|
|
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/DaiEncodingProfileService.DaiEncodingProfile DaiEncodingProfile} objects.
|
|
4
4
|
*/
|
|
5
5
|
export declare abstract class DaiEncodingProfileAction {
|
|
6
6
|
}
|
|
7
7
|
/**
|
|
8
|
-
* The action used for activating {@link https://developers.google.com/ad-manager/api/reference/
|
|
8
|
+
* The action used for activating {@link https://developers.google.com/ad-manager/api/reference/latest/DaiEncodingProfileService.DaiEncodingProfile DaiEncodingProfile} objects.
|
|
9
9
|
*/
|
|
10
10
|
export declare class ActivateDaiEncodingProfiles implements DaiEncodingProfileAction {
|
|
11
11
|
}
|
|
12
12
|
/**
|
|
13
|
-
* The action used for archiving {@link https://developers.google.com/ad-manager/api/reference/
|
|
13
|
+
* The action used for archiving {@link https://developers.google.com/ad-manager/api/reference/latest/DaiEncodingProfileService.DaiEncodingProfile DaiEncodingProfile} objects.
|
|
14
14
|
*/
|
|
15
15
|
export declare class ArchiveDaiEncodingProfiles implements DaiEncodingProfileAction {
|
|
16
16
|
}
|
|
@@ -3,19 +3,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.ArchiveDaiEncodingProfiles = exports.ActivateDaiEncodingProfiles = exports.DaiEncodingProfileAction = 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/DaiEncodingProfileService.DaiEncodingProfile DaiEncodingProfile} objects.
|
|
7
7
|
*/
|
|
8
8
|
class DaiEncodingProfileAction {
|
|
9
9
|
}
|
|
10
10
|
exports.DaiEncodingProfileAction = DaiEncodingProfileAction;
|
|
11
11
|
/**
|
|
12
|
-
* The action used for activating {@link https://developers.google.com/ad-manager/api/reference/
|
|
12
|
+
* The action used for activating {@link https://developers.google.com/ad-manager/api/reference/latest/DaiEncodingProfileService.DaiEncodingProfile DaiEncodingProfile} objects.
|
|
13
13
|
*/
|
|
14
14
|
class ActivateDaiEncodingProfiles {
|
|
15
15
|
}
|
|
16
16
|
exports.ActivateDaiEncodingProfiles = ActivateDaiEncodingProfiles;
|
|
17
17
|
/**
|
|
18
|
-
* The action used for archiving {@link https://developers.google.com/ad-manager/api/reference/
|
|
18
|
+
* The action used for archiving {@link https://developers.google.com/ad-manager/api/reference/latest/DaiEncodingProfileService.DaiEncodingProfile DaiEncodingProfile} objects.
|
|
19
19
|
*/
|
|
20
20
|
class ArchiveDaiEncodingProfiles {
|
|
21
21
|
}
|
|
@@ -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/DaiEncodingProfileService.DaiEncodingProfile DaiEncodingProfile} object.
|
|
3
3
|
*/
|
|
4
4
|
export declare enum DaiEncodingProfileStatus {
|
|
5
5
|
/**
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.ContainerType = exports.VariantType = exports.DaiEncodingProfileStatus = 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/DaiEncodingProfileService.DaiEncodingProfile DaiEncodingProfile} object.
|
|
6
6
|
*/
|
|
7
7
|
var DaiEncodingProfileStatus;
|
|
8
8
|
(function (DaiEncodingProfileStatus) {
|
|
@@ -44,7 +44,7 @@ export type AudioSettings = {
|
|
|
44
44
|
sampleRateHertz: number;
|
|
45
45
|
};
|
|
46
46
|
/**
|
|
47
|
-
* A {@link https://developers.google.com/ad-manager/api/reference/
|
|
47
|
+
* A {@link https://developers.google.com/ad-manager/api/reference/latest/DaiEncodingProfileService.DaiEncodingProfile DaiEncodingProfile}
|
|
48
48
|
* contains data about a publisher's encoding profiles. Ad Manager Dynamic Ad Insertion (DAI) uses the profile information about the content
|
|
49
49
|
* to select an appropriate ad transcode to play for the particular video.
|
|
50
50
|
*/
|
|
@@ -89,7 +89,7 @@ export type DaiEncodingProfile = {
|
|
|
89
89
|
persistUnmatchedProfiles: boolean;
|
|
90
90
|
};
|
|
91
91
|
/**
|
|
92
|
-
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/
|
|
92
|
+
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/latest/DaiEncodingProfileService.DaiEncodingProfile DaiEncodingProfile} objects.
|
|
93
93
|
*/
|
|
94
94
|
export type DaiEncodingProfilePage = PageResult<DaiEncodingProfile>;
|
|
95
95
|
//# sourceMappingURL=daiEncodingProfile.type.d.ts.map
|
|
@@ -3,37 +3,37 @@ import type { DaiEncodingProfileAction } from "./daiEncodingProfile.action";
|
|
|
3
3
|
import type { DaiEncodingProfile, DaiEncodingProfilePage } from "./daiEncodingProfile.type";
|
|
4
4
|
/**
|
|
5
5
|
* Provides methods for creating, updating and retrieving
|
|
6
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
6
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/DaiEncodingProfileService.DaiEncodingProfile DaiEncodingProfile} objects.
|
|
7
7
|
*
|
|
8
8
|
* This feature is not yet openly available for GAM Video publishers. Publishers will need to apply for access for this feature through their account managers.
|
|
9
9
|
*/
|
|
10
10
|
export interface DaiEncodingProfileServiceOperations {
|
|
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/DaiEncodingProfileService.DaiEncodingProfile DaiEncodingProfile} objects.
|
|
13
13
|
*
|
|
14
14
|
* @param daiEncodingProfiles the profiles to create
|
|
15
15
|
* @returns the created profiles with their IDs filled in
|
|
16
16
|
*/
|
|
17
17
|
createDaiEncodingProfiles(daiEncodingProfiles: Partial<DaiEncodingProfile>[]): Promise<DaiEncodingProfile[]>;
|
|
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/DaiEncodingProfileService.DaiEncodingProfilePage DaiEncodingProfilePage}
|
|
20
|
+
* of {@link https://developers.google.com/ad-manager/api/reference/latest/DaiEncodingProfileService.DaiEncodingProfile DaiEncodingProfile} objects that satisfy the given
|
|
21
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/DaiEncodingProfileService.Statement#query Statement.query}.
|
|
22
22
|
* The following fields are supported for filtering:
|
|
23
23
|
*
|
|
24
24
|
* | PQL Property | PQL Property |
|
|
25
25
|
* | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
26
|
-
* | id | {@link https://developers.google.com/ad-manager/api/reference/
|
|
27
|
-
* | name | {@link https://developers.google.com/ad-manager/api/reference/
|
|
28
|
-
* | status | {@link https://developers.google.com/ad-manager/api/reference/
|
|
26
|
+
* | id | {@link https://developers.google.com/ad-manager/api/reference/latest/DaiEncodingProfileService.DaiEncodingProfile#id DaiEncodingProfile.id} |
|
|
27
|
+
* | name | {@link https://developers.google.com/ad-manager/api/reference/latest/DaiEncodingProfileService.DaiEncodingProfile#name DaiEncodingProfile.name} |
|
|
28
|
+
* | status | {@link https://developers.google.com/ad-manager/api/reference/latest/DaiEncodingProfileService.DaiEncodingProfile#status DaiEncodingProfile.status} |
|
|
29
29
|
*
|
|
30
30
|
* @param filterStatement a Publisher Query Language statement to filter a list of profiles
|
|
31
31
|
* @returns the profiles that match the filter
|
|
32
32
|
*/
|
|
33
33
|
getDaiEncodingProfilesByStatement(filterStatement: Statement): Promise<DaiEncodingProfilePage>;
|
|
34
34
|
/**
|
|
35
|
-
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/
|
|
36
|
-
* objects that match the given {@link https://developers.google.com/ad-manager/api/reference/
|
|
35
|
+
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/latest/DaiEncodingProfileService.DaiEncodingProfile DaiEncodingProfile}
|
|
36
|
+
* objects that match the given {@link https://developers.google.com/ad-manager/api/reference/latest/DaiEncodingProfileService.Statement#query Statement.query}.
|
|
37
37
|
*
|
|
38
38
|
* @param daiEncodingProfileAction the action to perform
|
|
39
39
|
* @param filterStatement a Publisher Query Language statement used to filter a set of profiles
|
|
@@ -41,7 +41,7 @@ export interface DaiEncodingProfileServiceOperations {
|
|
|
41
41
|
*/
|
|
42
42
|
performDaiEncodingProfileAction(daiEncodingProfileAction: DaiEncodingProfileAction, filterStatement: Statement): Promise<UpdateResult>;
|
|
43
43
|
/**
|
|
44
|
-
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/
|
|
44
|
+
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/latest/DaiEncodingProfileService.DaiEncodingProfile DaiEncodingProfile} objects.
|
|
45
45
|
*
|
|
46
46
|
* @param daiEncodingProfiles the content profiles to update
|
|
47
47
|
* @returns the updated profiles
|
|
@@ -211,7 +211,7 @@ export type GrpDemographicBreakdown = {
|
|
|
211
211
|
age: GrpAge;
|
|
212
212
|
};
|
|
213
213
|
/**
|
|
214
|
-
* Describes predicted inventory availability for a {@link https://developers.google.com/ad-manager/api/reference/
|
|
214
|
+
* Describes predicted inventory availability for a {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.ProspectiveLineItem ProspectiveLineItem}.
|
|
215
215
|
*
|
|
216
216
|
* Inventory has three threshold values along a line of possible inventory. From least to most, these are:
|
|
217
217
|
*
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
import type { AvailabilityForecast, AvailabilityForecastOptions, DeliveryForecast, DeliveryForecastOptions, ProspectiveLineItem, TrafficDataRequest, TrafficDataResponse } from "./forecast.type";
|
|
2
2
|
/**
|
|
3
3
|
* Provides methods for estimating traffic (clicks/impressions) for line items.
|
|
4
|
-
* Forecasts can be provided for {@link https://developers.google.com/ad-manager/api/reference/
|
|
4
|
+
* Forecasts can be provided for {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem LineItem}
|
|
5
5
|
* objects that exist in the system or which have not had an ID set yet.
|
|
6
6
|
*/
|
|
7
7
|
export interface ForecastServiceOperations {
|
|
8
8
|
/**
|
|
9
|
-
* Gets the availability forecast for a {@link https://developers.google.com/ad-manager/api/reference/
|
|
9
|
+
* Gets the availability forecast for a {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.ProspectiveLineItem ProspectiveLineItem}.
|
|
10
10
|
* An availability forecast reports the maximum number of available units that the line item can book, and the total number of units matching the line item's targeting.
|
|
11
11
|
*
|
|
12
12
|
* @param lineItem the prospective line item (new or existing) to be forecasted for availability
|
|
@@ -14,21 +14,21 @@ export interface ForecastServiceOperations {
|
|
|
14
14
|
*/
|
|
15
15
|
getAvailabilityForecast(lineItem: ProspectiveLineItem, forecastOptions: AvailabilityForecastOptions): Promise<AvailabilityForecast>;
|
|
16
16
|
/**
|
|
17
|
-
* Gets an {@link https://developers.google.com/ad-manager/api/reference/
|
|
18
|
-
* for an existing {@link https://developers.google.com/ad-manager/api/reference/
|
|
17
|
+
* Gets an {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.AvailabilityForecast AvailabilityForecast}
|
|
18
|
+
* for an existing {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem LineItem} object.
|
|
19
19
|
* An availability forecast reports the maximum number of available units that the line item can be booked with,
|
|
20
20
|
* and also the total number of units matching the line item's targeting.
|
|
21
21
|
*
|
|
22
|
-
* Only line items having type {@link https://developers.google.com/ad-manager/api/reference/
|
|
23
|
-
* or {@link https://developers.google.com/ad-manager/api/reference/
|
|
24
|
-
* Other types will result in {@link https://developers.google.com/ad-manager/api/reference/
|
|
22
|
+
* Only line items having type {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItemType#SPONSORSHIP LineItemType.SPONSORSHIP}
|
|
23
|
+
* or {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItemType#STANDARD LineItemType.STANDARD} are valid.
|
|
24
|
+
* Other types will result in {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.ReservationDetailsError.Reason#LINE_ITEM_TYPE_NOT_ALLOWED ReservationDetailsError.Reason.LINE_ITEM_TYPE_NOT_ALLOWED}.
|
|
25
25
|
*
|
|
26
26
|
* @param lineItemId the ID of a LineItem to run the forecast on.
|
|
27
27
|
* @param forecastOptions options controlling the forecast
|
|
28
28
|
*/
|
|
29
29
|
getAvailabilityForecastById(lineItemId: number, forecastOptions: AvailabilityForecastOptions): Promise<AvailabilityForecast>;
|
|
30
30
|
/**
|
|
31
|
-
* Gets the delivery forecast for a list of {@link https://developers.google.com/ad-manager/api/reference/
|
|
31
|
+
* Gets the delivery forecast for a list of {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.ProspectiveLineItem ProspectiveLineItem}
|
|
32
32
|
* objects in a single delivery simulation with line items potentially contending with each other.
|
|
33
33
|
* A delivery forecast reports the number of units that will be delivered to each line item given the line item goals and contentions from other line items.
|
|
34
34
|
*
|
|
@@ -37,7 +37,7 @@ export interface ForecastServiceOperations {
|
|
|
37
37
|
*/
|
|
38
38
|
getDeliveryForecast(lineItems: ProspectiveLineItem[], forecastOptions: DeliveryForecastOptions): Promise<DeliveryForecast>;
|
|
39
39
|
/**
|
|
40
|
-
* Gets the delivery forecast for a list of existing {@link https://developers.google.com/ad-manager/api/reference/
|
|
40
|
+
* Gets the delivery forecast for a list of existing {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem LineItem}
|
|
41
41
|
* objects in a single delivery simulation.
|
|
42
42
|
* A delivery forecast reports the number of units that will be delivered to each line item given the line item goals and contentions from other line items.
|
|
43
43
|
*
|
|
@@ -1,20 +1,20 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Represents the actions that can be performed on {@link https://developers.google.com/ad-manager/api/reference/
|
|
2
|
+
* Represents the actions that can be performed on {@link https://developers.google.com/ad-manager/api/reference/latest/InventoryService.AdUnit AdUnit} objects.
|
|
3
3
|
*/
|
|
4
4
|
export declare abstract class AdUnitAction {
|
|
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/InventoryService.AdUnit AdUnit} objects.
|
|
8
8
|
*/
|
|
9
9
|
export declare class ActivateAdUnits implements AdUnitAction {
|
|
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/InventoryService.AdUnit AdUnit} objects.
|
|
13
13
|
*/
|
|
14
14
|
export declare class ArchiveAdUnits implements AdUnitAction {
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
|
-
* The action used for deactivating {@link https://developers.google.com/ad-manager/api/reference/
|
|
17
|
+
* The action used for deactivating {@link https://developers.google.com/ad-manager/api/reference/latest/InventoryService.AdUnit AdUnit} objects.
|
|
18
18
|
*/
|
|
19
19
|
export declare class DeactivateAdUnits implements AdUnitAction {
|
|
20
20
|
}
|
|
@@ -2,25 +2,25 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.DeactivateAdUnits = exports.ArchiveAdUnits = exports.ActivateAdUnits = exports.AdUnitAction = 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/InventoryService.AdUnit AdUnit} objects.
|
|
6
6
|
*/
|
|
7
7
|
class AdUnitAction {
|
|
8
8
|
}
|
|
9
9
|
exports.AdUnitAction = AdUnitAction;
|
|
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/InventoryService.AdUnit AdUnit} objects.
|
|
12
12
|
*/
|
|
13
13
|
class ActivateAdUnits {
|
|
14
14
|
}
|
|
15
15
|
exports.ActivateAdUnits = ActivateAdUnits;
|
|
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/InventoryService.AdUnit AdUnit} objects.
|
|
18
18
|
*/
|
|
19
19
|
class ArchiveAdUnits {
|
|
20
20
|
}
|
|
21
21
|
exports.ArchiveAdUnits = ArchiveAdUnits;
|
|
22
22
|
/**
|
|
23
|
-
* The action used for deactivating {@link https://developers.google.com/ad-manager/api/reference/
|
|
23
|
+
* The action used for deactivating {@link https://developers.google.com/ad-manager/api/reference/latest/InventoryService.AdUnit AdUnit} objects.
|
|
24
24
|
*/
|
|
25
25
|
class DeactivateAdUnits {
|
|
26
26
|
}
|
|
@@ -29,7 +29,7 @@ export declare enum InventoryStatus {
|
|
|
29
29
|
ARCHIVED = "ARCHIVED"
|
|
30
30
|
}
|
|
31
31
|
/**
|
|
32
|
-
* Specifies the type of ads that can be served through this {@link https://developers.google.com/ad-manager/api/reference/
|
|
32
|
+
* Specifies the type of ads that can be served through this {@link https://developers.google.com/ad-manager/api/reference/latest/InventoryService.AdUnit AdUnit}.
|
|
33
33
|
*/
|
|
34
34
|
export declare enum AdSenseSettingsAdType {
|
|
35
35
|
/**
|
|
@@ -46,7 +46,7 @@ export declare enum AdSenseSettingsAdType {
|
|
|
46
46
|
TEXT_AND_IMAGE = "TEXT_AND_IMAGE"
|
|
47
47
|
}
|
|
48
48
|
/**
|
|
49
|
-
* Describes the border of the HTML elements used to surround an ad displayed by the {@link https://developers.google.com/ad-manager/api/reference/
|
|
49
|
+
* Describes the border of the HTML elements used to surround an ad displayed by the {@link https://developers.google.com/ad-manager/api/reference/latest/InventoryService.AdUnit AdUnit}.
|
|
50
50
|
*/
|
|
51
51
|
export declare enum AdSenseSettingsBorderStyle {
|
|
52
52
|
/**
|
|
@@ -34,7 +34,7 @@ var InventoryStatus;
|
|
|
34
34
|
InventoryStatus["ARCHIVED"] = "ARCHIVED";
|
|
35
35
|
})(InventoryStatus || (exports.InventoryStatus = InventoryStatus = {}));
|
|
36
36
|
/**
|
|
37
|
-
* Specifies the type of ads that can be served through this {@link https://developers.google.com/ad-manager/api/reference/
|
|
37
|
+
* Specifies the type of ads that can be served through this {@link https://developers.google.com/ad-manager/api/reference/latest/InventoryService.AdUnit AdUnit}.
|
|
38
38
|
*/
|
|
39
39
|
var AdSenseSettingsAdType;
|
|
40
40
|
(function (AdSenseSettingsAdType) {
|
|
@@ -52,7 +52,7 @@ var AdSenseSettingsAdType;
|
|
|
52
52
|
AdSenseSettingsAdType["TEXT_AND_IMAGE"] = "TEXT_AND_IMAGE";
|
|
53
53
|
})(AdSenseSettingsAdType || (exports.AdSenseSettingsAdType = AdSenseSettingsAdType = {}));
|
|
54
54
|
/**
|
|
55
|
-
* Describes the border of the HTML elements used to surround an ad displayed by the {@link https://developers.google.com/ad-manager/api/reference/
|
|
55
|
+
* Describes the border of the HTML elements used to surround an ad displayed by the {@link https://developers.google.com/ad-manager/api/reference/latest/InventoryService.AdUnit AdUnit}.
|
|
56
56
|
*/
|
|
57
57
|
var AdSenseSettingsBorderStyle;
|
|
58
58
|
(function (AdSenseSettingsBorderStyle) {
|