@guardian/google-admanager-api 6.0.3 → 6.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +17 -0
- package/dist/client/common/enums/delivery.enum.d.ts +1 -1
- package/dist/client/common/enums/delivery.enum.js +1 -1
- package/dist/client/common/enums/general.enum.d.ts +7 -7
- package/dist/client/common/enums/general.enum.js +7 -7
- package/dist/client/common/enums/lineItemSummary.enum.d.ts +4 -4
- package/dist/client/common/enums/lineItemSummary.enum.js +4 -4
- package/dist/client/common/types/general.type.d.ts +21 -21
- package/dist/client/common/types/label.type.d.ts +2 -2
- package/dist/client/common/types/lineItemSummary.type.d.ts +7 -7
- package/dist/client/common/types/targeting.type.d.ts +77 -42
- package/dist/client/common/types/targeting.type.d.ts.map +1 -1
- package/dist/client/common/types/targeting.type.js +48 -19
- package/dist/client/common/types/targeting.type.js.map +1 -1
- package/dist/client/services/activity/activity.type.d.ts +4 -4
- package/dist/client/services/activity/activityService.interface.d.ts +12 -12
- package/dist/client/services/activityGroup/activityGroup.type.d.ts +4 -4
- package/dist/client/services/activityGroup/activityGroupService.interface.d.ts +11 -11
- package/dist/client/services/adRule/adRule.type.d.ts +2 -2
- package/dist/client/services/adRule/adSpot.type.d.ts +1 -1
- package/dist/client/services/adjustment/adjustment.enum.d.ts +1 -1
- package/dist/client/services/adjustment/adjustment.enum.js +1 -1
- package/dist/client/services/adjustment/adjustment.type.d.ts +1 -1
- package/dist/client/services/adjustment/adjustmentService.interface.d.ts +23 -23
- package/dist/client/services/audienceSegment/audienceSegment.action.d.ts +6 -6
- package/dist/client/services/audienceSegment/audienceSegment.action.js +6 -6
- package/dist/client/services/audienceSegment/audienceSegment.enum.d.ts +4 -4
- package/dist/client/services/audienceSegment/audienceSegment.enum.js +4 -4
- package/dist/client/services/audienceSegment/audienceSegment.type.d.ts +14 -14
- package/dist/client/services/audienceSegment/audienceSegmentService.interface.d.ts +17 -17
- package/dist/client/services/cdnConfiguration/cdnConfiguration.action.d.ts +3 -3
- package/dist/client/services/cdnConfiguration/cdnConfiguration.action.js +3 -3
- package/dist/client/services/cdnConfiguration/cdnConfiguration.enum.d.ts +3 -3
- package/dist/client/services/cdnConfiguration/cdnConfiguration.enum.js +3 -3
- package/dist/client/services/cdnConfiguration/cdnConfiguration.interface.d.ts +11 -11
- package/dist/client/services/cdnConfiguration/cdnConfiguration.type.d.ts +1 -1
- package/dist/client/services/cmsMetadata/cmsMetadata.action.d.ts +6 -6
- package/dist/client/services/cmsMetadata/cmsMetadata.action.js +6 -6
- package/dist/client/services/cmsMetadata/cmsMetadataService.interface.d.ts +16 -16
- package/dist/client/services/company/company.type.d.ts +3 -3
- package/dist/client/services/company/companyService.interface.d.ts +11 -11
- package/dist/client/services/contact/contact.type.d.ts +2 -2
- package/dist/client/services/contact/contactService.interface.d.ts +15 -15
- package/dist/client/services/content/content.enum.d.ts +2 -2
- package/dist/client/services/content/content.enum.js +2 -2
- package/dist/client/services/content/content.type.d.ts +1 -1
- package/dist/client/services/content/contentService.interface.d.ts +15 -15
- package/dist/client/services/contentBundle/contentBundle.action.d.ts +3 -3
- package/dist/client/services/contentBundle/contentBundle.action.js +3 -3
- package/dist/client/services/contentBundle/contentBundle.type.d.ts +2 -2
- package/dist/client/services/contentBundle/contentBundleService.interface.d.ts +10 -10
- package/dist/client/services/creative/creative.action.d.ts +3 -3
- package/dist/client/services/creative/creative.action.js +3 -3
- package/dist/client/services/creative/creative.type.d.ts +1 -1
- package/dist/client/services/creative/creativeService.interface.d.ts +15 -15
- package/dist/client/services/creativeReview/creativeReviewService.interface.d.ts +4 -4
- package/dist/client/services/creativeSet/creativeSet.type.d.ts +1 -1
- package/dist/client/services/creativeSet/creativeSetService.interface.d.ts +10 -10
- package/dist/client/services/creativeTemplate/creativeTemplate.type.d.ts +1 -1
- package/dist/client/services/creativeTemplate/creativeTemplateService.interface.d.ts +8 -8
- package/dist/client/services/creativeWrapper/creativeWrapper.action.d.ts +3 -3
- package/dist/client/services/creativeWrapper/creativeWrapper.action.js +3 -3
- package/dist/client/services/creativeWrapper/creativeWrapper.type.d.ts +1 -1
- package/dist/client/services/creativeWrapper/creativeWrapperService.interface.d.ts +15 -15
- package/dist/client/services/customField/customField.action.d.ts +3 -3
- package/dist/client/services/customField/customField.action.js +3 -3
- package/dist/client/services/customField/customField.enum.d.ts +1 -1
- package/dist/client/services/customField/customField.enum.js +1 -1
- package/dist/client/services/customField/customField.type.d.ts +3 -3
- package/dist/client/services/customField/customFieldService.interface.d.ts +22 -22
- package/dist/client/services/customTargeting/customTargeting.action.d.ts +6 -6
- package/dist/client/services/customTargeting/customTargeting.action.js +6 -6
- package/dist/client/services/customTargeting/customTargeting.enum.d.ts +1 -1
- package/dist/client/services/customTargeting/customTargeting.enum.js +1 -1
- package/dist/client/services/customTargeting/customTargeting.interface.d.ts +29 -29
- package/dist/client/services/customTargeting/customTargeting.type.d.ts +2 -2
- package/dist/client/services/daiAuthenticationKey/daiAuthenticationKey.action.d.ts +3 -3
- package/dist/client/services/daiAuthenticationKey/daiAuthenticationKey.action.js +3 -3
- package/dist/client/services/daiAuthenticationKey/daiAuthenticationKey.type.d.ts +1 -1
- package/dist/client/services/daiAuthenticationKey/daiAuthenticationKeyService.interface.d.ts +13 -13
- package/dist/client/services/daiEncodingProfile/daiEncodingProfile.action.d.ts +3 -3
- package/dist/client/services/daiEncodingProfile/daiEncodingProfile.action.js +3 -3
- package/dist/client/services/daiEncodingProfile/daiEncodingProfile.enum.d.ts +1 -1
- package/dist/client/services/daiEncodingProfile/daiEncodingProfile.enum.js +1 -1
- package/dist/client/services/daiEncodingProfile/daiEncodingProfile.type.d.ts +2 -2
- package/dist/client/services/daiEncodingProfile/daiEncodingProfileService.interface.d.ts +11 -11
- package/dist/client/services/forecast/forecast.type.d.ts +1 -1
- package/dist/client/services/forecast/forecastService.interface.d.ts +9 -9
- package/dist/client/services/inventory/adUnit.action.d.ts +4 -4
- package/dist/client/services/inventory/adUnit.action.js +4 -4
- package/dist/client/services/inventory/adUnit.enum.d.ts +2 -2
- package/dist/client/services/inventory/adUnit.enum.js +2 -2
- package/dist/client/services/inventory/adUnit.type.d.ts +2 -2
- package/dist/client/services/inventory/inventoryService.interface.d.ts +16 -16
- package/dist/client/services/label/label.action.d.ts +3 -3
- package/dist/client/services/label/label.action.js +3 -3
- package/dist/client/services/label/label.interface.d.ts +11 -11
- package/dist/client/services/label/label.type.d.ts +1 -1
- package/dist/client/services/lineItem/lineItem.action.d.ts +9 -9
- package/dist/client/services/lineItem/lineItem.action.js +9 -9
- package/dist/client/services/lineItem/lineItem.type.d.ts +2 -2
- package/dist/client/services/lineItem/lineItemService.interface.d.ts +23 -23
- package/dist/client/services/lineItemCreativeAssociation/lineItemCreativeAssociation.action.d.ts +4 -4
- package/dist/client/services/lineItemCreativeAssociation/lineItemCreativeAssociation.action.js +4 -4
- package/dist/client/services/lineItemCreativeAssociation/lineItemCreativeAssociation.type.d.ts +6 -6
- package/dist/client/services/lineItemCreativeAssociation/lineItemCreativeAssociationService.interface.d.ts +18 -18
- package/dist/client/services/lineItemTemplate/lineItemTemplate.type.d.ts +1 -1
- package/dist/client/services/lineItemTemplate/lineItemTemplateService.interface.d.ts +5 -5
- package/dist/client/services/liveStreamEvent/liveStreamEvent.action.d.ts +7 -7
- package/dist/client/services/liveStreamEvent/liveStreamEvent.action.js +7 -7
- package/dist/client/services/liveStreamEvent/liveStreamEvent.enum.d.ts +2 -2
- package/dist/client/services/liveStreamEvent/liveStreamEvent.enum.js +2 -2
- package/dist/client/services/liveStreamEvent/liveStreamEvent.type.d.ts +1 -1
- package/dist/client/services/liveStreamEvent/liveStreamEventService.interface.d.ts +29 -29
- package/dist/client/services/mobileApplication/mobileApplication.action.d.ts +3 -3
- package/dist/client/services/mobileApplication/mobileApplication.action.js +3 -3
- package/dist/client/services/mobileApplication/mobileApplication.enum.d.ts +2 -2
- package/dist/client/services/mobileApplication/mobileApplication.enum.js +2 -2
- package/dist/client/services/mobileApplication/mobileApplication.type.d.ts +1 -1
- package/dist/client/services/mobileApplication/mobileApplicationService.interface.d.ts +12 -12
- package/dist/client/services/nativeStyle/nativeStyle.type.d.ts +1 -1
- package/dist/client/services/nativeStyle/nativeStyleService.interface.d.ts +9 -9
- package/dist/client/services/order/order.action.d.ts +13 -13
- package/dist/client/services/order/order.action.js +13 -13
- package/dist/client/services/order/order.enum.d.ts +5 -5
- package/dist/client/services/order/order.enum.js +5 -5
- package/dist/client/services/order/order.type.d.ts +13 -13
- package/dist/client/services/order/orderService.interface.d.ts +18 -18
- package/dist/client/services/placement/placement.action.d.ts +4 -4
- package/dist/client/services/placement/placement.action.js +4 -4
- package/dist/client/services/placement/placement.type.d.ts +1 -1
- package/dist/client/services/placement/placementService.interface.d.ts +13 -13
- package/dist/client/services/proposal/proposal.action.d.ts +15 -15
- package/dist/client/services/proposal/proposal.action.js +15 -15
- package/dist/client/services/proposal/proposal.enum.d.ts +1 -1
- package/dist/client/services/proposal/proposal.enum.js +1 -1
- package/dist/client/services/proposal/proposal.type.d.ts +3 -3
- package/dist/client/services/proposal/proposalService.interface.d.ts +26 -26
- package/dist/client/services/proposalLineItem/proposalLineItem.action.d.ts +10 -10
- package/dist/client/services/proposalLineItem/proposalLineItem.action.js +10 -10
- package/dist/client/services/proposalLineItem/proposalLineItem.type.d.ts +3 -3
- package/dist/client/services/proposalLineItem/proposalLineItemService.interface.d.ts +15 -15
- package/dist/client/services/publisherQueryLanguage/publisherQueryLanguageService.interface.d.ts +3 -3
- package/dist/client/services/report/report.type.d.ts +2 -2
- package/dist/client/services/report/reportService.interface.d.ts +16 -16
- package/dist/client/services/site/siteService.interface.d.ts +13 -13
- package/dist/client/services/suggestedAdUnit/suggestedAdUnit.action.d.ts +2 -2
- package/dist/client/services/suggestedAdUnit/suggestedAdUnit.action.js +2 -2
- package/dist/client/services/suggestedAdUnit/suggestedAdUnit.type.d.ts +2 -2
- package/dist/client/services/suggestedAdUnit/suggestedAdUnitService.interface.d.ts +9 -9
- package/dist/client/services/targetingPresent/targetingPresentService.interface.d.ts +5 -5
- package/dist/client/services/team/team.action.d.ts +3 -3
- package/dist/client/services/team/team.action.js +3 -3
- package/dist/client/services/team/team.type.d.ts +2 -2
- package/dist/client/services/team/teamService.interface.d.ts +12 -12
- package/dist/client/services/user/user.action.d.ts +3 -3
- package/dist/client/services/user/user.action.js +3 -3
- package/dist/client/services/user/user.type.d.ts +5 -5
- package/dist/client/services/user/userService.interface.d.ts +17 -17
- package/dist/client/services/userTeamAssociation/userTeamAssociation.action.d.ts +2 -2
- package/dist/client/services/userTeamAssociation/userTeamAssociation.action.js +2 -2
- package/dist/client/services/userTeamAssociation/userTeamAssociation.type.d.ts +5 -5
- package/dist/client/services/userTeamAssociation/userTeamAssociationService.interface.d.ts +10 -10
- package/dist/common/types/statement.type.d.ts +4 -4
- package/package.json +11 -11
|
@@ -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
|
/**
|
|
@@ -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
|