@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
|
@@ -2,53 +2,53 @@ import type { Statement, UpdateResult } from "../../../common/types";
|
|
|
2
2
|
import type { UserAction } from "./user.action";
|
|
3
3
|
import type { Role, User, UserPage } from "./user.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/UserService.User User} objects.
|
|
6
6
|
*
|
|
7
7
|
* A user is assigned one of several different roles.
|
|
8
|
-
* Each {@link https://developers.google.com/ad-manager/api/reference/
|
|
9
|
-
* Role types and their IDs can be retrieved by invoking {@link https://developers.google.com/ad-manager/api/reference/
|
|
8
|
+
* Each {@link https://developers.google.com/ad-manager/api/reference/latest/UserService.Role Role} type has a unique ID that is used to identify that role in an organization.
|
|
9
|
+
* Role types and their IDs can be retrieved by invoking {@link https://developers.google.com/ad-manager/api/reference/latest/UserService#getAllRoles getAllRoles}.
|
|
10
10
|
*/
|
|
11
11
|
export interface UserServiceOperations {
|
|
12
12
|
/**
|
|
13
|
-
* Creates new {@link https://developers.google.com/ad-manager/api/reference/
|
|
13
|
+
* Creates new {@link https://developers.google.com/ad-manager/api/reference/latest/UserService.User User} objects.
|
|
14
14
|
*
|
|
15
15
|
* @param users the users to create
|
|
16
16
|
* @returns the created users with their IDs filled in
|
|
17
17
|
*/
|
|
18
18
|
createUsers(users: Partial<User>[]): Promise<User[]>;
|
|
19
19
|
/**
|
|
20
|
-
* Returns the {@link https://developers.google.com/ad-manager/api/reference/
|
|
20
|
+
* Returns the {@link https://developers.google.com/ad-manager/api/reference/latest/UserService.Role Role} objects that are defined for the users of the network.
|
|
21
21
|
*
|
|
22
22
|
* @returns the roles defined for the user's network
|
|
23
23
|
*/
|
|
24
24
|
getAllRoles(): Promise<Role[]>;
|
|
25
25
|
/**
|
|
26
|
-
* Returns the current {@link https://developers.google.com/ad-manager/api/reference/
|
|
26
|
+
* Returns the current {@link https://developers.google.com/ad-manager/api/reference/latest/UserService.User User}.
|
|
27
27
|
*
|
|
28
28
|
* @returns the current user
|
|
29
29
|
*/
|
|
30
30
|
getCurrentUser(): Promise<User>;
|
|
31
31
|
/**
|
|
32
|
-
* Gets a {@link https://developers.google.com/ad-manager/api/reference/
|
|
33
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
32
|
+
* Gets a {@link https://developers.google.com/ad-manager/api/reference/latest/UserService.UserPage UserPage} of
|
|
33
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/UserService.User User}
|
|
34
34
|
* objects that satisfy the given Statement.query. The following fields are supported for filtering:
|
|
35
35
|
*
|
|
36
36
|
* | PQL Property | PQL Property |
|
|
37
37
|
* | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
38
|
-
* | email | {@link https://developers.google.com/ad-manager/api/reference/
|
|
39
|
-
* | id | {@link https://developers.google.com/ad-manager/api/reference/
|
|
40
|
-
* | name | {@link https://developers.google.com/ad-manager/api/reference/
|
|
41
|
-
* | roleId | {@link https://developers.google.com/ad-manager/api/reference/
|
|
42
|
-
* | rolename | {@link https://developers.google.com/ad-manager/api/reference/
|
|
43
|
-
* | status | **ACTIVE** if {@link https://developers.google.com/ad-manager/api/reference/
|
|
38
|
+
* | email | {@link https://developers.google.com/ad-manager/api/reference/latest/UserService.User#email User.email} |
|
|
39
|
+
* | id | {@link https://developers.google.com/ad-manager/api/reference/latest/UserService.User#id User.id} |
|
|
40
|
+
* | name | {@link https://developers.google.com/ad-manager/api/reference/latest/UserService.User#name User.name} |
|
|
41
|
+
* | roleId | {@link https://developers.google.com/ad-manager/api/reference/latest/UserService.User#roleId User.roleId} |
|
|
42
|
+
* | rolename | {@link https://developers.google.com/ad-manager/api/reference/latest/UserService.User#rolename User.rolename} |
|
|
43
|
+
* | status | **ACTIVE** if {@link https://developers.google.com/ad-manager/api/reference/latest/UserService.User#isActive User.isActive} is true; **INACTIVE** otherwise |
|
|
44
44
|
*
|
|
45
45
|
* @param filterStatement a Publisher Query Language statement used to filter a set of users
|
|
46
46
|
* @returns the users that match the given filter
|
|
47
47
|
*/
|
|
48
48
|
getUsersByStatement(filterStatement: Statement): Promise<UserPage>;
|
|
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/UserService.User User}
|
|
51
|
+
* objects that match the given {@link https://developers.google.com/ad-manager/api/reference/latest/UserService.Statement#query Statement.query}.
|
|
52
52
|
*
|
|
53
53
|
* @param userAction the action to perform
|
|
54
54
|
* @param filterStatement a Publisher Query Language statement used to filter a set of users
|
|
@@ -56,7 +56,7 @@ export interface UserServiceOperations {
|
|
|
56
56
|
*/
|
|
57
57
|
performUserAction(userAction: UserAction, filterStatement: Statement): Promise<UpdateResult>;
|
|
58
58
|
/**
|
|
59
|
-
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/
|
|
59
|
+
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/latest/UserService.User User} objects.
|
|
60
60
|
* @param users the users to update
|
|
61
61
|
* @returns the updated users
|
|
62
62
|
*/
|
|
@@ -1,10 +1,10 @@
|
|
|
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/UserTeamAssociationService.UserTeamAssociation UserTeamAssociation} objects.
|
|
3
3
|
*/
|
|
4
4
|
export declare abstract class UserTeamAssociationAction {
|
|
5
5
|
}
|
|
6
6
|
/**
|
|
7
|
-
* Action to delete the association between a {@link https://developers.google.com/ad-manager/api/reference/
|
|
7
|
+
* Action to delete the association between a {@link https://developers.google.com/ad-manager/api/reference/latest/UserService.User User} and a {@link https://developers.google.com/ad-manager/api/reference/latest/TeamService.Team Team}.
|
|
8
8
|
*/
|
|
9
9
|
export declare class DeleteUserTeamAssociations implements UserTeamAssociationAction {
|
|
10
10
|
}
|
|
@@ -2,13 +2,13 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.DeleteUserTeamAssociations = exports.UserTeamAssociationAction = 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/UserTeamAssociationService.UserTeamAssociation UserTeamAssociation} objects.
|
|
6
6
|
*/
|
|
7
7
|
class UserTeamAssociationAction {
|
|
8
8
|
}
|
|
9
9
|
exports.UserTeamAssociationAction = UserTeamAssociationAction;
|
|
10
10
|
/**
|
|
11
|
-
* Action to delete the association between a {@link https://developers.google.com/ad-manager/api/reference/
|
|
11
|
+
* Action to delete the association between a {@link https://developers.google.com/ad-manager/api/reference/latest/UserService.User User} and a {@link https://developers.google.com/ad-manager/api/reference/latest/TeamService.Team Team}.
|
|
12
12
|
*/
|
|
13
13
|
class DeleteUserTeamAssociations {
|
|
14
14
|
}
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import type { PageResult } from "../../../common/types";
|
|
2
2
|
import type { TeamAccessType } from "../team/team.enum";
|
|
3
3
|
/**
|
|
4
|
-
* UserRecordTeamAssociation represents the association between a {@link https://developers.google.com/ad-manager/api/reference/
|
|
5
|
-
* and a {@link https://developers.google.com/ad-manager/api/reference/
|
|
4
|
+
* UserRecordTeamAssociation represents the association between a {@link https://developers.google.com/ad-manager/api/reference/latest/UserService.UserRecord UserRecord}
|
|
5
|
+
* and a {@link https://developers.google.com/ad-manager/api/reference/latest/TeamService.Team Team}.
|
|
6
6
|
*/
|
|
7
7
|
export type UserRecordTeamAssociation = {
|
|
8
8
|
/**
|
|
@@ -19,8 +19,8 @@ export type UserRecordTeamAssociation = {
|
|
|
19
19
|
defaultTeamAccessType: TeamAccessType;
|
|
20
20
|
};
|
|
21
21
|
/**
|
|
22
|
-
* UserTeamAssociation associates a {@link https://developers.google.com/ad-manager/api/reference/
|
|
23
|
-
* with a {@link https://developers.google.com/ad-manager/api/reference/
|
|
22
|
+
* UserTeamAssociation associates a {@link https://developers.google.com/ad-manager/api/reference/latest/UserService.User User}
|
|
23
|
+
* with a {@link https://developers.google.com/ad-manager/api/reference/latest/TeamService.Team Team} to provide the user access to the entities that belong to the team.
|
|
24
24
|
*/
|
|
25
25
|
export type UserTeamAssociation = UserRecordTeamAssociation & {
|
|
26
26
|
/**
|
|
@@ -29,7 +29,7 @@ export type UserTeamAssociation = UserRecordTeamAssociation & {
|
|
|
29
29
|
userId: number;
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/
|
|
32
|
+
* Captures a page of {@link https://developers.google.com/ad-manager/api/reference/latest/UserTeamAssociationService.UserTeamAssociation UserTeamAssociation} objects.
|
|
33
33
|
*/
|
|
34
34
|
export type UserTeamAssociationPage = PageResult<UserTeamAssociation>;
|
|
35
35
|
//# sourceMappingURL=userTeamAssociation.type.d.ts.map
|
|
@@ -3,37 +3,37 @@ import type { UserTeamAssociationAction } from "./userTeamAssociation.action";
|
|
|
3
3
|
import type { UserTeamAssociation, UserTeamAssociationPage } from "./userTeamAssociation.type";
|
|
4
4
|
/**
|
|
5
5
|
* Provides methods for creating, updating,
|
|
6
|
-
* and retrieving {@link https://developers.google.com/ad-manager/api/reference/
|
|
6
|
+
* and retrieving {@link https://developers.google.com/ad-manager/api/reference/latest/UserTeamAssociationService.UserTeamAssociation UserTeamAssociation} objects.
|
|
7
7
|
*
|
|
8
8
|
* UserTeamAssociation objects are used to add users to teams in order to define access to entities such as companies,
|
|
9
9
|
* inventory and orders and to override the team's access type to orders for a user.
|
|
10
10
|
*/
|
|
11
11
|
export interface UserTeamAssociationServiceOperations {
|
|
12
12
|
/**
|
|
13
|
-
* Creates new {@link https://developers.google.com/ad-manager/api/reference/
|
|
13
|
+
* Creates new {@link https://developers.google.com/ad-manager/api/reference/latest/UserTeamAssociationService.UserTeamAssociation UserTeamAssociation} objects.
|
|
14
14
|
*
|
|
15
15
|
* @param userTeamAssociations the user team associations to create
|
|
16
16
|
* @returns the created user team associations with their IDs filled in
|
|
17
17
|
*/
|
|
18
18
|
createUserTeamAssociations(userTeamAssociations: Partial<UserTeamAssociation>[]): Promise<UserTeamAssociation[]>;
|
|
19
19
|
/**
|
|
20
|
-
* Gets a {@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 a {@link https://developers.google.com/ad-manager/api/reference/latest/UserTeamAssociationService.UserTeamAssociationPage UserTeamAssociationPage}
|
|
21
|
+
* of {@link https://developers.google.com/ad-manager/api/reference/latest/UserTeamAssociationService.UserTeamAssociation UserTeamAssociation} objects that satisfy the given
|
|
22
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/TeamService.Statement#query Statement.query}.
|
|
23
23
|
* The following fields are supported for filtering:
|
|
24
24
|
*
|
|
25
25
|
* | PQL Property | PQL Property |
|
|
26
26
|
* | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
|
27
|
-
* | userId | {@link https://developers.google.com/ad-manager/api/reference/
|
|
28
|
-
* | teamId | {@link https://developers.google.com/ad-manager/api/reference/
|
|
27
|
+
* | userId | {@link https://developers.google.com/ad-manager/api/reference/latest/UserTeamAssociationService.UserTeamAssociation#userId Team.userId} |
|
|
28
|
+
* | teamId | {@link https://developers.google.com/ad-manager/api/reference/latest/UserTeamAssociationService.UserTeamAssociation#teamId Team.teamId} |
|
|
29
29
|
*
|
|
30
30
|
* @param filterStatement a Publisher Query Language statement used to filter a set of user team associations
|
|
31
31
|
* @returns the user team associations that match the given filter
|
|
32
32
|
*/
|
|
33
33
|
getUserTeamAssociationsByStatement(filterStatement: Statement): Promise<UserTeamAssociationPage>;
|
|
34
34
|
/**
|
|
35
|
-
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/
|
|
36
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
35
|
+
* Performs actions on {@link https://developers.google.com/ad-manager/api/reference/latest/UserTeamAssociationService.UserTeamAssociation UserTeamAssociation} objects that match the given
|
|
36
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/TeamService.Statement#query Statement.query}.
|
|
37
37
|
*
|
|
38
38
|
* @param teamAction the action to perform
|
|
39
39
|
* @param statement
|
|
@@ -41,7 +41,7 @@ export interface UserTeamAssociationServiceOperations {
|
|
|
41
41
|
*/
|
|
42
42
|
performUserTeamAssociationAction(userTeamAssociationAction: UserTeamAssociationAction, statement: Statement): Promise<UpdateResult>;
|
|
43
43
|
/**
|
|
44
|
-
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/
|
|
44
|
+
* Updates the specified {@link https://developers.google.com/ad-manager/api/reference/latest/UserTeamAssociationService.UserTeamAssociation UserTeamAssociation} objects.
|
|
45
45
|
*
|
|
46
46
|
* @param userTeamAssociations the user team associations to update
|
|
47
47
|
* @returns the updated user team associations
|
|
@@ -16,10 +16,10 @@ import { type Date, type DateTime } from "./date.type";
|
|
|
16
16
|
* An example of such a query might be **`"WHERE name LIKE '%searchString%'"`**.
|
|
17
17
|
*
|
|
18
18
|
* The value for the variable idValue must then be set with an object of type
|
|
19
|
-
* {@link https://developers.google.com/ad-manager/api/reference/
|
|
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/
|
|
19
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/UserService.Value Value}, e.g.,
|
|
20
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/UserService.NumberValue NumberValue},
|
|
21
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/UserService.TextValue TextValue} or
|
|
22
|
+
* {@link https://developers.google.com/ad-manager/api/reference/latest/UserService.BooleanValue BooleanValue}.
|
|
23
23
|
*/
|
|
24
24
|
export type Statement = {
|
|
25
25
|
/**
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@guardian/google-admanager-api",
|
|
3
|
-
"version": "6.
|
|
3
|
+
"version": "6.1.1",
|
|
4
4
|
"description": "Google Ad Manager API Client Library for NodeJs",
|
|
5
5
|
"main": "dist/index",
|
|
6
6
|
"types": "dist/index",
|
|
@@ -27,22 +27,22 @@
|
|
|
27
27
|
"dependencies": {
|
|
28
28
|
"axios": "1.13.5",
|
|
29
29
|
"google-auth-library": "10.5.0",
|
|
30
|
-
"soap": "1.6.
|
|
30
|
+
"soap": "1.6.4",
|
|
31
31
|
"superstruct": "2.0.2"
|
|
32
32
|
},
|
|
33
33
|
"devDependencies": {
|
|
34
|
-
"@changesets/cli": "^2.
|
|
35
|
-
"@guardian/eslint-config": "^
|
|
36
|
-
"@guardian/prettier": "^
|
|
34
|
+
"@changesets/cli": "^2.30.0",
|
|
35
|
+
"@guardian/eslint-config": "^14.0.0",
|
|
36
|
+
"@guardian/prettier": "^10.0.0",
|
|
37
37
|
"@types/jest": "^30.0.0",
|
|
38
|
-
"@types/node": "^25.
|
|
39
|
-
"eslint": "^9.
|
|
40
|
-
"jest": "^30.0
|
|
38
|
+
"@types/node": "^25.3.3",
|
|
39
|
+
"eslint": "^9.39.3",
|
|
40
|
+
"jest": "^30.2.0",
|
|
41
41
|
"open": "^11.0.0",
|
|
42
|
-
"prettier": "^3.
|
|
42
|
+
"prettier": "^3.8.1",
|
|
43
43
|
"server-destroy": "^1.0.1",
|
|
44
|
-
"ts-jest": "^29.
|
|
45
|
-
"ts-node": "^10.
|
|
44
|
+
"ts-jest": "^29.4.6",
|
|
45
|
+
"ts-node": "^10.9.2",
|
|
46
46
|
"tsconfig-paths": "^4.2.0",
|
|
47
47
|
"typescript": "5.9.3"
|
|
48
48
|
},
|