@guardian/google-admanager-api 6.1.0 → 6.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +13 -0
- package/dist/client/common/enums/delivery.enum.d.ts +1 -1
- package/dist/client/common/enums/delivery.enum.js +1 -1
- package/dist/client/common/enums/general.enum.d.ts +7 -7
- package/dist/client/common/enums/general.enum.js +7 -7
- package/dist/client/common/enums/lineItemSummary.enum.d.ts +4 -4
- package/dist/client/common/enums/lineItemSummary.enum.js +4 -4
- package/dist/client/common/types/general.type.d.ts +21 -21
- package/dist/client/common/types/label.type.d.ts +2 -2
- package/dist/client/common/types/lineItemSummary.type.d.ts +7 -7
- package/dist/client/common/types/targeting.type.d.ts +16 -18
- package/dist/client/common/types/targeting.type.d.ts.map +1 -1
- package/dist/client/common/types/targeting.type.js +10 -11
- package/dist/client/common/types/targeting.type.js.map +1 -1
- package/dist/client/services/activity/activity.type.d.ts +4 -4
- package/dist/client/services/activity/activityService.interface.d.ts +12 -12
- package/dist/client/services/activityGroup/activityGroup.type.d.ts +4 -4
- package/dist/client/services/activityGroup/activityGroupService.interface.d.ts +11 -11
- package/dist/client/services/adRule/adRule.type.d.ts +2 -2
- package/dist/client/services/adRule/adSpot.type.d.ts +1 -1
- package/dist/client/services/adjustment/adjustment.enum.d.ts +1 -1
- package/dist/client/services/adjustment/adjustment.enum.js +1 -1
- package/dist/client/services/adjustment/adjustment.type.d.ts +1 -1
- package/dist/client/services/adjustment/adjustmentService.interface.d.ts +23 -23
- package/dist/client/services/audienceSegment/audienceSegment.action.d.ts +6 -6
- package/dist/client/services/audienceSegment/audienceSegment.action.js +6 -6
- package/dist/client/services/audienceSegment/audienceSegment.enum.d.ts +4 -4
- package/dist/client/services/audienceSegment/audienceSegment.enum.js +4 -4
- package/dist/client/services/audienceSegment/audienceSegment.type.d.ts +14 -14
- package/dist/client/services/audienceSegment/audienceSegmentService.interface.d.ts +17 -17
- package/dist/client/services/cdnConfiguration/cdnConfiguration.action.d.ts +3 -3
- package/dist/client/services/cdnConfiguration/cdnConfiguration.action.js +3 -3
- package/dist/client/services/cdnConfiguration/cdnConfiguration.enum.d.ts +3 -3
- package/dist/client/services/cdnConfiguration/cdnConfiguration.enum.js +3 -3
- package/dist/client/services/cdnConfiguration/cdnConfiguration.interface.d.ts +11 -11
- package/dist/client/services/cdnConfiguration/cdnConfiguration.type.d.ts +1 -1
- package/dist/client/services/cmsMetadata/cmsMetadata.action.d.ts +6 -6
- package/dist/client/services/cmsMetadata/cmsMetadata.action.js +6 -6
- package/dist/client/services/cmsMetadata/cmsMetadataService.interface.d.ts +16 -16
- package/dist/client/services/company/company.type.d.ts +3 -3
- package/dist/client/services/company/companyService.interface.d.ts +11 -11
- package/dist/client/services/contact/contact.type.d.ts +2 -2
- package/dist/client/services/contact/contactService.interface.d.ts +15 -15
- package/dist/client/services/content/content.enum.d.ts +2 -2
- package/dist/client/services/content/content.enum.js +2 -2
- package/dist/client/services/content/content.type.d.ts +1 -1
- package/dist/client/services/content/contentService.interface.d.ts +15 -15
- package/dist/client/services/contentBundle/contentBundle.action.d.ts +3 -3
- package/dist/client/services/contentBundle/contentBundle.action.js +3 -3
- package/dist/client/services/contentBundle/contentBundle.type.d.ts +2 -2
- package/dist/client/services/contentBundle/contentBundleService.interface.d.ts +10 -10
- package/dist/client/services/creative/creative.action.d.ts +3 -3
- package/dist/client/services/creative/creative.action.js +3 -3
- package/dist/client/services/creative/creative.type.d.ts +1 -1
- package/dist/client/services/creative/creativeService.interface.d.ts +15 -15
- package/dist/client/services/creativeReview/creativeReviewService.interface.d.ts +4 -4
- package/dist/client/services/creativeSet/creativeSet.type.d.ts +1 -1
- package/dist/client/services/creativeSet/creativeSetService.interface.d.ts +10 -10
- package/dist/client/services/creativeTemplate/creativeTemplate.type.d.ts +1 -1
- package/dist/client/services/creativeTemplate/creativeTemplateService.interface.d.ts +8 -8
- package/dist/client/services/creativeWrapper/creativeWrapper.action.d.ts +3 -3
- package/dist/client/services/creativeWrapper/creativeWrapper.action.js +3 -3
- package/dist/client/services/creativeWrapper/creativeWrapper.type.d.ts +1 -1
- package/dist/client/services/creativeWrapper/creativeWrapperService.interface.d.ts +15 -15
- package/dist/client/services/customField/customField.action.d.ts +3 -3
- package/dist/client/services/customField/customField.action.js +3 -3
- package/dist/client/services/customField/customField.enum.d.ts +1 -1
- package/dist/client/services/customField/customField.enum.js +1 -1
- package/dist/client/services/customField/customField.type.d.ts +3 -3
- package/dist/client/services/customField/customFieldService.interface.d.ts +22 -22
- package/dist/client/services/customTargeting/customTargeting.action.d.ts +6 -6
- package/dist/client/services/customTargeting/customTargeting.action.js +6 -6
- package/dist/client/services/customTargeting/customTargeting.enum.d.ts +1 -1
- package/dist/client/services/customTargeting/customTargeting.enum.js +1 -1
- package/dist/client/services/customTargeting/customTargeting.interface.d.ts +29 -29
- package/dist/client/services/customTargeting/customTargeting.type.d.ts +2 -2
- package/dist/client/services/daiAuthenticationKey/daiAuthenticationKey.action.d.ts +3 -3
- package/dist/client/services/daiAuthenticationKey/daiAuthenticationKey.action.js +3 -3
- package/dist/client/services/daiAuthenticationKey/daiAuthenticationKey.type.d.ts +1 -1
- package/dist/client/services/daiAuthenticationKey/daiAuthenticationKeyService.interface.d.ts +13 -13
- package/dist/client/services/daiEncodingProfile/daiEncodingProfile.action.d.ts +3 -3
- package/dist/client/services/daiEncodingProfile/daiEncodingProfile.action.js +3 -3
- package/dist/client/services/daiEncodingProfile/daiEncodingProfile.enum.d.ts +1 -1
- package/dist/client/services/daiEncodingProfile/daiEncodingProfile.enum.js +1 -1
- package/dist/client/services/daiEncodingProfile/daiEncodingProfile.type.d.ts +2 -2
- package/dist/client/services/daiEncodingProfile/daiEncodingProfileService.interface.d.ts +11 -11
- package/dist/client/services/forecast/forecast.type.d.ts +1 -1
- package/dist/client/services/forecast/forecastService.interface.d.ts +9 -9
- package/dist/client/services/inventory/adUnit.action.d.ts +4 -4
- package/dist/client/services/inventory/adUnit.action.js +4 -4
- package/dist/client/services/inventory/adUnit.enum.d.ts +2 -2
- package/dist/client/services/inventory/adUnit.enum.js +2 -2
- package/dist/client/services/inventory/adUnit.type.d.ts +2 -2
- package/dist/client/services/inventory/inventoryService.interface.d.ts +16 -16
- package/dist/client/services/label/label.action.d.ts +3 -3
- package/dist/client/services/label/label.action.js +3 -3
- package/dist/client/services/label/label.interface.d.ts +11 -11
- package/dist/client/services/label/label.type.d.ts +1 -1
- package/dist/client/services/lineItem/lineItem.action.d.ts +9 -9
- package/dist/client/services/lineItem/lineItem.action.js +9 -9
- package/dist/client/services/lineItem/lineItem.type.d.ts +2 -2
- package/dist/client/services/lineItem/lineItemService.interface.d.ts +23 -23
- package/dist/client/services/lineItemCreativeAssociation/lineItemCreativeAssociation.action.d.ts +4 -4
- package/dist/client/services/lineItemCreativeAssociation/lineItemCreativeAssociation.action.js +4 -4
- package/dist/client/services/lineItemCreativeAssociation/lineItemCreativeAssociation.type.d.ts +6 -6
- package/dist/client/services/lineItemCreativeAssociation/lineItemCreativeAssociationService.interface.d.ts +18 -18
- package/dist/client/services/lineItemTemplate/lineItemTemplate.type.d.ts +1 -1
- package/dist/client/services/lineItemTemplate/lineItemTemplateService.interface.d.ts +5 -5
- package/dist/client/services/liveStreamEvent/liveStreamEvent.action.d.ts +7 -7
- package/dist/client/services/liveStreamEvent/liveStreamEvent.action.js +7 -7
- package/dist/client/services/liveStreamEvent/liveStreamEvent.enum.d.ts +2 -2
- package/dist/client/services/liveStreamEvent/liveStreamEvent.enum.js +2 -2
- package/dist/client/services/liveStreamEvent/liveStreamEvent.type.d.ts +1 -1
- package/dist/client/services/liveStreamEvent/liveStreamEventService.interface.d.ts +29 -29
- package/dist/client/services/mobileApplication/mobileApplication.action.d.ts +3 -3
- package/dist/client/services/mobileApplication/mobileApplication.action.js +3 -3
- package/dist/client/services/mobileApplication/mobileApplication.enum.d.ts +2 -2
- package/dist/client/services/mobileApplication/mobileApplication.enum.js +2 -2
- package/dist/client/services/mobileApplication/mobileApplication.type.d.ts +1 -1
- package/dist/client/services/mobileApplication/mobileApplicationService.interface.d.ts +12 -12
- package/dist/client/services/nativeStyle/nativeStyle.type.d.ts +1 -1
- package/dist/client/services/nativeStyle/nativeStyleService.interface.d.ts +9 -9
- package/dist/client/services/order/order.action.d.ts +13 -13
- package/dist/client/services/order/order.action.js +13 -13
- package/dist/client/services/order/order.enum.d.ts +5 -5
- package/dist/client/services/order/order.enum.js +5 -5
- package/dist/client/services/order/order.type.d.ts +13 -13
- package/dist/client/services/order/orderService.interface.d.ts +18 -18
- package/dist/client/services/placement/placement.action.d.ts +4 -4
- package/dist/client/services/placement/placement.action.js +4 -4
- package/dist/client/services/placement/placement.type.d.ts +1 -1
- package/dist/client/services/placement/placementService.interface.d.ts +13 -13
- package/dist/client/services/proposal/proposal.action.d.ts +15 -15
- package/dist/client/services/proposal/proposal.action.js +15 -15
- package/dist/client/services/proposal/proposal.enum.d.ts +1 -1
- package/dist/client/services/proposal/proposal.enum.js +1 -1
- package/dist/client/services/proposal/proposal.type.d.ts +3 -3
- package/dist/client/services/proposal/proposalService.interface.d.ts +26 -26
- package/dist/client/services/proposalLineItem/proposalLineItem.action.d.ts +10 -10
- package/dist/client/services/proposalLineItem/proposalLineItem.action.js +10 -10
- package/dist/client/services/proposalLineItem/proposalLineItem.type.d.ts +3 -3
- package/dist/client/services/proposalLineItem/proposalLineItemService.interface.d.ts +15 -15
- package/dist/client/services/publisherQueryLanguage/publisherQueryLanguageService.interface.d.ts +3 -3
- package/dist/client/services/report/report.type.d.ts +2 -2
- package/dist/client/services/report/reportService.interface.d.ts +16 -16
- package/dist/client/services/site/siteService.interface.d.ts +13 -13
- package/dist/client/services/suggestedAdUnit/suggestedAdUnit.action.d.ts +2 -2
- package/dist/client/services/suggestedAdUnit/suggestedAdUnit.action.js +2 -2
- package/dist/client/services/suggestedAdUnit/suggestedAdUnit.type.d.ts +2 -2
- package/dist/client/services/suggestedAdUnit/suggestedAdUnitService.interface.d.ts +9 -9
- package/dist/client/services/targetingPresent/targetingPresentService.interface.d.ts +5 -5
- package/dist/client/services/team/team.action.d.ts +3 -3
- package/dist/client/services/team/team.action.js +3 -3
- package/dist/client/services/team/team.type.d.ts +2 -2
- package/dist/client/services/team/teamService.interface.d.ts +12 -12
- package/dist/client/services/user/user.action.d.ts +3 -3
- package/dist/client/services/user/user.action.js +3 -3
- package/dist/client/services/user/user.type.d.ts +5 -5
- package/dist/client/services/user/userService.interface.d.ts +17 -17
- package/dist/client/services/userTeamAssociation/userTeamAssociation.action.d.ts +2 -2
- package/dist/client/services/userTeamAssociation/userTeamAssociation.action.js +2 -2
- package/dist/client/services/userTeamAssociation/userTeamAssociation.type.d.ts +5 -5
- package/dist/client/services/userTeamAssociation/userTeamAssociationService.interface.d.ts +10 -10
- package/dist/common/types/statement.type.d.ts +4 -4
- package/package.json +1 -1
|
@@ -1,39 +1,39 @@
|
|
|
1
1
|
import type { Statement } from "../../../common/types";
|
|
2
2
|
import type { ContentPage } from "./content.type";
|
|
3
3
|
/**
|
|
4
|
-
* Service for retrieving {@link https://developers.google.com/ad-manager/api/reference/
|
|
4
|
+
* Service for retrieving {@link https://developers.google.com/ad-manager/api/reference/latest/ContentService.Content Content}.
|
|
5
5
|
*
|
|
6
|
-
* Content entities can be targeted in video {@link https://developers.google.com/ad-manager/api/reference/
|
|
6
|
+
* Content entities can be targeted in video {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem LineItem}s.
|
|
7
7
|
*
|
|
8
8
|
* You can query for content that belongs to a particular category or has assigned metadata. Categories and metadata for Content are stored in DFP as
|
|
9
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
9
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/AdRuleService.CustomCriteria CustomCriteria}.
|
|
10
10
|
*
|
|
11
11
|
* For example, to find all Content that is "genre=comedy", you would:
|
|
12
12
|
*
|
|
13
13
|
* - Retrieve the custom targeting key corresponding to "genre" using
|
|
14
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
14
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService#getCustomTargetingKeysByStatement CustomTargetingService.getCustomTargetingKeysByStatement}
|
|
15
15
|
*
|
|
16
|
-
* - Using the {@link https://developers.google.com/ad-manager/api/reference/
|
|
16
|
+
* - Using the {@link https://developers.google.com/ad-manager/api/reference/latest/CustomTargetingService#getCustomTargetingValuesByStatement CustomTargetingService.getCustomTargetingValuesByStatement}
|
|
17
17
|
* method and a filter like "WHERE customTargetingKeyId = :genreKeyId and name = 'comedy'", retrieve the ID for the "comedy" custom targeting value.
|
|
18
18
|
*
|
|
19
|
-
* - Call {@link https://developers.google.com/ad-manager/api/reference/
|
|
19
|
+
* - Call {@link https://developers.google.com/ad-manager/api/reference/latest/ContentService#getContentByStatementAndCustomTargetingValue getContentByStatementAndCustomTargetingValue}
|
|
20
20
|
* with a filter like "WHERE status = 'ACTIVE'" and the ID of the custom targeting value from step 2.
|
|
21
21
|
*/
|
|
22
22
|
export interface ContentServiceOperations {
|
|
23
23
|
/**
|
|
24
|
-
* Gets a {@link https://developers.google.com/ad-manager/api/reference/
|
|
25
|
-
* of {@link https://developers.google.com/ad-manager/api/reference/
|
|
26
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
24
|
+
* Gets a {@link https://developers.google.com/ad-manager/api/reference/latest/ContentService.ContentPage ContentPage}
|
|
25
|
+
* of {@link https://developers.google.com/ad-manager/api/reference/latest/ContentService.Content Content} objects that satisfy the given
|
|
26
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ContentService.Statement#query Statement.query}.
|
|
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
|
-
* | status | {@link https://developers.google.com/ad-manager/api/reference/
|
|
33
|
-
* | name | {@link https://developers.google.com/ad-manager/api/reference/
|
|
34
|
-
* | lastModifiedDateTime | {@link https://developers.google.com/ad-manager/api/reference/
|
|
35
|
-
* | lastDaiIngestDateTime | {@link https://developers.google.com/ad-manager/api/reference/
|
|
36
|
-
* | daiIngestStatus | {@link https://developers.google.com/ad-manager/api/reference/
|
|
31
|
+
* | id | {@link https://developers.google.com/ad-manager/api/reference/latest/ContentService.Content#id Content.id} |
|
|
32
|
+
* | status | {@link https://developers.google.com/ad-manager/api/reference/latest/ContentService.Content#status Content.status} |
|
|
33
|
+
* | name | {@link https://developers.google.com/ad-manager/api/reference/latest/ContentService.Content#name Content.name} |
|
|
34
|
+
* | lastModifiedDateTime | {@link https://developers.google.com/ad-manager/api/reference/latest/ContentService.Content#lastModifiedDateTime Content.lastModifiedDateTime} |
|
|
35
|
+
* | lastDaiIngestDateTime | {@link https://developers.google.com/ad-manager/api/reference/latest/ContentService.Content#lastDaiIngestDateTime Content.lastDaiIngestDateTime} |
|
|
36
|
+
* | daiIngestStatus | {@link https://developers.google.com/ad-manager/api/reference/latest/ContentService.Content#daiIngestStatus Content.daiIngestStatus} |
|
|
37
37
|
*
|
|
38
38
|
* @param filterStatement a Publisher Query Language statement used to filter a set of content
|
|
39
39
|
* @returns the content that match the given filter
|
|
@@ -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/ContentBundleService.ContentBundle?hl=pt ContentBundle} objects.
|
|
3
3
|
*/
|
|
4
4
|
export declare abstract class ContentBundleAction {
|
|
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/ContentBundleService.ContentBundle?hl=pt ContentBundle} objects.
|
|
8
8
|
*/
|
|
9
9
|
export declare class ActivateContentBundles implements ContentBundleAction {
|
|
10
10
|
}
|
|
11
11
|
/**
|
|
12
|
-
* The action used for deactivating {@link https://developers.google.com/ad-manager/api/reference/
|
|
12
|
+
* The action used for deactivating {@link https://developers.google.com/ad-manager/api/reference/latest/ContentBundleService.ContentBundle?hl=pt ContentBundle} objects.
|
|
13
13
|
*/
|
|
14
14
|
export declare class DeactivateContentBundles implements ContentBundleAction {
|
|
15
15
|
}
|
|
@@ -2,19 +2,19 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.DeactivateContentBundles = exports.ActivateContentBundles = exports.ContentBundleAction = 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/ContentBundleService.ContentBundle?hl=pt ContentBundle} objects.
|
|
6
6
|
*/
|
|
7
7
|
class ContentBundleAction {
|
|
8
8
|
}
|
|
9
9
|
exports.ContentBundleAction = ContentBundleAction;
|
|
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/ContentBundleService.ContentBundle?hl=pt ContentBundle} objects.
|
|
12
12
|
*/
|
|
13
13
|
class ActivateContentBundles {
|
|
14
14
|
}
|
|
15
15
|
exports.ActivateContentBundles = ActivateContentBundles;
|
|
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/ContentBundleService.ContentBundle?hl=pt ContentBundle} objects.
|
|
18
18
|
*/
|
|
19
19
|
class DeactivateContentBundles {
|
|
20
20
|
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { DateTime, PageResult } from "../../../common/types";
|
|
2
2
|
import type { ContentBundleStatus } from "./contentBundle.enum";
|
|
3
3
|
/**
|
|
4
|
-
* A ContentBundle is a grouping of individual {@link https://developers.google.com/ad-manager/api/reference/
|
|
4
|
+
* A ContentBundle is a grouping of individual {@link https://developers.google.com/ad-manager/api/reference/latest/ContentService.Content?hl=pt Content}.
|
|
5
5
|
* A ContentBundle is defined as including the Content that match certain filter rules, along with the option to explicitly include or exclude certain Content IDs.
|
|
6
6
|
*/
|
|
7
7
|
export type ContentBundle = {
|
|
@@ -23,7 +23,7 @@ export type ContentBundle = {
|
|
|
23
23
|
lastModifiedDateTime: DateTime;
|
|
24
24
|
};
|
|
25
25
|
/**
|
|
26
|
-
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/
|
|
26
|
+
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/latest/ContentBundleService.ContentBundle?hl=pt ContentBundle} objects.
|
|
27
27
|
*/
|
|
28
28
|
export type ContentBundlePage = PageResult<ContentBundle>;
|
|
29
29
|
//# sourceMappingURL=contentBundle.type.d.ts.map
|
|
@@ -3,36 +3,36 @@ import type { ContentBundleAction } from "./contentBundle.action";
|
|
|
3
3
|
import type { ContentBundle, ContentBundlePage } from "./contentBundle.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/ContentBundleService.ContentBundle ContentBundle} objects.
|
|
7
7
|
*
|
|
8
8
|
* A **ContentBundle** is a grouping of Content that match filter rules as well as taking into account explicitly included or excluded Content.
|
|
9
9
|
*/
|
|
10
10
|
export interface ContentBundleServiceOperations {
|
|
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/ContentBundleService.ContentBundle ContentBundle} objects.
|
|
13
13
|
*
|
|
14
14
|
* @param contentBundles the content bundles to create
|
|
15
15
|
* @returns the created content bundles with their IDs filled in
|
|
16
16
|
*/
|
|
17
17
|
createContentBundles(contentBundles: Partial<ContentBundle>[]): Promise<ContentBundle[]>;
|
|
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/ContentBundleService.ContentBundlePage ContentBundlePage}
|
|
20
|
+
* of {@link https://developers.google.com/ad-manager/api/reference/latest/ContentBundleService.ContentBundle ContentBundle} objects that satisfy the given
|
|
21
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ContentBundleService.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/ContentBundleService.ContentBundle#id ContentBundle.id} |
|
|
27
|
+
* | name | {@link https://developers.google.com/ad-manager/api/reference/latest/ContentBundleService.ContentBundle#name ContentBundle.name} |
|
|
28
|
+
* | status | {@link https://developers.google.com/ad-manager/api/reference/latest/ContentBundleService.ContentBundle#status ContentBundle.status} |
|
|
29
29
|
*
|
|
30
30
|
* @param filterStatement a Publisher Query Language statement used to filter a set of content bundles
|
|
31
31
|
* @returns the content bundles that match the given filter
|
|
32
32
|
*/
|
|
33
33
|
getContentBundlesByStatement(filterStatement: Statement): Promise<ContentBundlePage>;
|
|
34
34
|
/**
|
|
35
|
-
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/
|
|
35
|
+
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/latest/ContentBundleService.ContentBundle ContentBundle} objects that match the given Statement.
|
|
36
36
|
*
|
|
37
37
|
* @param contentBundleAction the action to perform
|
|
38
38
|
* @param filterStatement a PQL statement used to filter content bundles
|
|
@@ -40,7 +40,7 @@ export interface ContentBundleServiceOperations {
|
|
|
40
40
|
*/
|
|
41
41
|
performContentBundleAction(contentBundleAction: ContentBundleAction, filterStatement: Statement): Promise<UpdateResult>;
|
|
42
42
|
/**
|
|
43
|
-
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/
|
|
43
|
+
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/latest/ContentBundleService.ContentBundle ContentBundle} objects.
|
|
44
44
|
*
|
|
45
45
|
* @param contentBundles the content bundles to update
|
|
46
46
|
* @returns the updated content bundles
|
|
@@ -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/CreativeService.Creative Creative} objects.
|
|
3
3
|
*/
|
|
4
4
|
export declare abstract class CreativeAction {
|
|
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/CreativeService.Creative Creative} objects.
|
|
8
8
|
*/
|
|
9
9
|
export declare class ActivateCreatives implements CreativeAction {
|
|
10
10
|
}
|
|
11
11
|
/**
|
|
12
|
-
* The action used for deactivating {@link https://developers.google.com/ad-manager/api/reference/
|
|
12
|
+
* The action used for deactivating {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeService.Creative Creative} objects.
|
|
13
13
|
*/
|
|
14
14
|
export declare class DeactivateCreatives implements CreativeAction {
|
|
15
15
|
}
|
|
@@ -2,19 +2,19 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.DeactivateCreatives = exports.ActivateCreatives = exports.CreativeAction = 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/CreativeService.Creative Creative} objects.
|
|
6
6
|
*/
|
|
7
7
|
class CreativeAction {
|
|
8
8
|
}
|
|
9
9
|
exports.CreativeAction = CreativeAction;
|
|
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/CreativeService.Creative Creative} objects.
|
|
12
12
|
*/
|
|
13
13
|
class ActivateCreatives {
|
|
14
14
|
}
|
|
15
15
|
exports.ActivateCreatives = ActivateCreatives;
|
|
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/CreativeService.Creative Creative} objects.
|
|
18
18
|
*/
|
|
19
19
|
class DeactivateCreatives {
|
|
20
20
|
}
|
|
@@ -995,7 +995,7 @@ export type Creative = {
|
|
|
995
995
|
thirdPartyDataDeclaration: ThirdPartyDataDeclaration;
|
|
996
996
|
} & BaseDynamicAllocationCreative & BaseRichMediaStudioCreative & ClickTrackingCreative & HasDestinationUrlCreative & Html5Creative & InternalRedirectCreative & LegacyDfpCreative & ProgrammaticCreative & TemplateCreative & ThirdPartyCreative & UnsupportedCreative & VastRedirectCreative;
|
|
997
997
|
/**
|
|
998
|
-
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/
|
|
998
|
+
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeService.Creative Creative} objects.
|
|
999
999
|
*/
|
|
1000
1000
|
export type CreativePage = PageResult<Creative>;
|
|
1001
1001
|
//# sourceMappingURL=creative.type.d.ts.map
|
|
@@ -2,40 +2,40 @@ import type { Statement, UpdateResult } from "../../../common/types";
|
|
|
2
2
|
import type { CreativeAction } from "./creative.action";
|
|
3
3
|
import type { Creative, CreativePage } from "./creative.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/CreativeService.Creative Creative} objects.
|
|
6
6
|
*
|
|
7
|
-
* For a creative to run, it must be associated with a {@link https://developers.google.com/ad-manager/api/reference/
|
|
8
|
-
* managed by the {@link https://developers.google.com/ad-manager/api/reference/
|
|
7
|
+
* For a creative to run, it must be associated with a {@link https://developers.google.com/ad-manager/api/reference/latest/ForecastService.LineItem LineItem}
|
|
8
|
+
* managed by the {@link https://developers.google.com/ad-manager/api/reference/latest/LineItemCreativeAssociationService LineItemCreativeAssociationService}.
|
|
9
9
|
*/
|
|
10
10
|
export interface CreativeServiceOperations {
|
|
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/CreativeService.Creative Creative} objects.
|
|
13
13
|
*
|
|
14
14
|
* @param creatives the creatives to create
|
|
15
15
|
* @returns the created creatives with their IDs filled in
|
|
16
16
|
*/
|
|
17
17
|
createCreatives(creatives: Partial<Creative>[]): Promise<Creative[]>;
|
|
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/CreativeService.CreativePage CreativePage}
|
|
20
|
+
* of {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeService.Creative Creative} objects that satisfy the given
|
|
21
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeService.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
|
-
* | advertiserId | {@link https://developers.google.com/ad-manager/api/reference/
|
|
29
|
-
* | width | {@link https://developers.google.com/ad-manager/api/reference/
|
|
30
|
-
* | height | {@link https://developers.google.com/ad-manager/api/reference/
|
|
31
|
-
* | lastModifiedDateTime | {@link https://developers.google.com/ad-manager/api/reference/
|
|
26
|
+
* | id | {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeService.Creative#id Creative.id} |
|
|
27
|
+
* | name | {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeService.Creative#name Creative.name} |
|
|
28
|
+
* | advertiserId | {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeService.Creative#advertiserId Creative.advertiserId} |
|
|
29
|
+
* | width | {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeService.Creative#width Creative.width} |
|
|
30
|
+
* | height | {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeService.Creative#height Creative.height} |
|
|
31
|
+
* | lastModifiedDateTime | {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeService.Creative#lastModifiedDateTime Creative.lastModifiedDateTime} |
|
|
32
32
|
*
|
|
33
33
|
* @param filterStatement a Publisher Query Language statement used to filter a set of creatives
|
|
34
34
|
* @returns the creatives that match the given filter
|
|
35
35
|
*/
|
|
36
36
|
getCreativesByStatement(filterStatement: Statement): Promise<CreativePage>;
|
|
37
37
|
/**
|
|
38
|
-
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/
|
|
38
|
+
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeService.Creative Creative} objects that match the given Statement.
|
|
39
39
|
*
|
|
40
40
|
* @param CreativeAction the action to perform
|
|
41
41
|
* @param filterStatement a PQL statement used to filter creatives
|
|
@@ -43,7 +43,7 @@ export interface CreativeServiceOperations {
|
|
|
43
43
|
*/
|
|
44
44
|
performCreativeAction(creativeAction: CreativeAction, filterStatement: Statement): Promise<UpdateResult>;
|
|
45
45
|
/**
|
|
46
|
-
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/
|
|
46
|
+
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeService.Creative Creative} objects.
|
|
47
47
|
*
|
|
48
48
|
* @param creatives the creatives to update
|
|
49
49
|
* @returns the updated creatives
|
|
@@ -3,9 +3,9 @@ import type { CreativeReviewAction } from "./creativeReview.action";
|
|
|
3
3
|
import type { CreativeReviewPage } from "./creativeReview.type";
|
|
4
4
|
export interface CreativeReviewServiceOperations {
|
|
5
5
|
/**
|
|
6
|
-
* Gets a {@link https://developers.google.com/ad-manager/api/reference/
|
|
7
|
-
* of {@link https://developers.google.com/ad-manager/api/reference/
|
|
8
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
6
|
+
* Gets a {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeReviewService.CreativeReviewPage CreativeReviewPage}
|
|
7
|
+
* of {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeReviewService.CreativeReview CreativeReview} objects that satisfy the given
|
|
8
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeReviewService.Statement#query Statement.query}.
|
|
9
9
|
* This will allow you to review creatives that have displayed (or could have displayed) on your pages or apps in the last 30 days.
|
|
10
10
|
* To ensure that you are always reviewing the most important creatives first, the CreativeReview objects are ranked according to the number of impressions that they've received.
|
|
11
11
|
*
|
|
@@ -14,7 +14,7 @@ export interface CreativeReviewServiceOperations {
|
|
|
14
14
|
*/
|
|
15
15
|
getCreativeReviewsByStatement(statement: Statement): Promise<CreativeReviewPage>;
|
|
16
16
|
/**
|
|
17
|
-
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/
|
|
17
|
+
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeReviewService.CreativeReview CreativeReview} objects that match the given Statement.
|
|
18
18
|
*
|
|
19
19
|
* @param creativeReviewAction the action to perform
|
|
20
20
|
* @param filterStatement a Publisher Query Language statement used to filter a set of creative reviews. Only "WHERE id = <value>" and "WHERE id IN <list>" are supported.
|
|
@@ -25,7 +25,7 @@ export type CreativeSet = {
|
|
|
25
25
|
lastModifiedDateTime: DateTime;
|
|
26
26
|
};
|
|
27
27
|
/**
|
|
28
|
-
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/
|
|
28
|
+
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeSetService.CreativeSet CreativeSet} objects.
|
|
29
29
|
*/
|
|
30
30
|
export type CreativeSetPage = PageResult<CreativeSet>;
|
|
31
31
|
//# sourceMappingURL=creativeSet.type.d.ts.map
|
|
@@ -1,35 +1,35 @@
|
|
|
1
1
|
import type { Statement } from "../../../common/types";
|
|
2
2
|
import type { CreativeSet, CreativeSetPage } from "./creativeSet.type";
|
|
3
3
|
/**
|
|
4
|
-
* Provides operations for creating, updating and retrieving {@link https://developers.google.com/ad-manager/api/reference/
|
|
4
|
+
* Provides operations for creating, updating and retrieving {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeSetService.CreativeSet CreativeSet} objects.
|
|
5
5
|
*/
|
|
6
6
|
export interface CreativeSetServiceOperations {
|
|
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/CreativeSetService.CreativeSet CreativeSet} objects.
|
|
9
9
|
*
|
|
10
10
|
* @param creativeSet the creative set to create
|
|
11
11
|
* @returns the created creative set with their IDs filled in
|
|
12
12
|
*/
|
|
13
13
|
createCreativeSet(creativeSet: Partial<CreativeSet>): Promise<CreativeSet>;
|
|
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/CreativeSetService.CreativeSetPage CreativeSetPage}
|
|
16
|
+
* of {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeSetService.CreativeSet CreativeSet} objects that satisfy the given
|
|
17
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeSetService.Statement#query Statement.query}.
|
|
18
18
|
* The following fields are supported for filtering:
|
|
19
19
|
*
|
|
20
20
|
* | PQL Property | PQL Property |
|
|
21
21
|
* | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
22
|
-
* | id | {@link https://developers.google.com/ad-manager/api/reference/
|
|
23
|
-
* | name | {@link https://developers.google.com/ad-manager/api/reference/
|
|
24
|
-
* | masterCreativeId | {@link https://developers.google.com/ad-manager/api/reference/
|
|
25
|
-
* | lastModifiedDateTime | {@link https://developers.google.com/ad-manager/api/reference/
|
|
22
|
+
* | id | {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeSetService.CreativeSet#id CreativeSet.id} |
|
|
23
|
+
* | name | {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeSetService.CreativeSet#name CreativeSet.name} |
|
|
24
|
+
* | masterCreativeId | {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeSetService.CreativeSet#masterCreativeId CreativeSet.masterCreativeId} |
|
|
25
|
+
* | lastModifiedDateTime | {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeSetService.CreativeSet#lastModifiedDateTime CreativeSet.lastModifiedDateTime} |
|
|
26
26
|
*
|
|
27
27
|
* @param statement a Publisher Query Language statement used to filter a set of creative sets
|
|
28
28
|
* @returns the creative sets that match the given filter
|
|
29
29
|
*/
|
|
30
30
|
getCreativeSetsByStatement(statement: Statement): Promise<CreativeSetPage>;
|
|
31
31
|
/**
|
|
32
|
-
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/
|
|
32
|
+
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeSetService.CreativeSet CreativeSet}.
|
|
33
33
|
*
|
|
34
34
|
* @param creativeSet the creative set to update
|
|
35
35
|
* @returns the updated creative set
|
|
@@ -152,7 +152,7 @@ export type CreativeTemplate = {
|
|
|
152
152
|
isSafeFrameCompatible: boolean;
|
|
153
153
|
};
|
|
154
154
|
/**
|
|
155
|
-
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/
|
|
155
|
+
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeTemplateService.CreativeTemplate CreativeTemplate} objects.
|
|
156
156
|
*/
|
|
157
157
|
export type CreativeTemplatePage = PageResult<CreativeTemplate>;
|
|
158
158
|
//# sourceMappingURL=creativeTemplate.type.d.ts.map
|
|
@@ -1,21 +1,21 @@
|
|
|
1
1
|
import type { Statement } from "../../../common/types";
|
|
2
2
|
import type { CreativeTemplatePage } from "./creativeTemplate.type";
|
|
3
3
|
/**
|
|
4
|
-
* Provides methods for retrieving {@link https://developers.google.com/ad-manager/api/reference/
|
|
4
|
+
* Provides methods for retrieving {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeTemplateService.CreativeTemplate CreativeTemplate} objects.
|
|
5
5
|
*/
|
|
6
6
|
export interface CreativeTemplateServiceOperations {
|
|
7
7
|
/**
|
|
8
|
-
* Gets a {@link https://developers.google.com/ad-manager/api/reference/
|
|
9
|
-
* of {@link https://developers.google.com/ad-manager/api/reference/
|
|
10
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
8
|
+
* Gets a {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeTemplateService.CreativeTemplatePage CreativeTemplatePage}
|
|
9
|
+
* of {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeTemplateService.CreativeTemplate CreativeTemplate} objects that satisfy the given
|
|
10
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeTemplateService.Statement#query Statement.query}.
|
|
11
11
|
* The following fields are supported for filtering:
|
|
12
12
|
*
|
|
13
13
|
* | PQL Property | PQL Property |
|
|
14
14
|
* | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
15
|
-
* | id | {@link https://developers.google.com/ad-manager/api/reference/
|
|
16
|
-
* | name | {@link https://developers.google.com/ad-manager/api/reference/
|
|
17
|
-
* | type | {@link https://developers.google.com/ad-manager/api/reference/
|
|
18
|
-
* | status | {@link https://developers.google.com/ad-manager/api/reference/
|
|
15
|
+
* | id | {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeTemplateService.CreativeTemplate#id CreativeTemplate.id} |
|
|
16
|
+
* | name | {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeTemplateService.CreativeTemplate#name CreativeTemplate.name} |
|
|
17
|
+
* | type | {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeTemplateService.CreativeTemplate#type CreativeTemplate.type} |
|
|
18
|
+
* | status | {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeTemplateService.CreativeTemplate#status CreativeTemplate.status} |
|
|
19
19
|
*
|
|
20
20
|
* @param filterStatement a Publisher Query Language statement used to filter a set of creative templates.
|
|
21
21
|
* @returns the creative templates that match the given filter
|
|
@@ -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/CreativeWrapperService.CreativeWrapper CreativeWrapper} objects.
|
|
3
3
|
*/
|
|
4
4
|
export declare abstract class CreativeWrapperAction {
|
|
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/CreativeWrapperService.CreativeWrapper CreativeWrapper} objects.
|
|
8
8
|
*/
|
|
9
9
|
export declare class ActivateCreativeWrappers implements CreativeWrapperAction {
|
|
10
10
|
}
|
|
11
11
|
/**
|
|
12
|
-
* The action used for deactivating {@link https://developers.google.com/ad-manager/api/reference/
|
|
12
|
+
* The action used for deactivating {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeWrapperService.CreativeWrapper CreativeWrapper} objects.
|
|
13
13
|
*/
|
|
14
14
|
export declare class DeactivateCreativeWrappers implements CreativeWrapperAction {
|
|
15
15
|
}
|
|
@@ -2,19 +2,19 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.DeactivateCreativeWrappers = exports.ActivateCreativeWrappers = exports.CreativeWrapperAction = 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/CreativeWrapperService.CreativeWrapper CreativeWrapper} objects.
|
|
6
6
|
*/
|
|
7
7
|
class CreativeWrapperAction {
|
|
8
8
|
}
|
|
9
9
|
exports.CreativeWrapperAction = CreativeWrapperAction;
|
|
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/CreativeWrapperService.CreativeWrapper CreativeWrapper} objects.
|
|
12
12
|
*/
|
|
13
13
|
class ActivateCreativeWrappers {
|
|
14
14
|
}
|
|
15
15
|
exports.ActivateCreativeWrappers = ActivateCreativeWrappers;
|
|
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/CreativeWrapperService.CreativeWrapper CreativeWrapper} objects.
|
|
18
18
|
*/
|
|
19
19
|
class DeactivateCreativeWrappers {
|
|
20
20
|
}
|
|
@@ -71,7 +71,7 @@ export type CreativeWrapper = {
|
|
|
71
71
|
status: CreativeWrapperStatus;
|
|
72
72
|
};
|
|
73
73
|
/**
|
|
74
|
-
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/
|
|
74
|
+
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeWrapperService.CreativeWrapper CreativeWrapper} objects.
|
|
75
75
|
*/
|
|
76
76
|
export type CreativeWrapperPage = PageResult<CreativeWrapper>;
|
|
77
77
|
//# sourceMappingURL=creativeWrapper.type.d.ts.map
|
|
@@ -3,44 +3,44 @@ import type { CreativeWrapperAction } from "./creativeWrapper.action";
|
|
|
3
3
|
import type { CreativeWrapper, CreativeWrapperPage } from "./creativeWrapper.type";
|
|
4
4
|
/**
|
|
5
5
|
* Provides methods for the creation and management of creative wrappers.
|
|
6
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
6
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeWrapperService.CreativeWrapper CreativeWrappers} allow HTML snippets to be served along with creatives.
|
|
7
7
|
*
|
|
8
8
|
* Creative wrappers must be associated with a
|
|
9
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
10
|
-
* label and applied to ad units by {@link https://developers.google.com/ad-manager/api/reference/
|
|
9
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/LabelService.LabelType#CREATIVE_WRAPPER LabelType.CREATIVE_WRAPPER}
|
|
10
|
+
* label and applied to ad units by {@link https://developers.google.com/ad-manager/api/reference/latest/InventoryService.AdUnit#appliedLabels AdUnit.appliedLabels}.
|
|
11
11
|
*/
|
|
12
12
|
export interface CreativeWrapperServiceOperations {
|
|
13
13
|
/**
|
|
14
14
|
* Creates a new CreativeWrapper objects. The following fields are required:
|
|
15
15
|
*
|
|
16
|
-
* - {@link https://developers.google.com/ad-manager/api/reference/
|
|
17
|
-
* - {@link https://developers.google.com/ad-manager/api/reference/
|
|
18
|
-
* - {@link https://developers.google.com/ad-manager/api/reference/
|
|
19
|
-
* or {@link https://developers.google.com/ad-manager/api/reference/
|
|
16
|
+
* - {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeWrapperService.CreativeWrapper#labelId CreativeWrapper.labelId }
|
|
17
|
+
* - {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeWrapperService.CreativeWrapper#ordering CreativeWrapper.ordering }
|
|
18
|
+
* - {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeWrapperService.CreativeWrapper#header CreativeWrapper.header }
|
|
19
|
+
* or {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeWrapperService.CreativeWrapper#footer CreativeWrapper.footer }
|
|
20
20
|
*
|
|
21
21
|
* @param creativeWrappers the creative wrappers to create
|
|
22
22
|
* @returns the creative wrappers with their IDs filled in
|
|
23
23
|
*/
|
|
24
24
|
createCreativeWrappers(creativeWrappers: Partial<CreativeWrapper>[]): Promise<CreativeWrapper[]>;
|
|
25
25
|
/**
|
|
26
|
-
* Gets a {@link https://developers.google.com/ad-manager/api/reference/
|
|
27
|
-
* of {@link https://developers.google.com/ad-manager/api/reference/
|
|
28
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
26
|
+
* Gets a {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeWrapperService.CreativeWrapperPage CreativeWrapperPage}
|
|
27
|
+
* of {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeWrapperService.CreativeWrapper CreativeWrapper} objects that satisfy the given
|
|
28
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeWrapperService.Statement#query Statement.query}.
|
|
29
29
|
* The following fields are supported for filtering:
|
|
30
30
|
*
|
|
31
31
|
* | PQL Property | PQL Property |
|
|
32
32
|
* | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
33
|
-
* | id | {@link https://developers.google.com/ad-manager/api/reference/
|
|
34
|
-
* | labelId | {@link https://developers.google.com/ad-manager/api/reference/
|
|
35
|
-
* | status | {@link https://developers.google.com/ad-manager/api/reference/
|
|
36
|
-
* | ordering | {@link https://developers.google.com/ad-manager/api/reference/
|
|
33
|
+
* | id | {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeWrapperService.CreativeWrapper#id CreativeWrapper.id} |
|
|
34
|
+
* | labelId | {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeWrapperService.CreativeWrapper#labelId CreativeWrapper.labelId} |
|
|
35
|
+
* | status | {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeWrapperService.CreativeWrapper#status CreativeWrapper.status} |
|
|
36
|
+
* | ordering | {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeWrapperService.CreativeWrapper#ordering CreativeWrapper.lastModifiedDateTime} |
|
|
37
37
|
*
|
|
38
38
|
* @param filterStatement a Publisher Query Language statement used to filter a set of creative wrappers.
|
|
39
39
|
* @returns the creative wrappers that match the given filter
|
|
40
40
|
*/
|
|
41
41
|
getCreativeWrappersByStatement(filterStatement: Statement): Promise<CreativeWrapperPage>;
|
|
42
42
|
/**
|
|
43
|
-
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/
|
|
43
|
+
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/latest/CreativeWrapperService.CreativeWrapper CreativeWrapper} objects that match the given Statement.
|
|
44
44
|
*
|
|
45
45
|
* @param creativeWrapperAction the action to perform
|
|
46
46
|
* @param filterStatement a Publisher Query Language statement used to filter a set of labels
|
|
@@ -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/CustomFieldService.CustomField CustomField} objects.
|
|
3
3
|
*/
|
|
4
4
|
export declare abstract class CustomFieldAction {
|
|
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/CustomFieldService.CustomField CustomField} objects.
|
|
8
8
|
*/
|
|
9
9
|
export declare class ActivateCustomFields implements CustomFieldAction {
|
|
10
10
|
}
|
|
11
11
|
/**
|
|
12
|
-
* The action used for deactivating {@link https://developers.google.com/ad-manager/api/reference/
|
|
12
|
+
* The action used for deactivating {@link https://developers.google.com/ad-manager/api/reference/latest/CustomFieldService.CustomField CustomField} objects.
|
|
13
13
|
*/
|
|
14
14
|
export declare class DeactivateCustomFields implements CustomFieldAction {
|
|
15
15
|
}
|