@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
|
@@ -13,8 +13,8 @@ export type Activity = {
|
|
|
13
13
|
*/
|
|
14
14
|
id: number;
|
|
15
15
|
/**
|
|
16
|
-
* The ID of the {@link https://developers.google.com/ad-manager/api/reference/
|
|
17
|
-
* that this {@link https://developers.google.com/ad-manager/api/reference/
|
|
16
|
+
* The ID of the {@link https://developers.google.com/ad-manager/api/reference/latest/ActivityGroupService.ActivityGroup ActivityGroup} \
|
|
17
|
+
* that this {@link https://developers.google.com/ad-manager/api/reference/latest/ActivityService.Activity Activity} belongs to.
|
|
18
18
|
*/
|
|
19
19
|
activityGroupId: number;
|
|
20
20
|
/**
|
|
@@ -31,12 +31,12 @@ export type Activity = {
|
|
|
31
31
|
status: ActivityStatus;
|
|
32
32
|
/**
|
|
33
33
|
* The activity type. This attribute is optional and defaults to
|
|
34
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
34
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ActivityService.Activity.Type#PAGE_VIEWS Activity.Type.PAGE_VIEWS}
|
|
35
35
|
*/
|
|
36
36
|
type: ActivityType;
|
|
37
37
|
};
|
|
38
38
|
/**
|
|
39
|
-
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/
|
|
39
|
+
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/latest/ActivityService.Activity Activity} objects.
|
|
40
40
|
*/
|
|
41
41
|
export type ActivityPage = PageResult<Activity>;
|
|
42
42
|
//# sourceMappingURL=activity.type.d.ts.map
|
|
@@ -2,39 +2,39 @@ import type { Statement } from "../../../common/types";
|
|
|
2
2
|
import type { Activity, ActivityPage } from "./activity.type";
|
|
3
3
|
/**
|
|
4
4
|
* Provides methods for creating, updating and retrieving
|
|
5
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
5
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ActivityService.Activity Activity} objects.
|
|
6
6
|
*
|
|
7
|
-
* An activity group contains {@link https://developers.google.com/ad-manager/api/reference/
|
|
7
|
+
* An activity group contains {@link https://developers.google.com/ad-manager/api/reference/latest/ActivityService.Activity Activity} objects.
|
|
8
8
|
* Activities have a many-to-one relationship with activity groups, meaning each activity can belong to only one activity group,
|
|
9
9
|
* but activity groups can have multiple activities. An activity group can be used to manage the activities it contains.
|
|
10
10
|
*/
|
|
11
11
|
export interface ActivityServiceOperations {
|
|
12
12
|
/**
|
|
13
|
-
* Creates a new {@link https://developers.google.com/ad-manager/api/reference/
|
|
13
|
+
* Creates a new {@link https://developers.google.com/ad-manager/api/reference/latest/ActivityService.Activity Activity} objects.
|
|
14
14
|
*
|
|
15
15
|
* @param activities the activity to be created.
|
|
16
16
|
* @returns the created activities with its IDs filled in.
|
|
17
17
|
*/
|
|
18
18
|
createActivities(activities: Partial<Activity>[]): Promise<Activity[]>;
|
|
19
19
|
/**
|
|
20
|
-
* Gets an {@link https://developers.google.com/ad-manager/api/reference/
|
|
21
|
-
* of {@link https://developers.google.com/ad-manager/api/reference/
|
|
22
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
20
|
+
* Gets an {@link https://developers.google.com/ad-manager/api/reference/latest/ActivityService.ActivityPage ActivityPage}
|
|
21
|
+
* of {@link https://developers.google.com/ad-manager/api/reference/latest/ActivityService.Activity Activity} objects that satisfy the given
|
|
22
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ActivityService.Statement#query Statement.query}. 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
|
-
* | expectedURL | {@link https://developers.google.com/ad-manager/api/reference/
|
|
29
|
-
* | status | {@link https://developers.google.com/ad-manager/api/reference/
|
|
30
|
-
* | activityGroupId | {@link https://developers.google.com/ad-manager/api/reference/
|
|
26
|
+
* | id | {@link https://developers.google.com/ad-manager/api/reference/latest/ActivityService.Activity#id Activity.id} |
|
|
27
|
+
* | name | {@link https://developers.google.com/ad-manager/api/reference/latest/ActivityService.Activity#name Activity.name} |
|
|
28
|
+
* | expectedURL | {@link https://developers.google.com/ad-manager/api/reference/latest/ActivityService.Activity#expectedURL Activity.expectedURL} |
|
|
29
|
+
* | status | {@link https://developers.google.com/ad-manager/api/reference/latest/ActivityService.Activity#status Activity.status} |
|
|
30
|
+
* | activityGroupId | {@link https://developers.google.com/ad-manager/api/reference/latest/ActivityService.Activity#activityGroupId Order.activityGroupId} |
|
|
31
31
|
*
|
|
32
32
|
* @param filterStatement a statement used to filter a set of activities.
|
|
33
33
|
* @returns the activities that match the given filter.
|
|
34
34
|
*/
|
|
35
35
|
getActivitiesByStatement(filterStatement: Statement): Promise<ActivityPage>;
|
|
36
36
|
/**
|
|
37
|
-
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/
|
|
37
|
+
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/latest/ActivityService.Activity Activity} objects.
|
|
38
38
|
*
|
|
39
39
|
* @param activities the activities to update.
|
|
40
40
|
* @returns the updated activities.
|
|
@@ -17,9 +17,9 @@ export type ActivityGroup = {
|
|
|
17
17
|
* The company ids whose ads will be included for conversion tracking on the activities in this group.
|
|
18
18
|
* Only clicks and impressions of ads from these companies will lead to conversions on the containing activities.
|
|
19
19
|
* This attribute is required when creating an activity group. The company types allowed are:
|
|
20
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
21
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
22
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
20
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CompanyService.Company.Type#ADVERTISER Company.Type.ADVERTISER}, and
|
|
21
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CompanyService.Company.Type#AD_NETWORK Company.Type.AD_NETWORK}, and
|
|
22
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/CompanyService.Company.Type#HOUSE_ADVERTISER Company.Type.HOUSE_ADVERTISER}
|
|
23
23
|
*/
|
|
24
24
|
companyIds: number[];
|
|
25
25
|
/**
|
|
@@ -42,7 +42,7 @@ export type ActivityGroup = {
|
|
|
42
42
|
status: ActivityGroupStatus;
|
|
43
43
|
};
|
|
44
44
|
/**
|
|
45
|
-
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/
|
|
45
|
+
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/latest/ActivityGroupService.ActivityGroup ActivityGroup} objects.
|
|
46
46
|
*/
|
|
47
47
|
export type ActivityGroupPage = PageResult<ActivityGroup>;
|
|
48
48
|
//# sourceMappingURL=activityGroup.type.d.ts.map
|
|
@@ -2,9 +2,9 @@ import type { Statement } from "../../../common/types";
|
|
|
2
2
|
import type { ActivityGroup, ActivityGroupPage } from "./activityGroup.type";
|
|
3
3
|
/**
|
|
4
4
|
* Provides methods for creating, updating and retrieving
|
|
5
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
5
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ActivityGroupService.ActivityGroup ActivityGroup} objects.
|
|
6
6
|
*
|
|
7
|
-
* An activity group contains {@link https://developers.google.com/ad-manager/api/reference/
|
|
7
|
+
* An activity group contains {@link https://developers.google.com/ad-manager/api/reference/latest/ActivityService.Activity Activity} objects.
|
|
8
8
|
* Activities have a many-to-one relationship with activity groups, meaning each activity can belong to only one activity group,
|
|
9
9
|
* but activity groups can have multiple activities. An activity group can be used to manage the activities it contains.
|
|
10
10
|
*/
|
|
@@ -17,24 +17,24 @@ export interface ActivityGroupServiceOperations {
|
|
|
17
17
|
*/
|
|
18
18
|
createActivityGroups(activityGroups: Partial<ActivityGroup>[]): Promise<ActivityGroup[]>;
|
|
19
19
|
/**
|
|
20
|
-
* Gets an {@link https://developers.google.com/ad-manager/api/reference/
|
|
21
|
-
* of {@link https://developers.google.com/ad-manager/api/reference/
|
|
22
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
20
|
+
* Gets an {@link https://developers.google.com/ad-manager/api/reference/latest/ActivityGroupService.ActivityGroupPage ActivityGroupPage}
|
|
21
|
+
* of {@link https://developers.google.com/ad-manager/api/reference/latest/ActivityGroupService.ActivityGroup ActivityGroup} objects that satisfy the given
|
|
22
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/ActivityGroupService.Statement#query Statement.query}. 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
|
-
* | impressionsLookback | {@link https://developers.google.com/ad-manager/api/reference/
|
|
29
|
-
* | clicksLookback | {@link https://developers.google.com/ad-manager/api/reference/
|
|
30
|
-
* | status | {@link https://developers.google.com/ad-manager/api/reference/
|
|
26
|
+
* | id | {@link https://developers.google.com/ad-manager/api/reference/latest/ActivityGroupService.ActivityGroup##id ActivityGroup.id} |
|
|
27
|
+
* | name | {@link https://developers.google.com/ad-manager/api/reference/latest/ActivityGroupService.ActivityGroup##name ActivityGroup.name} |
|
|
28
|
+
* | impressionsLookback | {@link https://developers.google.com/ad-manager/api/reference/latest/ActivityGroupService.ActivityGroup#impressionsLookback ActivityGroup.impressionsLookback} |
|
|
29
|
+
* | clicksLookback | {@link https://developers.google.com/ad-manager/api/reference/latest/ActivityGroupService.ActivityGroup##clicksLookback Order.clicksLookback} |
|
|
30
|
+
* | status | {@link https://developers.google.com/ad-manager/api/reference/latest/ActivityGroupService.ActivityGroup##status ActivityGroup.status} |
|
|
31
31
|
*
|
|
32
32
|
* @param filterStatement a statement used to filter a set of activity groups
|
|
33
33
|
* @returns the activity groups that match the given filter
|
|
34
34
|
*/
|
|
35
35
|
getActivityGroupsByStatement(filterStatement: Statement): Promise<ActivityGroupPage>;
|
|
36
36
|
/**
|
|
37
|
-
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/
|
|
37
|
+
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/latest/ActivityGroupService.ActivityGroup ActivityGroup} objects.
|
|
38
38
|
*
|
|
39
39
|
* @param activityGroups the activity groups to update.
|
|
40
40
|
* @returns the updated activity groups.
|
|
@@ -173,11 +173,11 @@ export type BreakTemplate = {
|
|
|
173
173
|
breakTemplateMembers: BreakTemplateMember[];
|
|
174
174
|
};
|
|
175
175
|
/**
|
|
176
|
-
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/
|
|
176
|
+
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/latest/AdRuleService.AdRule AdRule} objects.
|
|
177
177
|
*/
|
|
178
178
|
export type AdRulePage = PageResult<AdRule>;
|
|
179
179
|
/**
|
|
180
|
-
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/
|
|
180
|
+
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/latest/AdRuleService.BreakTemplate BreakTemplate} objects.
|
|
181
181
|
*/
|
|
182
182
|
export type BreakTemplatePage = PageResult<BreakTemplate>;
|
|
183
183
|
//# sourceMappingURL=adRule.type.d.ts.map
|
|
@@ -63,7 +63,7 @@ export type AdSpot = {
|
|
|
63
63
|
inventorySharingBlocked?: boolean;
|
|
64
64
|
};
|
|
65
65
|
/**
|
|
66
|
-
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/
|
|
66
|
+
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/latest/AdRuleService.AdSpot AdSpot} objects.
|
|
67
67
|
*/
|
|
68
68
|
export type AdSpotPage = PageResult<AdSpot>;
|
|
69
69
|
//# sourceMappingURL=adSpot.type.d.ts.map
|
|
@@ -17,7 +17,7 @@ export declare enum ForecastAdjustmentStatus {
|
|
|
17
17
|
}
|
|
18
18
|
/**
|
|
19
19
|
* Options for how the volume settings of a
|
|
20
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
20
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/AdjustmentService.ForecastAdjustment ForecastAdjustment} are defined.
|
|
21
21
|
*/
|
|
22
22
|
export declare enum ForecastAdjustmentVolumeType {
|
|
23
23
|
/**
|
|
@@ -21,7 +21,7 @@ var ForecastAdjustmentStatus;
|
|
|
21
21
|
})(ForecastAdjustmentStatus || (exports.ForecastAdjustmentStatus = ForecastAdjustmentStatus = {}));
|
|
22
22
|
/**
|
|
23
23
|
* Options for how the volume settings of a
|
|
24
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
24
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/AdjustmentService.ForecastAdjustment ForecastAdjustment} are defined.
|
|
25
25
|
*/
|
|
26
26
|
var ForecastAdjustmentVolumeType;
|
|
27
27
|
(function (ForecastAdjustmentVolumeType) {
|
|
@@ -34,7 +34,7 @@ type TotalVolumeSettings = {
|
|
|
34
34
|
};
|
|
35
35
|
/**
|
|
36
36
|
* Settings to specify the volume of ad opportunities per day over the
|
|
37
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
37
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/AdjustmentService.ForecastAdjustment ForecastAdjustment}
|
|
38
38
|
* date range based on the traffic volume of a historical reference period.
|
|
39
39
|
*
|
|
40
40
|
* The daily historical traffic for the provided targeting and date range is fetched, multiplied by the provided multiplier,
|
|
@@ -3,8 +3,8 @@ import type { ForecastAdjustmentAction } from "./adjustment.action";
|
|
|
3
3
|
import type { ForecastAdjustment, ForecastAdjustmentPage, TrafficForecastSegment, TrafficForecastSegmentPage } from "./adjustment.type";
|
|
4
4
|
/**
|
|
5
5
|
* Provides methods for creating, updating, and retrieving
|
|
6
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
7
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
6
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/AdjustmentService.ForecastAdjustment ForecastAdjustment}s and
|
|
7
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/AdjustmentService.TrafficForecastSegment TrafficForecastSegment}s.
|
|
8
8
|
*
|
|
9
9
|
* Forecast adjustments allow editing the volume and traffic composition of forecasted inventory.
|
|
10
10
|
* Traffic forecast segments divide forecasted inventory into segments to which forecast adjustments can be applied.
|
|
@@ -18,59 +18,59 @@ export interface AdjustmentServiceOperations {
|
|
|
18
18
|
*/
|
|
19
19
|
calculateDailyAdOpportunityCounts(forecastAdjustment: ForecastAdjustment): Promise<ForecastAdjustment>;
|
|
20
20
|
/**
|
|
21
|
-
* Creates new {@link https://developers.google.com/ad-manager/api/reference/
|
|
21
|
+
* Creates new {@link https://developers.google.com/ad-manager/api/reference/latest/AdjustmentService.ForecastAdjustment ForecastAdjustment} objects.
|
|
22
22
|
*
|
|
23
23
|
* @param forecastAdjustments the forecast adjustments to create
|
|
24
24
|
* @returns the persisted forecast adjustments with their IDs populated
|
|
25
25
|
*/
|
|
26
26
|
createForecastAdjustments(forecastAdjustments: Partial<ForecastAdjustment>[]): Promise<ForecastAdjustment[]>;
|
|
27
27
|
/**
|
|
28
|
-
* Creates new {@link https://developers.google.com/ad-manager/api/reference/
|
|
28
|
+
* Creates new {@link https://developers.google.com/ad-manager/api/reference/latest/AdjustmentService.TrafficForecastSegment TrafficForecastSegment} objects.
|
|
29
29
|
*
|
|
30
30
|
* @param trafficForecastSegments the traffic forecast segments to create
|
|
31
31
|
* @returns the persisted traffic forecast segments with their IDs populated
|
|
32
32
|
*/
|
|
33
33
|
createTrafficForecastSegments(trafficForecastSegments: Partial<TrafficForecastSegment>[]): Promise<TrafficForecastSegment[]>;
|
|
34
34
|
/**
|
|
35
|
-
* Gets a {@link https://developers.google.com/ad-manager/api/reference/
|
|
36
|
-
* of {@link https://developers.google.com/ad-manager/api/reference/
|
|
37
|
-
* objects that satisfy the given {@link https://developers.google.com/ad-manager/api/reference/
|
|
35
|
+
* Gets a {@link https://developers.google.com/ad-manager/api/reference/latest/AdjustmentService.ForecastAdjustmentPage ForecastAdjustmentPage}
|
|
36
|
+
* of {@link https://developers.google.com/ad-manager/api/reference/latest/AdjustmentService.ForecastAdjustment ForecastAdjustment}
|
|
37
|
+
* objects that satisfy the given {@link https://developers.google.com/ad-manager/api/reference/latest/AdjustmentService.Statement#query Statement.query}.
|
|
38
38
|
*
|
|
39
39
|
* The following fields are supported for filtering:
|
|
40
40
|
*
|
|
41
41
|
* | PQL Property | PQL Property |
|
|
42
42
|
* | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
43
|
-
* | id | {@link https://developers.google.com/ad-manager/api/reference/
|
|
44
|
-
* | trafficForecastSegmentId | {@link https://developers.google.com/ad-manager/api/reference/
|
|
45
|
-
* | name | {@link https://developers.google.com/ad-manager/api/reference/
|
|
46
|
-
* | startDate | {@link https://developers.google.com/ad-manager/api/reference/
|
|
47
|
-
* | endDate | {@link https://developers.google.com/ad-manager/api/reference/
|
|
48
|
-
* | status | {@link https://developers.google.com/ad-manager/api/reference/
|
|
43
|
+
* | id | {@link https://developers.google.com/ad-manager/api/reference/latest/AdjustmentService.ForecastAdjustment#id ForecastAdjustment.id} |
|
|
44
|
+
* | trafficForecastSegmentId | {@link https://developers.google.com/ad-manager/api/reference/latest/AdjustmentService.ForecastAdjustment#trafficForecastSegmentId ForecastAdjustment.trafficForecastSegmentId} |
|
|
45
|
+
* | name | {@link https://developers.google.com/ad-manager/api/reference/latest/AdjustmentService.ForecastAdjustment#name ForecastAdjustment.name} |
|
|
46
|
+
* | startDate | {@link https://developers.google.com/ad-manager/api/reference/latest/AdjustmentService.ForecastAdjustment#startDate ForecastAdjustment.startDate} |
|
|
47
|
+
* | endDate | {@link https://developers.google.com/ad-manager/api/reference/latest/AdjustmentService.ForecastAdjustment#endDate ForecastAdjustment.endDate} |
|
|
48
|
+
* | status | {@link https://developers.google.com/ad-manager/api/reference/latest/AdjustmentService.ForecastAdjustment#status ForecastAdjustment.status} |
|
|
49
49
|
*
|
|
50
50
|
* @param filterStatement a Publisher Query Language statement to filter a list of traffic forecast segments
|
|
51
51
|
* @returns a page of forecast adjustments that match the filter
|
|
52
52
|
*/
|
|
53
53
|
getForecastAdjustmentsByStatement(filterStatement: Statement): Promise<ForecastAdjustmentPage>;
|
|
54
54
|
/**
|
|
55
|
-
* Gets a {@link https://developers.google.com/ad-manager/api/reference/
|
|
56
|
-
* of {@link https://developers.google.com/ad-manager/api/reference/
|
|
57
|
-
* objects that satisfy the given {@link https://developers.google.com/ad-manager/api/reference/
|
|
55
|
+
* Gets a {@link https://developers.google.com/ad-manager/api/reference/latest/AdjustmentService.TrafficForecastSegmentPage TrafficForecastSegmentPage}
|
|
56
|
+
* of {@link https://developers.google.com/ad-manager/api/reference/latest/AdjustmentService.TrafficForecastSegment TrafficForecastSegment}
|
|
57
|
+
* objects that satisfy the given {@link https://developers.google.com/ad-manager/api/reference/latest/AdjustmentService.Statement#query Statement.query}.
|
|
58
58
|
*
|
|
59
59
|
* The following fields are supported for filtering:
|
|
60
60
|
*
|
|
61
61
|
* | PQL Property | PQL Property |
|
|
62
62
|
* | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
63
|
-
* | id | {@link https://developers.google.com/ad-manager/api/reference/
|
|
64
|
-
* | name | {@link https://developers.google.com/ad-manager/api/reference/
|
|
65
|
-
* | creationTime | {@link https://developers.google.com/ad-manager/api/reference/
|
|
63
|
+
* | id | {@link https://developers.google.com/ad-manager/api/reference/latest/AdjustmentService.TrafficForecastSegment#id TrafficForecastSegment.id} |
|
|
64
|
+
* | name | {@link https://developers.google.com/ad-manager/api/reference/latest/AdjustmentService.TrafficForecastSegment#name TrafficForecastSegment.name} |
|
|
65
|
+
* | creationTime | {@link https://developers.google.com/ad-manager/api/reference/latest/AdjustmentService.TrafficForecastSegment#creationTime TrafficForecastSegment.creationTime} |
|
|
66
66
|
*
|
|
67
67
|
* @param filterStatement a Publisher Query Language statement to filter a list of traffic forecast segments
|
|
68
68
|
* @returns a page of traffic forecast segments that match the filter
|
|
69
69
|
*/
|
|
70
70
|
getTrafficForecastSegmentsByStatement(filterStatement: Statement): Promise<TrafficForecastSegmentPage>;
|
|
71
71
|
/**
|
|
72
|
-
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/
|
|
73
|
-
* objects that match the given {@link https://developers.google.com/ad-manager/api/reference/
|
|
72
|
+
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/latest/AdjustmentService.ForecastAdjustment ForecastAdjustment}
|
|
73
|
+
* objects that match the given {@link https://developers.google.com/ad-manager/api/reference/latest/AdjustmentService.Statement#query Statement.query}.
|
|
74
74
|
*
|
|
75
75
|
* @param forecastAdjustmentAction the action to perform
|
|
76
76
|
* @param filterStatement a Publisher Query Language statement used to filter
|
|
@@ -80,14 +80,14 @@ export interface AdjustmentServiceOperations {
|
|
|
80
80
|
*/
|
|
81
81
|
performForecastAdjustmentAction(forecastAdjustmentAction: ForecastAdjustmentAction, filterStatement: Statement): Promise<UpdateResult>;
|
|
82
82
|
/**
|
|
83
|
-
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/
|
|
83
|
+
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/latest/AdjustmentService.ForecastAdjustment ForecastAdjustment} objects.
|
|
84
84
|
*
|
|
85
85
|
* @param forecastAdjustments the forecast adjustments to update
|
|
86
86
|
* @returns the updated forecast adjustments
|
|
87
87
|
*/
|
|
88
88
|
updateForecastAdjustments(forecastAdjustments: ForecastAdjustment[]): Promise<ForecastAdjustment[]>;
|
|
89
89
|
/**
|
|
90
|
-
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/
|
|
90
|
+
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/latest/AdjustmentService.TrafficForecastSegment TrafficForecastSegment} objects.
|
|
91
91
|
*
|
|
92
92
|
* @param trafficForecastSegments the traffic forecast segments to update
|
|
93
93
|
* @returns the updated traffic forecast segments
|
|
@@ -1,30 +1,30 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Action that can be performed on {@link https://developers.google.com/ad-manager/api/reference/
|
|
2
|
+
* Action that can be performed on {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.AudienceSegment AudienceSegment} objects.
|
|
3
3
|
*/
|
|
4
4
|
export declare abstract class AudienceSegmentAction {
|
|
5
5
|
}
|
|
6
6
|
/**
|
|
7
|
-
* Action that can be performed on {@link https://developers.google.com/ad-manager/api/reference/
|
|
7
|
+
* Action that can be performed on {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.FirstPartyAudienceSegment FirstPartyAudienceSegment} objects to activate them.
|
|
8
8
|
*/
|
|
9
9
|
export declare class ActivateAudienceSegments implements AudienceSegmentAction {
|
|
10
10
|
}
|
|
11
11
|
/**
|
|
12
|
-
* Action that can be performed on {@link https://developers.google.com/ad-manager/api/reference/
|
|
12
|
+
* Action that can be performed on {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.ThirdPartyAudienceSegment ThirdPartyAudienceSegment} objects to approve them.
|
|
13
13
|
*/
|
|
14
14
|
export declare class ApproveAudienceSegments implements AudienceSegmentAction {
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
|
-
* Action that can be performed on {@link https://developers.google.com/ad-manager/api/reference/
|
|
17
|
+
* Action that can be performed on {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.FirstPartyAudienceSegment FirstPartyAudienceSegment} objects to deactivate them.
|
|
18
18
|
*/
|
|
19
19
|
export declare class DeactivateAudienceSegments implements AudienceSegmentAction {
|
|
20
20
|
}
|
|
21
21
|
/**
|
|
22
|
-
* Action that can be performed on {@link https://developers.google.com/ad-manager/api/reference/
|
|
22
|
+
* Action that can be performed on {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.FirstPartyAudienceSegment FirstPartyAudienceSegment} objects to populate them based on last 30 days of traffic.
|
|
23
23
|
*/
|
|
24
24
|
export declare class PopulateAudienceSegments implements AudienceSegmentAction {
|
|
25
25
|
}
|
|
26
26
|
/**
|
|
27
|
-
* Action that can be performed on {@link https://developers.google.com/ad-manager/api/reference/
|
|
27
|
+
* Action that can be performed on {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.ThirdPartyAudienceSegment ThirdPartyAudienceSegment} objects to reject them.
|
|
28
28
|
*/
|
|
29
29
|
export declare class RejectAudienceSegments implements AudienceSegmentAction {
|
|
30
30
|
}
|
|
@@ -2,37 +2,37 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.RejectAudienceSegments = exports.PopulateAudienceSegments = exports.DeactivateAudienceSegments = exports.ApproveAudienceSegments = exports.ActivateAudienceSegments = exports.AudienceSegmentAction = void 0;
|
|
4
4
|
/**
|
|
5
|
-
* Action that can be performed on {@link https://developers.google.com/ad-manager/api/reference/
|
|
5
|
+
* Action that can be performed on {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.AudienceSegment AudienceSegment} objects.
|
|
6
6
|
*/
|
|
7
7
|
class AudienceSegmentAction {
|
|
8
8
|
}
|
|
9
9
|
exports.AudienceSegmentAction = AudienceSegmentAction;
|
|
10
10
|
/**
|
|
11
|
-
* Action that can be performed on {@link https://developers.google.com/ad-manager/api/reference/
|
|
11
|
+
* Action that can be performed on {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.FirstPartyAudienceSegment FirstPartyAudienceSegment} objects to activate them.
|
|
12
12
|
*/
|
|
13
13
|
class ActivateAudienceSegments {
|
|
14
14
|
}
|
|
15
15
|
exports.ActivateAudienceSegments = ActivateAudienceSegments;
|
|
16
16
|
/**
|
|
17
|
-
* Action that can be performed on {@link https://developers.google.com/ad-manager/api/reference/
|
|
17
|
+
* Action that can be performed on {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.ThirdPartyAudienceSegment ThirdPartyAudienceSegment} objects to approve them.
|
|
18
18
|
*/
|
|
19
19
|
class ApproveAudienceSegments {
|
|
20
20
|
}
|
|
21
21
|
exports.ApproveAudienceSegments = ApproveAudienceSegments;
|
|
22
22
|
/**
|
|
23
|
-
* Action that can be performed on {@link https://developers.google.com/ad-manager/api/reference/
|
|
23
|
+
* Action that can be performed on {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.FirstPartyAudienceSegment FirstPartyAudienceSegment} objects to deactivate them.
|
|
24
24
|
*/
|
|
25
25
|
class DeactivateAudienceSegments {
|
|
26
26
|
}
|
|
27
27
|
exports.DeactivateAudienceSegments = DeactivateAudienceSegments;
|
|
28
28
|
/**
|
|
29
|
-
* Action that can be performed on {@link https://developers.google.com/ad-manager/api/reference/
|
|
29
|
+
* Action that can be performed on {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.FirstPartyAudienceSegment FirstPartyAudienceSegment} objects to populate them based on last 30 days of traffic.
|
|
30
30
|
*/
|
|
31
31
|
class PopulateAudienceSegments {
|
|
32
32
|
}
|
|
33
33
|
exports.PopulateAudienceSegments = PopulateAudienceSegments;
|
|
34
34
|
/**
|
|
35
|
-
* Action that can be performed on {@link https://developers.google.com/ad-manager/api/reference/
|
|
35
|
+
* Action that can be performed on {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.ThirdPartyAudienceSegment ThirdPartyAudienceSegment} objects to reject them.
|
|
36
36
|
*/
|
|
37
37
|
class RejectAudienceSegments {
|
|
38
38
|
}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Specifies the statuses for {@link https://developers.google.com/ad-manager/api/reference/
|
|
2
|
+
* Specifies the statuses for {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.AudienceSegment AudienceSegment} objects.
|
|
3
3
|
*/
|
|
4
4
|
export declare enum AudienceSegmentStatus {
|
|
5
5
|
/**
|
|
@@ -12,7 +12,7 @@ export declare enum AudienceSegmentStatus {
|
|
|
12
12
|
INACTIVE = "INACTIVE"
|
|
13
13
|
}
|
|
14
14
|
/**
|
|
15
|
-
* Specifies types for {@link https://developers.google.com/ad-manager/api/reference/
|
|
15
|
+
* Specifies types for {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.AudienceSegment AudienceSegment} objects.
|
|
16
16
|
*/
|
|
17
17
|
export declare enum AudienceSegmentType {
|
|
18
18
|
/**
|
|
@@ -33,7 +33,7 @@ export declare enum AudienceSegmentType {
|
|
|
33
33
|
UNKNOWN = "UNKNOWN"
|
|
34
34
|
}
|
|
35
35
|
/**
|
|
36
|
-
* Approval status values for {@link https://developers.google.com/ad-manager/api/reference/
|
|
36
|
+
* Approval status values for {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.ThirdPartyAudienceSegment ThirdPartyAudienceSegment} objects.
|
|
37
37
|
*/
|
|
38
38
|
export declare enum AudienceSegmentApprovalStatus {
|
|
39
39
|
/**
|
|
@@ -54,7 +54,7 @@ export declare enum AudienceSegmentApprovalStatus {
|
|
|
54
54
|
UNKNOWN = "UNKNOWN"
|
|
55
55
|
}
|
|
56
56
|
/**
|
|
57
|
-
* Specifies the license type of a {@link https://developers.google.com/ad-manager/api/reference/
|
|
57
|
+
* Specifies the license type of a {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.ThirdPartyAudienceSegment ThirdPartyAudienceSegment}.
|
|
58
58
|
*/
|
|
59
59
|
export declare enum LicenseType {
|
|
60
60
|
/**
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.LicenseType = exports.AudienceSegmentApprovalStatus = exports.AudienceSegmentType = exports.AudienceSegmentStatus = void 0;
|
|
4
4
|
/**
|
|
5
|
-
* Specifies the statuses for {@link https://developers.google.com/ad-manager/api/reference/
|
|
5
|
+
* Specifies the statuses for {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.AudienceSegment AudienceSegment} objects.
|
|
6
6
|
*/
|
|
7
7
|
var AudienceSegmentStatus;
|
|
8
8
|
(function (AudienceSegmentStatus) {
|
|
@@ -16,7 +16,7 @@ var AudienceSegmentStatus;
|
|
|
16
16
|
AudienceSegmentStatus["INACTIVE"] = "INACTIVE";
|
|
17
17
|
})(AudienceSegmentStatus || (exports.AudienceSegmentStatus = AudienceSegmentStatus = {}));
|
|
18
18
|
/**
|
|
19
|
-
* Specifies types for {@link https://developers.google.com/ad-manager/api/reference/
|
|
19
|
+
* Specifies types for {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.AudienceSegment AudienceSegment} objects.
|
|
20
20
|
*/
|
|
21
21
|
var AudienceSegmentType;
|
|
22
22
|
(function (AudienceSegmentType) {
|
|
@@ -38,7 +38,7 @@ var AudienceSegmentType;
|
|
|
38
38
|
AudienceSegmentType["UNKNOWN"] = "UNKNOWN";
|
|
39
39
|
})(AudienceSegmentType || (exports.AudienceSegmentType = AudienceSegmentType = {}));
|
|
40
40
|
/**
|
|
41
|
-
* Approval status values for {@link https://developers.google.com/ad-manager/api/reference/
|
|
41
|
+
* Approval status values for {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.ThirdPartyAudienceSegment ThirdPartyAudienceSegment} objects.
|
|
42
42
|
*/
|
|
43
43
|
var AudienceSegmentApprovalStatus;
|
|
44
44
|
(function (AudienceSegmentApprovalStatus) {
|
|
@@ -60,7 +60,7 @@ var AudienceSegmentApprovalStatus;
|
|
|
60
60
|
AudienceSegmentApprovalStatus["UNKNOWN"] = "UNKNOWN";
|
|
61
61
|
})(AudienceSegmentApprovalStatus || (exports.AudienceSegmentApprovalStatus = AudienceSegmentApprovalStatus = {}));
|
|
62
62
|
/**
|
|
63
|
-
* Specifies the license type of a {@link https://developers.google.com/ad-manager/api/reference/
|
|
63
|
+
* Specifies the license type of a {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.ThirdPartyAudienceSegment ThirdPartyAudienceSegment}.
|
|
64
64
|
*/
|
|
65
65
|
var LicenseType;
|
|
66
66
|
(function (LicenseType) {
|
|
@@ -3,10 +3,10 @@ import type { Money } from "../../common/types";
|
|
|
3
3
|
import type { AudienceSegmentApprovalStatus, AudienceSegmentStatus, AudienceSegmentType, LicenseType } from "./audienceSegment.enum";
|
|
4
4
|
/**
|
|
5
5
|
* Data provider that owns this segment.
|
|
6
|
-
* For a {@link https://developers.google.com/ad-manager/api/reference/
|
|
7
|
-
* publisher network. For a {@link https://developers.google.com/ad-manager/api/reference/
|
|
8
|
-
* or a {@link https://developers.google.com/ad-manager/api/reference/
|
|
9
|
-
* it would be the entity that provides that {@link https://developers.google.com/ad-manager/api/reference/
|
|
6
|
+
* For a {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.FirstPartyAudienceSegment FirstPartyAudienceSegment}, it would be the
|
|
7
|
+
* publisher network. For a {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.SharedAudienceSegment SharedAudienceSegment}
|
|
8
|
+
* or a {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.ThirdPartyAudienceSegment ThirdPartyAudienceSegment},
|
|
9
|
+
* it would be the entity that provides that {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.AudienceSegment AudienceSegment}.
|
|
10
10
|
*/
|
|
11
11
|
type AudienceSegmentDataProvider = {
|
|
12
12
|
/**
|
|
@@ -15,7 +15,7 @@ type AudienceSegmentDataProvider = {
|
|
|
15
15
|
name: string;
|
|
16
16
|
};
|
|
17
17
|
/**
|
|
18
|
-
* An {@link https://developers.google.com/ad-manager/api/reference/
|
|
18
|
+
* An {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.AudienceSegment AudienceSegment} represents audience segment object.
|
|
19
19
|
*/
|
|
20
20
|
type AudienceSegment = {
|
|
21
21
|
/**
|
|
@@ -71,14 +71,14 @@ type AudienceSegment = {
|
|
|
71
71
|
type: AudienceSegmentType;
|
|
72
72
|
};
|
|
73
73
|
/**
|
|
74
|
-
* A {@link https://developers.google.com/ad-manager/api/reference/
|
|
75
|
-
* is an {@link https://developers.google.com/ad-manager/api/reference/
|
|
74
|
+
* A {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.SharedAudienceSegment SharedAudienceSegment}
|
|
75
|
+
* is an {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.AudienceSegment AudienceSegment}
|
|
76
76
|
* owned by another entity and shared with the publisher network.
|
|
77
77
|
*/
|
|
78
78
|
type SharedAudienceSegment = AudienceSegment & {};
|
|
79
79
|
/**
|
|
80
|
-
* A {@link https://developers.google.com/ad-manager/api/reference/
|
|
81
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
80
|
+
* A {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.ThirdPartyAudienceSegment ThirdPartyAudienceSegment} is an
|
|
81
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.AudienceSegment AudienceSegment}
|
|
82
82
|
* owned by a data provider and licensed to the Ad Manager publisher.
|
|
83
83
|
*/
|
|
84
84
|
type ThirdPartyAudienceSegment = AudienceSegment & {
|
|
@@ -106,8 +106,8 @@ type ThirdPartyAudienceSegment = AudienceSegment & {
|
|
|
106
106
|
endDateTime: DateTime;
|
|
107
107
|
};
|
|
108
108
|
/**
|
|
109
|
-
* A {@link https://developers.google.com/ad-manager/api/reference/
|
|
110
|
-
* is a {@link https://developers.google.com/ad-manager/api/reference/
|
|
109
|
+
* A {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.NonRuleBasedFirstPartyAudienceSegment NonRuleBasedFirstPartyAudienceSegment}
|
|
110
|
+
* is a {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.FirstPartyAudienceSegment FirstPartyAudienceSegment}
|
|
111
111
|
* owned by the publisher network. It doesn't contain a rule. Cookies are usually added to this segment via cookie upload.
|
|
112
112
|
*/
|
|
113
113
|
type NonRuleBasedFirstPartyAudienceSegment = AudienceSegment & {
|
|
@@ -118,8 +118,8 @@ type NonRuleBasedFirstPartyAudienceSegment = AudienceSegment & {
|
|
|
118
118
|
membershipExpirationDays: number;
|
|
119
119
|
};
|
|
120
120
|
/**
|
|
121
|
-
* A {@link https://developers.google.com/ad-manager/api/reference/
|
|
122
|
-
* is a {@link https://developers.google.com/ad-manager/api/reference/
|
|
121
|
+
* A {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.RuleBasedFirstPartyAudienceSegmentSummary RuleBasedFirstPartyAudienceSegmentSummary}
|
|
122
|
+
* is a {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.FirstPartyAudienceSegment FirstPartyAudienceSegment}
|
|
123
123
|
* owned by the publisher network.
|
|
124
124
|
*/
|
|
125
125
|
type RuleBasedFirstPartyAudienceSegmentSummary = AudienceSegment & {
|
|
@@ -143,7 +143,7 @@ type RuleBasedFirstPartyAudienceSegmentSummary = AudienceSegment & {
|
|
|
143
143
|
};
|
|
144
144
|
export type FirstPartyAudienceSegment = NonRuleBasedFirstPartyAudienceSegment | RuleBasedFirstPartyAudienceSegmentSummary;
|
|
145
145
|
/**
|
|
146
|
-
* Represents a page of {@link https://developers.google.com/ad-manager/api/reference/
|
|
146
|
+
* Represents a page of {@link https://developers.google.com/ad-manager/api/reference/latest/AudienceSegmentService.AudienceSegment AudienceSegment} objects.
|
|
147
147
|
*/
|
|
148
148
|
export type AudienceSegmentPage = PageResult<FirstPartyAudienceSegment | ThirdPartyAudienceSegment | SharedAudienceSegment>;
|
|
149
149
|
export {};
|