@guardian/google-admanager-api 6.1.0 → 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 +7 -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 +14 -16
- package/dist/client/common/types/targeting.type.d.ts.map +1 -1
- package/dist/client/common/types/targeting.type.js +8 -9
- package/dist/client/common/types/targeting.type.js.map +1 -1
- package/dist/client/services/activity/activity.type.d.ts +4 -4
- package/dist/client/services/activity/activityService.interface.d.ts +12 -12
- package/dist/client/services/activityGroup/activityGroup.type.d.ts +4 -4
- package/dist/client/services/activityGroup/activityGroupService.interface.d.ts +11 -11
- package/dist/client/services/adRule/adRule.type.d.ts +2 -2
- package/dist/client/services/adRule/adSpot.type.d.ts +1 -1
- package/dist/client/services/adjustment/adjustment.enum.d.ts +1 -1
- package/dist/client/services/adjustment/adjustment.enum.js +1 -1
- package/dist/client/services/adjustment/adjustment.type.d.ts +1 -1
- package/dist/client/services/adjustment/adjustmentService.interface.d.ts +23 -23
- package/dist/client/services/audienceSegment/audienceSegment.action.d.ts +6 -6
- package/dist/client/services/audienceSegment/audienceSegment.action.js +6 -6
- package/dist/client/services/audienceSegment/audienceSegment.enum.d.ts +4 -4
- package/dist/client/services/audienceSegment/audienceSegment.enum.js +4 -4
- package/dist/client/services/audienceSegment/audienceSegment.type.d.ts +14 -14
- package/dist/client/services/audienceSegment/audienceSegmentService.interface.d.ts +17 -17
- package/dist/client/services/cdnConfiguration/cdnConfiguration.action.d.ts +3 -3
- package/dist/client/services/cdnConfiguration/cdnConfiguration.action.js +3 -3
- package/dist/client/services/cdnConfiguration/cdnConfiguration.enum.d.ts +3 -3
- package/dist/client/services/cdnConfiguration/cdnConfiguration.enum.js +3 -3
- package/dist/client/services/cdnConfiguration/cdnConfiguration.interface.d.ts +11 -11
- package/dist/client/services/cdnConfiguration/cdnConfiguration.type.d.ts +1 -1
- package/dist/client/services/cmsMetadata/cmsMetadata.action.d.ts +6 -6
- package/dist/client/services/cmsMetadata/cmsMetadata.action.js +6 -6
- package/dist/client/services/cmsMetadata/cmsMetadataService.interface.d.ts +16 -16
- package/dist/client/services/company/company.type.d.ts +3 -3
- package/dist/client/services/company/companyService.interface.d.ts +11 -11
- package/dist/client/services/contact/contact.type.d.ts +2 -2
- package/dist/client/services/contact/contactService.interface.d.ts +15 -15
- package/dist/client/services/content/content.enum.d.ts +2 -2
- package/dist/client/services/content/content.enum.js +2 -2
- package/dist/client/services/content/content.type.d.ts +1 -1
- package/dist/client/services/content/contentService.interface.d.ts +15 -15
- package/dist/client/services/contentBundle/contentBundle.action.d.ts +3 -3
- package/dist/client/services/contentBundle/contentBundle.action.js +3 -3
- package/dist/client/services/contentBundle/contentBundle.type.d.ts +2 -2
- package/dist/client/services/contentBundle/contentBundleService.interface.d.ts +10 -10
- package/dist/client/services/creative/creative.action.d.ts +3 -3
- package/dist/client/services/creative/creative.action.js +3 -3
- package/dist/client/services/creative/creative.type.d.ts +1 -1
- package/dist/client/services/creative/creativeService.interface.d.ts +15 -15
- package/dist/client/services/creativeReview/creativeReviewService.interface.d.ts +4 -4
- package/dist/client/services/creativeSet/creativeSet.type.d.ts +1 -1
- package/dist/client/services/creativeSet/creativeSetService.interface.d.ts +10 -10
- package/dist/client/services/creativeTemplate/creativeTemplate.type.d.ts +1 -1
- package/dist/client/services/creativeTemplate/creativeTemplateService.interface.d.ts +8 -8
- package/dist/client/services/creativeWrapper/creativeWrapper.action.d.ts +3 -3
- package/dist/client/services/creativeWrapper/creativeWrapper.action.js +3 -3
- package/dist/client/services/creativeWrapper/creativeWrapper.type.d.ts +1 -1
- package/dist/client/services/creativeWrapper/creativeWrapperService.interface.d.ts +15 -15
- package/dist/client/services/customField/customField.action.d.ts +3 -3
- package/dist/client/services/customField/customField.action.js +3 -3
- package/dist/client/services/customField/customField.enum.d.ts +1 -1
- package/dist/client/services/customField/customField.enum.js +1 -1
- package/dist/client/services/customField/customField.type.d.ts +3 -3
- package/dist/client/services/customField/customFieldService.interface.d.ts +22 -22
- package/dist/client/services/customTargeting/customTargeting.action.d.ts +6 -6
- package/dist/client/services/customTargeting/customTargeting.action.js +6 -6
- package/dist/client/services/customTargeting/customTargeting.enum.d.ts +1 -1
- package/dist/client/services/customTargeting/customTargeting.enum.js +1 -1
- package/dist/client/services/customTargeting/customTargeting.interface.d.ts +29 -29
- package/dist/client/services/customTargeting/customTargeting.type.d.ts +2 -2
- package/dist/client/services/daiAuthenticationKey/daiAuthenticationKey.action.d.ts +3 -3
- package/dist/client/services/daiAuthenticationKey/daiAuthenticationKey.action.js +3 -3
- package/dist/client/services/daiAuthenticationKey/daiAuthenticationKey.type.d.ts +1 -1
- package/dist/client/services/daiAuthenticationKey/daiAuthenticationKeyService.interface.d.ts +13 -13
- package/dist/client/services/daiEncodingProfile/daiEncodingProfile.action.d.ts +3 -3
- package/dist/client/services/daiEncodingProfile/daiEncodingProfile.action.js +3 -3
- package/dist/client/services/daiEncodingProfile/daiEncodingProfile.enum.d.ts +1 -1
- package/dist/client/services/daiEncodingProfile/daiEncodingProfile.enum.js +1 -1
- package/dist/client/services/daiEncodingProfile/daiEncodingProfile.type.d.ts +2 -2
- package/dist/client/services/daiEncodingProfile/daiEncodingProfileService.interface.d.ts +11 -11
- package/dist/client/services/forecast/forecast.type.d.ts +1 -1
- package/dist/client/services/forecast/forecastService.interface.d.ts +9 -9
- package/dist/client/services/inventory/adUnit.action.d.ts +4 -4
- package/dist/client/services/inventory/adUnit.action.js +4 -4
- package/dist/client/services/inventory/adUnit.enum.d.ts +2 -2
- package/dist/client/services/inventory/adUnit.enum.js +2 -2
- package/dist/client/services/inventory/adUnit.type.d.ts +2 -2
- package/dist/client/services/inventory/inventoryService.interface.d.ts +16 -16
- package/dist/client/services/label/label.action.d.ts +3 -3
- package/dist/client/services/label/label.action.js +3 -3
- package/dist/client/services/label/label.interface.d.ts +11 -11
- package/dist/client/services/label/label.type.d.ts +1 -1
- package/dist/client/services/lineItem/lineItem.action.d.ts +9 -9
- package/dist/client/services/lineItem/lineItem.action.js +9 -9
- package/dist/client/services/lineItem/lineItem.type.d.ts +2 -2
- package/dist/client/services/lineItem/lineItemService.interface.d.ts +23 -23
- package/dist/client/services/lineItemCreativeAssociation/lineItemCreativeAssociation.action.d.ts +4 -4
- package/dist/client/services/lineItemCreativeAssociation/lineItemCreativeAssociation.action.js +4 -4
- package/dist/client/services/lineItemCreativeAssociation/lineItemCreativeAssociation.type.d.ts +6 -6
- package/dist/client/services/lineItemCreativeAssociation/lineItemCreativeAssociationService.interface.d.ts +18 -18
- package/dist/client/services/lineItemTemplate/lineItemTemplate.type.d.ts +1 -1
- package/dist/client/services/lineItemTemplate/lineItemTemplateService.interface.d.ts +5 -5
- package/dist/client/services/liveStreamEvent/liveStreamEvent.action.d.ts +7 -7
- package/dist/client/services/liveStreamEvent/liveStreamEvent.action.js +7 -7
- package/dist/client/services/liveStreamEvent/liveStreamEvent.enum.d.ts +2 -2
- package/dist/client/services/liveStreamEvent/liveStreamEvent.enum.js +2 -2
- package/dist/client/services/liveStreamEvent/liveStreamEvent.type.d.ts +1 -1
- package/dist/client/services/liveStreamEvent/liveStreamEventService.interface.d.ts +29 -29
- package/dist/client/services/mobileApplication/mobileApplication.action.d.ts +3 -3
- package/dist/client/services/mobileApplication/mobileApplication.action.js +3 -3
- package/dist/client/services/mobileApplication/mobileApplication.enum.d.ts +2 -2
- package/dist/client/services/mobileApplication/mobileApplication.enum.js +2 -2
- package/dist/client/services/mobileApplication/mobileApplication.type.d.ts +1 -1
- package/dist/client/services/mobileApplication/mobileApplicationService.interface.d.ts +12 -12
- package/dist/client/services/nativeStyle/nativeStyle.type.d.ts +1 -1
- package/dist/client/services/nativeStyle/nativeStyleService.interface.d.ts +9 -9
- package/dist/client/services/order/order.action.d.ts +13 -13
- package/dist/client/services/order/order.action.js +13 -13
- package/dist/client/services/order/order.enum.d.ts +5 -5
- package/dist/client/services/order/order.enum.js +5 -5
- package/dist/client/services/order/order.type.d.ts +13 -13
- package/dist/client/services/order/orderService.interface.d.ts +18 -18
- package/dist/client/services/placement/placement.action.d.ts +4 -4
- package/dist/client/services/placement/placement.action.js +4 -4
- package/dist/client/services/placement/placement.type.d.ts +1 -1
- package/dist/client/services/placement/placementService.interface.d.ts +13 -13
- package/dist/client/services/proposal/proposal.action.d.ts +15 -15
- package/dist/client/services/proposal/proposal.action.js +15 -15
- package/dist/client/services/proposal/proposal.enum.d.ts +1 -1
- package/dist/client/services/proposal/proposal.enum.js +1 -1
- package/dist/client/services/proposal/proposal.type.d.ts +3 -3
- package/dist/client/services/proposal/proposalService.interface.d.ts +26 -26
- package/dist/client/services/proposalLineItem/proposalLineItem.action.d.ts +10 -10
- package/dist/client/services/proposalLineItem/proposalLineItem.action.js +10 -10
- package/dist/client/services/proposalLineItem/proposalLineItem.type.d.ts +3 -3
- package/dist/client/services/proposalLineItem/proposalLineItemService.interface.d.ts +15 -15
- package/dist/client/services/publisherQueryLanguage/publisherQueryLanguageService.interface.d.ts +3 -3
- package/dist/client/services/report/report.type.d.ts +2 -2
- package/dist/client/services/report/reportService.interface.d.ts +16 -16
- package/dist/client/services/site/siteService.interface.d.ts +13 -13
- package/dist/client/services/suggestedAdUnit/suggestedAdUnit.action.d.ts +2 -2
- package/dist/client/services/suggestedAdUnit/suggestedAdUnit.action.js +2 -2
- package/dist/client/services/suggestedAdUnit/suggestedAdUnit.type.d.ts +2 -2
- package/dist/client/services/suggestedAdUnit/suggestedAdUnitService.interface.d.ts +9 -9
- package/dist/client/services/targetingPresent/targetingPresentService.interface.d.ts +5 -5
- package/dist/client/services/team/team.action.d.ts +3 -3
- package/dist/client/services/team/team.action.js +3 -3
- package/dist/client/services/team/team.type.d.ts +2 -2
- package/dist/client/services/team/teamService.interface.d.ts +12 -12
- package/dist/client/services/user/user.action.d.ts +3 -3
- package/dist/client/services/user/user.action.js +3 -3
- package/dist/client/services/user/user.type.d.ts +5 -5
- package/dist/client/services/user/userService.interface.d.ts +17 -17
- package/dist/client/services/userTeamAssociation/userTeamAssociation.action.d.ts +2 -2
- package/dist/client/services/userTeamAssociation/userTeamAssociation.action.js +2 -2
- package/dist/client/services/userTeamAssociation/userTeamAssociation.type.d.ts +5 -5
- package/dist/client/services/userTeamAssociation/userTeamAssociationService.interface.d.ts +10 -10
- package/dist/common/types/statement.type.d.ts +4 -4
- package/package.json +1 -1
|
@@ -3,36 +3,36 @@ import type { AudienceSegmentAction } from "./audienceSegment.action";
|
|
|
3
3
|
import type { AudienceSegmentPage, FirstPartyAudienceSegment } from "./audienceSegment.type";
|
|
4
4
|
/**
|
|
5
5
|
* Provides operations 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/AudienceSegmentService.AudienceSegment AudienceSegment} objects.
|
|
7
7
|
*
|
|
8
8
|
*/
|
|
9
9
|
export interface AudienceSegmentServiceOperations {
|
|
10
10
|
/**
|
|
11
|
-
* Creates new {@link https://developers.google.com/ad-manager/api/reference/
|
|
11
|
+
* Creates new {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.FirstPartyAudienceSegment FirstPartyAudienceSegment} objects.
|
|
12
12
|
*
|
|
13
13
|
* @param segments first-party audience segments to create
|
|
14
14
|
* @returns created first-party audience segments
|
|
15
15
|
*/
|
|
16
16
|
createAudienceSegments(segments: Partial<FirstPartyAudienceSegment>[]): Promise<FirstPartyAudienceSegment[]>;
|
|
17
17
|
/**
|
|
18
|
-
* Gets an {@link https://developers.google.com/ad-manager/api/reference/
|
|
19
|
-
* of {@link https://developers.google.com/ad-manager/api/reference/
|
|
20
|
-
* objects that satisfy the given {@link https://developers.google.com/ad-manager/api/reference/
|
|
18
|
+
* Gets an {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.AudienceSegmentPage AudienceSegmentPage}
|
|
19
|
+
* of {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.AudienceSegment AudienceSegment}
|
|
20
|
+
* objects that satisfy the given {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.Statement#query Statement.query}.
|
|
21
21
|
* The following fields are supported for filtering:
|
|
22
22
|
*
|
|
23
23
|
* | PQL Property | PQL Property |
|
|
24
24
|
* | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
25
|
-
* | id | {@link https://developers.google.com/ad-manager/api/reference/
|
|
26
|
-
* | name | {@link https://developers.google.com/ad-manager/api/reference/
|
|
27
|
-
* | status | {@link https://developers.google.com/ad-manager/api/reference/
|
|
28
|
-
* | type | {@link https://developers.google.com/ad-manager/api/reference/
|
|
29
|
-
* | size | {@link https://developers.google.com/ad-manager/api/reference/
|
|
30
|
-
* | dataProviderName | {@link https://developers.google.com/ad-manager/api/reference/
|
|
31
|
-
* | segmentType | {@link https://developers.google.com/ad-manager/api/reference/
|
|
32
|
-
* | approvalStatus | {@link https://developers.google.com/ad-manager/api/reference/
|
|
33
|
-
* | cost | {@link https://developers.google.com/ad-manager/api/reference/
|
|
34
|
-
* | startDateTime | {@link https://developers.google.com/ad-manager/api/reference/
|
|
35
|
-
* | endDateTime | {@link https://developers.google.com/ad-manager/api/reference/
|
|
25
|
+
* | id | {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.AudienceSegment#id AudienceSegment.id} |
|
|
26
|
+
* | name | {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.AudienceSegment#name AudienceSegment.name} |
|
|
27
|
+
* | status | {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.AudienceSegment#status AudienceSegment.status} |
|
|
28
|
+
* | type | {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.AudienceSegment#type AudienceSegment.type} |
|
|
29
|
+
* | size | {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.AudienceSegment#size AudienceSegment.size} |
|
|
30
|
+
* | dataProviderName | {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.AudienceSegmentDataProvider#name AudienceSegmentDataProvider.name} |
|
|
31
|
+
* | segmentType | {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.AudienceSegment#type AudienceSegment.type} |
|
|
32
|
+
* | approvalStatus | {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.ThirdPartyAudienceSegment#approvalStatus ThirdPartyAudienceSegment.approvalStatus} |
|
|
33
|
+
* | cost | {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.ThirdPartyAudienceSegment#cost ThirdPartyAudienceSegment.cost} |
|
|
34
|
+
* | startDateTime | {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.ThirdPartyAudienceSegment#startDateTime ThirdPartyAudienceSegment.startDateTime} |
|
|
35
|
+
* | endDateTime | {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.ThirdPartyAudienceSegment#endDateTime ThirdPartyAudienceSegment.endDateTime} |
|
|
36
36
|
*
|
|
37
37
|
* @param filterStatement a Publisher Query Language statement used to filter a set of audience segments (the only supported operator is AND)
|
|
38
38
|
* @returns the audience segments that match the given filter
|
|
@@ -47,7 +47,7 @@ export interface AudienceSegmentServiceOperations {
|
|
|
47
47
|
*/
|
|
48
48
|
performAudienceSegmentAction(action: AudienceSegmentAction, filterStatement: Statement): Promise<UpdateResult>;
|
|
49
49
|
/**
|
|
50
|
-
* Updates the given {@link https://developers.google.com/ad-manager/api/reference/
|
|
50
|
+
* Updates the given {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.FirstPartyAudienceSegment FirstPartyAudienceSegment} objects.
|
|
51
51
|
*
|
|
52
52
|
* @param segments first-party audience segments to update
|
|
53
53
|
* @returns updated first-party audience segments
|
|
@@ -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/CdnConfigurationService.CdnConfiguration CdnConfiguration} objects.
|
|
3
3
|
*/
|
|
4
4
|
export declare abstract class CdnConfigurationAction {
|
|
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/CdnConfigurationService.CdnConfiguration CdnConfiguration} objects.
|
|
8
8
|
*/
|
|
9
9
|
export declare class ActivateCdnConfigurations implements CdnConfigurationAction {
|
|
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/CdnConfigurationService.CdnConfiguration CdnConfiguration} objects.
|
|
13
13
|
*/
|
|
14
14
|
export declare class ArchiveCdnConfigurations implements CdnConfigurationAction {
|
|
15
15
|
}
|
|
@@ -2,19 +2,19 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.ArchiveCdnConfigurations = exports.ActivateCdnConfigurations = exports.CdnConfigurationAction = 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/CdnConfigurationService.CdnConfiguration CdnConfiguration} objects.
|
|
6
6
|
*/
|
|
7
7
|
class CdnConfigurationAction {
|
|
8
8
|
}
|
|
9
9
|
exports.CdnConfigurationAction = CdnConfigurationAction;
|
|
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/CdnConfigurationService.CdnConfiguration CdnConfiguration} objects.
|
|
12
12
|
*/
|
|
13
13
|
class ActivateCdnConfigurations {
|
|
14
14
|
}
|
|
15
15
|
exports.ActivateCdnConfigurations = ActivateCdnConfigurations;
|
|
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/CdnConfigurationService.CdnConfiguration CdnConfiguration} objects.
|
|
18
18
|
*/
|
|
19
19
|
class ArchiveCdnConfigurations {
|
|
20
20
|
}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Indicates the type of CDN configuration for {@link https://developers.google.com/ad-manager/api/reference/
|
|
2
|
+
* Indicates the type of CDN configuration for {@link https://developers.google.com/ad-manager/api/reference/latest/CdnConfigurationService.CdnConfiguration CdnConfiguration}.
|
|
3
3
|
*/
|
|
4
4
|
export declare enum CdnConfigurationType {
|
|
5
5
|
/**
|
|
@@ -12,7 +12,7 @@ export declare enum CdnConfigurationType {
|
|
|
12
12
|
LIVE_STREAM_SOURCE_CONTENT = "LIVE_STREAM_SOURCE_CONTENT"
|
|
13
13
|
}
|
|
14
14
|
/**
|
|
15
|
-
* Indicates the status of the {@link https://developers.google.com/ad-manager/api/reference/
|
|
15
|
+
* Indicates the status of the {@link https://developers.google.com/ad-manager/api/reference/latest/CdnConfigurationService.CdnConfiguration CdnConfiguration}.
|
|
16
16
|
*/
|
|
17
17
|
export declare enum CdnConfigurationStatus {
|
|
18
18
|
/**
|
|
@@ -47,7 +47,7 @@ export declare enum SecurityPolicyType {
|
|
|
47
47
|
}
|
|
48
48
|
/**
|
|
49
49
|
* Indicates the type of origin forwarding used to support Akamai authentication policies for
|
|
50
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
50
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent LiveStreamEvent}
|
|
51
51
|
*/
|
|
52
52
|
export declare enum OriginForwardingType {
|
|
53
53
|
/**
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.OriginForwardingType = exports.SecurityPolicyType = exports.CdnConfigurationStatus = exports.CdnConfigurationType = void 0;
|
|
4
4
|
/**
|
|
5
|
-
* Indicates the type of CDN configuration for {@link https://developers.google.com/ad-manager/api/reference/
|
|
5
|
+
* Indicates the type of CDN configuration for {@link https://developers.google.com/ad-manager/api/reference/latest/CdnConfigurationService.CdnConfiguration CdnConfiguration}.
|
|
6
6
|
*/
|
|
7
7
|
var CdnConfigurationType;
|
|
8
8
|
(function (CdnConfigurationType) {
|
|
@@ -16,7 +16,7 @@ var CdnConfigurationType;
|
|
|
16
16
|
CdnConfigurationType["LIVE_STREAM_SOURCE_CONTENT"] = "LIVE_STREAM_SOURCE_CONTENT";
|
|
17
17
|
})(CdnConfigurationType || (exports.CdnConfigurationType = CdnConfigurationType = {}));
|
|
18
18
|
/**
|
|
19
|
-
* Indicates the status of the {@link https://developers.google.com/ad-manager/api/reference/
|
|
19
|
+
* Indicates the status of the {@link https://developers.google.com/ad-manager/api/reference/latest/CdnConfigurationService.CdnConfiguration CdnConfiguration}.
|
|
20
20
|
*/
|
|
21
21
|
var CdnConfigurationStatus;
|
|
22
22
|
(function (CdnConfigurationStatus) {
|
|
@@ -53,7 +53,7 @@ var SecurityPolicyType;
|
|
|
53
53
|
})(SecurityPolicyType || (exports.SecurityPolicyType = SecurityPolicyType = {}));
|
|
54
54
|
/**
|
|
55
55
|
* Indicates the type of origin forwarding used to support Akamai authentication policies for
|
|
56
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
56
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent LiveStreamEvent}
|
|
57
57
|
*/
|
|
58
58
|
var OriginForwardingType;
|
|
59
59
|
(function (OriginForwardingType) {
|
|
@@ -3,34 +3,34 @@ import type { CdnConfigurationAction } from "./cdnConfiguration.action";
|
|
|
3
3
|
import type { CdnConfiguration, CdnConfigurationPage } from "./cdnConfiguration.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/CdnConfigurationService.CdnConfiguration CdnConfiguration} objects.
|
|
7
7
|
*/
|
|
8
8
|
export interface CdnConfigurationServiceOperations {
|
|
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/CdnConfigurationService.CdnConfiguration CdnConfiguration} objects.
|
|
11
11
|
*
|
|
12
12
|
* @param cdnConfigurations
|
|
13
13
|
*/
|
|
14
14
|
createCdnConfigurations(cdnConfigurations: Partial<CdnConfiguration>[]): Promise<CdnConfiguration[]>;
|
|
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
|
-
* the given {@link https://developers.google.com/ad-manager/api/reference/
|
|
16
|
+
* Gets a {@link https://developers.google.com/ad-manager/api/reference/latest/CdnConfigurationService.CdnConfigurationPage CdnConfigurationPage}
|
|
17
|
+
* of {@link https://developers.google.com/ad-manager/api/reference/latest/CdnConfigurationService.CdnConfiguration CdnConfiguration} objects that satisfy
|
|
18
|
+
* the given {@link https://developers.google.com/ad-manager/api/reference/latest/CdnConfigurationService.Statement#query Statement.query}.
|
|
19
19
|
* Currently only CDN Configurations of type
|
|
20
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
20
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CdnConfigurationService.CdnConfigurationType#LIVE_STREAM_SOURCE_CONTENT CdnConfigurationType.LIVE_STREAM_SOURCE_CONTENT}
|
|
21
21
|
* will be returned. The following fields are supported for filtering:
|
|
22
22
|
*
|
|
23
23
|
* | PQL Property | PQL Property |
|
|
24
24
|
* | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
25
|
-
* | id | {@link https://developers.google.com/ad-manager/api/reference/
|
|
26
|
-
* | name | {@link https://developers.google.com/ad-manager/api/reference/
|
|
25
|
+
* | id | {@link https://developers.google.com/ad-manager/api/reference/latest/CdnConfigurationService.CdnConfiguration#id CdnConfiguration.id} |
|
|
26
|
+
* | name | {@link https://developers.google.com/ad-manager/api/reference/latest/CdnConfigurationService.CdnConfiguration#name CdnConfiguration.name} |
|
|
27
27
|
*
|
|
28
28
|
* @param statement
|
|
29
29
|
*/
|
|
30
30
|
getCdnConfigurationsByStatement(statement: Statement): Promise<CdnConfigurationPage>;
|
|
31
31
|
/**
|
|
32
|
-
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/
|
|
33
|
-
* objects that match the given {@link https://developers.google.com/ad-manager/api/reference/
|
|
32
|
+
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/latest/CdnConfigurationService.CdnConfiguration CdnConfiguration}
|
|
33
|
+
* objects that match the given {@link https://developers.google.com/ad-manager/api/reference/latest/CdnConfigurationService.Statement#query Statement.query}.
|
|
34
34
|
*
|
|
35
35
|
* @param cdnConfigurationAction the action to perform
|
|
36
36
|
* @param filterStatement a Publisher Query Language statement used to filter a set of live stream events
|
|
@@ -38,7 +38,7 @@ export interface CdnConfigurationServiceOperations {
|
|
|
38
38
|
*/
|
|
39
39
|
performCdnConfigurationAction(cdnConfigurationAction: CdnConfigurationAction, filterStatement: Statement): Promise<UpdateResult>;
|
|
40
40
|
/**
|
|
41
|
-
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/
|
|
41
|
+
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/latest/CdnConfigurationService.CdnConfiguration CdnConfiguration} objects.
|
|
42
42
|
*
|
|
43
43
|
* @param cdnConfigurations
|
|
44
44
|
*/
|
|
@@ -103,7 +103,7 @@ export type CdnConfiguration = {
|
|
|
103
103
|
cdnConfigurationStatus: CdnConfigurationStatus;
|
|
104
104
|
};
|
|
105
105
|
/**
|
|
106
|
-
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/
|
|
106
|
+
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/latest/CdnConfigurationService.CdnConfiguration CdnConfiguration} objects.
|
|
107
107
|
*/
|
|
108
108
|
export type CdnConfigurationPage = PageResult<CdnConfiguration>;
|
|
109
109
|
export {};
|
|
@@ -1,32 +1,32 @@
|
|
|
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/CmsMetadataService.CmsMetadataKey CmsMetadataKey} objects.
|
|
4
4
|
*/
|
|
5
5
|
export declare abstract class CmsMetadataKeyAction {
|
|
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/CmsMetadataService.CmsMetadataKey CmsMetadataKey} objects.
|
|
9
9
|
*/
|
|
10
10
|
export declare class ActivateCmsMetadataKeys implements CmsMetadataKeyAction {
|
|
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/CmsMetadataService.CmsMetadataKey CmsMetadataKey} objects.
|
|
14
14
|
*/
|
|
15
15
|
export declare class DeactivateCmsMetadataKeys implements CmsMetadataKeyAction {
|
|
16
16
|
}
|
|
17
17
|
/**
|
|
18
18
|
* Represents the actions that can be performed on
|
|
19
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
19
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CmsMetadataService.CmsMetadataValue CmsMetadataValue} objects.
|
|
20
20
|
*/
|
|
21
21
|
export declare abstract class CmsMetadataValueAction {
|
|
22
22
|
}
|
|
23
23
|
/**
|
|
24
|
-
* The action used for activating {@link https://developers.google.com/ad-manager/api/reference/
|
|
24
|
+
* The action used for activating {@link https://developers.google.com/ad-manager/api/reference/latest/CmsMetadataService.CmsMetadataValue CmsMetadataValue} objects.
|
|
25
25
|
*/
|
|
26
26
|
export declare class ActivateCmsMetadataValues implements CmsMetadataValueAction {
|
|
27
27
|
}
|
|
28
28
|
/**
|
|
29
|
-
* The action used for deactivating {@link https://developers.google.com/ad-manager/api/reference/
|
|
29
|
+
* The action used for deactivating {@link https://developers.google.com/ad-manager/api/reference/latest/CmsMetadataService.CmsMetadataValue CmsMetadataValue} objects.
|
|
30
30
|
*/
|
|
31
31
|
export declare class DeactivateCmsMetadataValues implements CmsMetadataValueAction {
|
|
32
32
|
}
|
|
@@ -3,38 +3,38 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.DeactivateCmsMetadataValues = exports.ActivateCmsMetadataValues = exports.CmsMetadataValueAction = exports.DeactivateCmsMetadataKeys = exports.ActivateCmsMetadataKeys = exports.CmsMetadataKeyAction = 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/CmsMetadataService.CmsMetadataKey CmsMetadataKey} objects.
|
|
7
7
|
*/
|
|
8
8
|
class CmsMetadataKeyAction {
|
|
9
9
|
}
|
|
10
10
|
exports.CmsMetadataKeyAction = CmsMetadataKeyAction;
|
|
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/CmsMetadataService.CmsMetadataKey CmsMetadataKey} objects.
|
|
13
13
|
*/
|
|
14
14
|
class ActivateCmsMetadataKeys {
|
|
15
15
|
}
|
|
16
16
|
exports.ActivateCmsMetadataKeys = ActivateCmsMetadataKeys;
|
|
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/CmsMetadataService.CmsMetadataKey CmsMetadataKey} objects.
|
|
19
19
|
*/
|
|
20
20
|
class DeactivateCmsMetadataKeys {
|
|
21
21
|
}
|
|
22
22
|
exports.DeactivateCmsMetadataKeys = DeactivateCmsMetadataKeys;
|
|
23
23
|
/**
|
|
24
24
|
* Represents the actions that can be performed on
|
|
25
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
25
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CmsMetadataService.CmsMetadataValue CmsMetadataValue} objects.
|
|
26
26
|
*/
|
|
27
27
|
class CmsMetadataValueAction {
|
|
28
28
|
}
|
|
29
29
|
exports.CmsMetadataValueAction = CmsMetadataValueAction;
|
|
30
30
|
/**
|
|
31
|
-
* The action used for activating {@link https://developers.google.com/ad-manager/api/reference/
|
|
31
|
+
* The action used for activating {@link https://developers.google.com/ad-manager/api/reference/latest/CmsMetadataService.CmsMetadataValue CmsMetadataValue} objects.
|
|
32
32
|
*/
|
|
33
33
|
class ActivateCmsMetadataValues {
|
|
34
34
|
}
|
|
35
35
|
exports.ActivateCmsMetadataValues = ActivateCmsMetadataValues;
|
|
36
36
|
/**
|
|
37
|
-
* The action used for deactivating {@link https://developers.google.com/ad-manager/api/reference/
|
|
37
|
+
* The action used for deactivating {@link https://developers.google.com/ad-manager/api/reference/latest/CmsMetadataService.CmsMetadataValue CmsMetadataValue} objects.
|
|
38
38
|
*/
|
|
39
39
|
class DeactivateCmsMetadataValues {
|
|
40
40
|
}
|
|
@@ -8,38 +8,38 @@ import type { CmsMetadataKeyPage, CmsMetadataValuePage } from "./cmsMetadata.typ
|
|
|
8
8
|
*/
|
|
9
9
|
export interface CmsMetadataServiceOperations {
|
|
10
10
|
/**
|
|
11
|
-
* Returns a page of {@link https://developers.google.com/ad-manager/api/reference/
|
|
12
|
-
* matching the specified {@link https://developers.google.com/ad-manager/api/reference/
|
|
11
|
+
* Returns a page of {@link https://developers.google.com/ad-manager/api/reference/latest/CmsMetadataService.CmsMetadataKey CmsMetadataKey}s
|
|
12
|
+
* matching the specified {@link https://developers.google.com/ad-manager/api/reference/latest/CmsMetadataService.Statement Statement}.
|
|
13
13
|
* The following fields are supported for filtering:
|
|
14
14
|
*
|
|
15
15
|
* | PQL Property | PQL Property |
|
|
16
16
|
* | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
17
|
-
* | id | {@link https://developers.google.com/ad-manager/api/reference/
|
|
18
|
-
* | cmsKey | {@link https://developers.google.com/ad-manager/api/reference/
|
|
19
|
-
* | status | {@link https://developers.google.com/ad-manager/api/reference/
|
|
17
|
+
* | id | {@link https://developers.google.com/ad-manager/api/reference/latest/CmsMetadataService.CmsMetadataKey#cmsMetadataKeyId CmsMetadataKey.cmsMetadataKeyId} |
|
|
18
|
+
* | cmsKey | {@link https://developers.google.com/ad-manager/api/reference/latest/CmsMetadataService.CmsMetadataKey#keyName CmsMetadataKey.keyName} |
|
|
19
|
+
* | status | {@link https://developers.google.com/ad-manager/api/reference/latest/CmsMetadataService.CmsMetadataKey#status CmsMetadataKey.status} |
|
|
20
20
|
*
|
|
21
21
|
* @param statement
|
|
22
22
|
*/
|
|
23
23
|
getCmsMetadataKeysByStatement(statement: Statement): Promise<CmsMetadataKeyPage>;
|
|
24
24
|
/**
|
|
25
|
-
* Returns a page of {@link https://developers.google.com/ad-manager/api/reference/
|
|
26
|
-
* matching the specified {@link https://developers.google.com/ad-manager/api/reference/
|
|
25
|
+
* Returns a page of {@link https://developers.google.com/ad-manager/api/reference/latest/CmsMetadataService.CmsMetadataValue CmsMetadataValue}s
|
|
26
|
+
* matching the specified {@link https://developers.google.com/ad-manager/api/reference/latest/CmsMetadataService.Statement Statement}.
|
|
27
27
|
* The following fields are supported for filtering:
|
|
28
28
|
*
|
|
29
29
|
* | PQL Property | PQL Property |
|
|
30
30
|
* | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
31
|
-
* | id | {@link https://developers.google.com/ad-manager/api/reference/
|
|
32
|
-
* | cmsValue | {@link https://developers.google.com/ad-manager/api/reference/
|
|
33
|
-
* | cmsKey | {@link https://developers.google.com/ad-manager/api/reference/
|
|
34
|
-
* | cmsKeyId | {@link https://developers.google.com/ad-manager/api/reference/
|
|
35
|
-
* | status | {@link https://developers.google.com/ad-manager/api/reference/
|
|
31
|
+
* | id | {@link https://developers.google.com/ad-manager/api/reference/latest/CmsMetadataService.CmsMetadataValue#cmsMetadataValueId CmsMetadataValue.cmsMetadataValueId} |
|
|
32
|
+
* | cmsValue | {@link https://developers.google.com/ad-manager/api/reference/latest/CmsMetadataService.CmsMetadataValue#valueName CmsMetadataValue.valueName} |
|
|
33
|
+
* | cmsKey | {@link https://developers.google.com/ad-manager/api/reference/latest/CmsMetadataService.CmsMetadataValue#key CmsMetadataValue.key} |
|
|
34
|
+
* | cmsKeyId | {@link https://developers.google.com/ad-manager/api/reference/latest/CmsMetadataService.CmsMetadataValue#key CmsMetadataValue.key} |
|
|
35
|
+
* | status | {@link https://developers.google.com/ad-manager/api/reference/latest/CmsMetadataService.CmsMetadataValue#status CmsMetadataValue.status} |
|
|
36
36
|
*
|
|
37
37
|
* @param statement
|
|
38
38
|
*/
|
|
39
39
|
getCmsMetadataValuesByStatement(statement: Statement): Promise<CmsMetadataValuePage>;
|
|
40
40
|
/**
|
|
41
|
-
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/
|
|
42
|
-
* objects that match the given {@link https://developers.google.com/ad-manager/api/reference/
|
|
41
|
+
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/latest/CmsMetadataService.CmsMetadataKey CmsMetadataKey}
|
|
42
|
+
* objects that match the given {@link https://developers.google.com/ad-manager/api/reference/latest/CmsMetadataService.Statement#query Statement.query}.
|
|
43
43
|
*
|
|
44
44
|
* @param keyAction the action to perform
|
|
45
45
|
* @param filterStatement a Publisher Query Language statement used to filter a set of cms metadata keys.
|
|
@@ -47,8 +47,8 @@ export interface CmsMetadataServiceOperations {
|
|
|
47
47
|
*/
|
|
48
48
|
performCmsMetadataKeyAction(keyAction: CmsMetadataKeyAction, filterStatement: Statement): Promise<UpdateResult>;
|
|
49
49
|
/**
|
|
50
|
-
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/
|
|
51
|
-
* objects that match the given {@link https://developers.google.com/ad-manager/api/reference/
|
|
50
|
+
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/latest/CmsMetadataService.CmsMetadataValue CmsMetadataValue}
|
|
51
|
+
* objects that match the given {@link https://developers.google.com/ad-manager/api/reference/latest/CmsMetadataService.Statement#query Statement.query}.
|
|
52
52
|
*
|
|
53
53
|
* @param keyAction the action to perform
|
|
54
54
|
* @param filterStatement a Publisher Query Language statement used to filter a set of cms metadata values.
|
|
@@ -2,11 +2,11 @@ import type { DateTime, PageResult } from "../../../common/types";
|
|
|
2
2
|
import type { AppliedLabel, ChildPublisher } from "../../common/types";
|
|
3
3
|
import type { CompanyCreditStatus, CompanyType } from "./company.enum";
|
|
4
4
|
/**
|
|
5
|
-
* Settings for a {@link https://developers.google.com/ad-manager/api/reference/
|
|
5
|
+
* Settings for a {@link https://developers.google.com/ad-manager/api/reference/latest/CompanyService.Company Company}.
|
|
6
6
|
*/
|
|
7
7
|
export type CompanySettings = object;
|
|
8
8
|
/**
|
|
9
|
-
* Information required for {@link https://developers.google.com/ad-manager/api/reference/
|
|
9
|
+
* Information required for {@link https://developers.google.com/ad-manager/api/reference/latest/CompanyService.Company Company} of Type VIEWABILITY_PROVIDER.
|
|
10
10
|
* It contains all of the data needed to capture viewability metrics.
|
|
11
11
|
*/
|
|
12
12
|
export type ViewabilityProvider = {
|
|
@@ -109,7 +109,7 @@ export type Company = {
|
|
|
109
109
|
* Represents the actions that can be performed on Company objects.
|
|
110
110
|
*/
|
|
111
111
|
/**
|
|
112
|
-
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/
|
|
112
|
+
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/latest/CompanyService.Company Company} objects.
|
|
113
113
|
*/
|
|
114
114
|
export type CompanyPage = PageResult<Company>;
|
|
115
115
|
//# sourceMappingURL=company.type.d.ts.map
|
|
@@ -2,35 +2,35 @@ import type { Statement, UpdateResult } from "../../../common/types";
|
|
|
2
2
|
import type { CompanyAction } from "./company.action";
|
|
3
3
|
import type { Company, CompanyPage } from "./company.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/CompanyService.Company Company} objects.
|
|
6
6
|
*/
|
|
7
7
|
export interface CompanyServiceOperations {
|
|
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/CompanyService.Company Company} objects.
|
|
10
10
|
*
|
|
11
11
|
* @param companies the companies to create
|
|
12
12
|
* @returns the created companies with their IDs filled in
|
|
13
13
|
*/
|
|
14
14
|
createCompanies(companies: Partial<Company>[]): Promise<Company[]>;
|
|
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/CompanyService.CompanyPage CompanyPage}
|
|
17
|
+
* of {@link https://developers.google.com/ad-manager/api/reference/latest/CompanyService.Company Company} objects that satisfy the given
|
|
18
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CompanyService.Statement#query Statement.query}.
|
|
19
19
|
* The following fields are supported for filtering:
|
|
20
20
|
*
|
|
21
21
|
* | PQL Property | PQL Property |
|
|
22
22
|
* | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
23
|
-
* | id | {@link https://developers.google.com/ad-manager/api/reference/
|
|
24
|
-
* | name | {@link https://developers.google.com/ad-manager/api/reference/
|
|
25
|
-
* | type | {@link https://developers.google.com/ad-manager/api/reference/
|
|
26
|
-
* | lastModifiedDateTime | {@link https://developers.google.com/ad-manager/api/reference/
|
|
23
|
+
* | id | {@link https://developers.google.com/ad-manager/api/reference/latest/CompanyService.Company#id Company.id} |
|
|
24
|
+
* | name | {@link https://developers.google.com/ad-manager/api/reference/latest/CompanyService.Company#name Company.name} |
|
|
25
|
+
* | type | {@link https://developers.google.com/ad-manager/api/reference/latest/CompanyService.Company#type Company.type} |
|
|
26
|
+
* | lastModifiedDateTime | {@link https://developers.google.com/ad-manager/api/reference/latest/CompanyService.Company#lastModifiedDateTime Company.lastModifiedDateTime} |
|
|
27
27
|
*
|
|
28
28
|
* @param filterStatement a Publisher Query Language statement used to filter a set of companies
|
|
29
29
|
* @returns the companies that match the given filter
|
|
30
30
|
*/
|
|
31
31
|
getCompaniesByStatement(filterStatement: Statement): Promise<CompanyPage>;
|
|
32
32
|
/**
|
|
33
|
-
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/
|
|
33
|
+
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/latest/CompanyService.Company Company} objects that match the given Statement.
|
|
34
34
|
*
|
|
35
35
|
* @param companyAction the action to perform
|
|
36
36
|
* @param filterStatement a PQL statement used to filter companies
|
|
@@ -38,7 +38,7 @@ export interface CompanyServiceOperations {
|
|
|
38
38
|
*/
|
|
39
39
|
performCompanyAction(companyAction: CompanyAction, filterStatement: Statement): Promise<UpdateResult>;
|
|
40
40
|
/**
|
|
41
|
-
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/
|
|
41
|
+
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/latest/CompanyService.Company Company} objects.
|
|
42
42
|
*
|
|
43
43
|
* @param companies the companies to update
|
|
44
44
|
* @returns the updated companies
|
|
@@ -5,7 +5,7 @@ import type { ContactStatus } from "./contact.enum";
|
|
|
5
5
|
*/
|
|
6
6
|
type BaseContact = object;
|
|
7
7
|
/**
|
|
8
|
-
* A Contact represents a person who is affiliated with a single {@link https://developers.google.com/ad-manager/api/reference/
|
|
8
|
+
* A Contact represents a person who is affiliated with a single {@link https://developers.google.com/ad-manager/api/reference/latest/CompanyService.Company?hl=pt Company}.
|
|
9
9
|
* A contact can have a variety of contact information associated to it, and can be invited to view their company's orders, line items, creatives, and reports.
|
|
10
10
|
*/
|
|
11
11
|
export type Contact = BaseContact & {
|
|
@@ -55,7 +55,7 @@ export type Contact = BaseContact & {
|
|
|
55
55
|
workPhone: string;
|
|
56
56
|
};
|
|
57
57
|
/**
|
|
58
|
-
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/
|
|
58
|
+
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/latest/ContactService.Contact?hl=pt Contact} objects.
|
|
59
59
|
*/
|
|
60
60
|
export type ContactPage = PageResult<Contact>;
|
|
61
61
|
export {};
|
|
@@ -5,37 +5,37 @@ import type { Contact, ContactPage } from "./contact.type";
|
|
|
5
5
|
*/
|
|
6
6
|
export interface ContactServiceOperations {
|
|
7
7
|
/**
|
|
8
|
-
* Creates new {@link https://developers.google.com/ad-manager/api/reference/
|
|
8
|
+
* Creates new {@link https://developers.google.com/ad-manager/api/reference/latest/ContactService.Contact Contact} objects.
|
|
9
9
|
*
|
|
10
10
|
* @param contacts the contacts to create
|
|
11
11
|
* @returns the created contacts with their IDs filled in
|
|
12
12
|
*/
|
|
13
13
|
createContacts(contacts: Partial<Contact>[]): Promise<Contact[]>;
|
|
14
14
|
/**
|
|
15
|
-
* Gets a {@link https://developers.google.com/ad-manager/api/reference/
|
|
16
|
-
* of {@link https://developers.google.com/ad-manager/api/reference/
|
|
17
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
15
|
+
* Gets a {@link https://developers.google.com/ad-manager/api/reference/latest/ContactService.ContactPage ContactPage}
|
|
16
|
+
* of {@link https://developers.google.com/ad-manager/api/reference/latest/ContactService.Contact Contact} objects that satisfy the given
|
|
17
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ContactService.Statement#query Statement.query}.
|
|
18
18
|
* The following fields are supported for filtering:
|
|
19
19
|
*
|
|
20
20
|
* | PQL Property | PQL Property |
|
|
21
21
|
* | ------------ | ------------------------------------------------------------------------------------------------------------------------- |
|
|
22
|
-
* | name | {@link https://developers.google.com/ad-manager/api/reference/
|
|
23
|
-
* | email | {@link https://developers.google.com/ad-manager/api/reference/
|
|
24
|
-
* | id | {@link https://developers.google.com/ad-manager/api/reference/
|
|
25
|
-
* | comment | {@link https://developers.google.com/ad-manager/api/reference/
|
|
26
|
-
* | title | {@link https://developers.google.com/ad-manager/api/reference/
|
|
27
|
-
* | companyId | {@link https://developers.google.com/ad-manager/api/reference/
|
|
28
|
-
* | cellPhone | {@link https://developers.google.com/ad-manager/api/reference/
|
|
29
|
-
* | workPhone | {@link https://developers.google.com/ad-manager/api/reference/
|
|
30
|
-
* | faxPhone | {@link https://developers.google.com/ad-manager/api/reference/
|
|
31
|
-
* | status | {@link https://developers.google.com/ad-manager/api/reference/
|
|
22
|
+
* | name | {@link https://developers.google.com/ad-manager/api/reference/latest/ContactService.Contact#name Contact.name} |
|
|
23
|
+
* | email | {@link https://developers.google.com/ad-manager/api/reference/latest/ContactService.Contact#email Contact.email} |
|
|
24
|
+
* | id | {@link https://developers.google.com/ad-manager/api/reference/latest/ContactService.Contact#id Contact.id} |
|
|
25
|
+
* | comment | {@link https://developers.google.com/ad-manager/api/reference/latest/ContactService.Contact#comment Contact.comment} |
|
|
26
|
+
* | title | {@link https://developers.google.com/ad-manager/api/reference/latest/ContactService.Contact#title Contact.title} |
|
|
27
|
+
* | companyId | {@link https://developers.google.com/ad-manager/api/reference/latest/ContactService.Contact#companyId Contact.companyId} |
|
|
28
|
+
* | cellPhone | {@link https://developers.google.com/ad-manager/api/reference/latest/ContactService.Contact#cellPhone Contact.cellPhone} |
|
|
29
|
+
* | workPhone | {@link https://developers.google.com/ad-manager/api/reference/latest/ContactService.Contact#workPhone Contact.workPhone} |
|
|
30
|
+
* | faxPhone | {@link https://developers.google.com/ad-manager/api/reference/latest/ContactService.Contact#faxPhone Contact.faxPhone} |
|
|
31
|
+
* | status | {@link https://developers.google.com/ad-manager/api/reference/latest/ContactService.Contact#status Contact.status} |
|
|
32
32
|
*
|
|
33
33
|
* @param statement
|
|
34
34
|
* @returns the contacts that match the given filter
|
|
35
35
|
*/
|
|
36
36
|
getContactsByStatement(statement: Statement): Promise<ContactPage>;
|
|
37
37
|
/**
|
|
38
|
-
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/
|
|
38
|
+
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/latest/ContactService.Contact Contact} objects.
|
|
39
39
|
*
|
|
40
40
|
* @param contacts the contacts to update
|
|
41
41
|
* @returns the updated contacts
|
|
@@ -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/ContentService.Content?hl=pt Content} object.
|
|
3
3
|
*/
|
|
4
4
|
export declare enum ContentStatus {
|
|
5
5
|
/**
|
|
@@ -33,7 +33,7 @@ export declare enum ContentStatusDefinedBy {
|
|
|
33
33
|
USER = "USER"
|
|
34
34
|
}
|
|
35
35
|
/**
|
|
36
|
-
* The status of the DAI ingestion process. Only content with a status of {@link https://developers.google.com/ad-manager/api/reference/
|
|
36
|
+
* The status of the DAI ingestion process. Only content with a status of {@link https://developers.google.com/ad-manager/api/reference/latest/ContentService.DaiIngestStatus#SUCCESS SUCCESS} will be available for dynamic ad insertion.
|
|
37
37
|
*/
|
|
38
38
|
export declare enum DaiIngestStatus {
|
|
39
39
|
/**
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.DaiIngestErrorReason = exports.DaiIngestStatus = exports.ContentStatusDefinedBy = exports.ContentStatus = 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/ContentService.Content?hl=pt Content} object.
|
|
6
6
|
*/
|
|
7
7
|
var ContentStatus;
|
|
8
8
|
(function (ContentStatus) {
|
|
@@ -38,7 +38,7 @@ var ContentStatusDefinedBy;
|
|
|
38
38
|
ContentStatusDefinedBy["USER"] = "USER";
|
|
39
39
|
})(ContentStatusDefinedBy || (exports.ContentStatusDefinedBy = ContentStatusDefinedBy = {}));
|
|
40
40
|
/**
|
|
41
|
-
* The status of the DAI ingestion process. Only content with a status of {@link https://developers.google.com/ad-manager/api/reference/
|
|
41
|
+
* The status of the DAI ingestion process. Only content with a status of {@link https://developers.google.com/ad-manager/api/reference/latest/ContentService.DaiIngestStatus#SUCCESS SUCCESS} will be available for dynamic ad insertion.
|
|
42
42
|
*/
|
|
43
43
|
var DaiIngestStatus;
|
|
44
44
|
(function (DaiIngestStatus) {
|
|
@@ -14,7 +14,7 @@ export type DaiIngestError = {
|
|
|
14
14
|
trigger: string;
|
|
15
15
|
};
|
|
16
16
|
/**
|
|
17
|
-
* Contains information about {@link https://developers.google.com/ad-manager/api/reference/
|
|
17
|
+
* Contains information about {@link https://developers.google.com/ad-manager/api/reference/latest/ContentService.Content Content} from the CMS it was ingested from.
|
|
18
18
|
*/
|
|
19
19
|
export type CmsContent = {
|
|
20
20
|
/**
|